diff options
Diffstat (limited to 'fontconfig/doc')
26 files changed, 218 insertions, 162 deletions
diff --git a/fontconfig/doc/Makefile.am b/fontconfig/doc/Makefile.am index 49e00e155..8d7d5c8ba 100644 --- a/fontconfig/doc/Makefile.am +++ b/fontconfig/doc/Makefile.am @@ -7,9 +7,9 @@ # documentation for any purpose is hereby granted without fee, provided that # the above copyright notice appear in all copies and that both that # copyright notice and this permission notice appear in supporting -# documentation, and that the name of Keith Packard not be used in +# documentation, and that the name of the author(s) not be used in # advertising or publicity pertaining to distribution of the software without -# specific, written prior permission. Keith Packard makes no +# specific, written prior permission. The authors make no # representations about the suitability of this software for any purpose. It # is provided "as is" without express or implied warranty. # @@ -21,10 +21,6 @@ # TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR # PERFORMANCE OF THIS SOFTWARE. -CC = @CC_FOR_BUILD@ -EXEEXT = @EXEEXT_FOR_BUILD@ -LINK = $(CCLD) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) -o $@ - DOC_SRC = $(srcdir) DOC_MODULE = fontconfig DOC2HTML = docbook2html @@ -83,7 +79,7 @@ DOC_FUNCS_SGML=\ fcstrset.sgml \ fcvalue.sgml -man5_MANS=fonts-conf.5 +man5_MANS=fonts-conf.5 man3_MANS=$(DOCMAN3) noinst_PROGRAMS=edit-sgml @@ -96,15 +92,20 @@ check_SCRIPTS=check-missing-doc TESTS_ENVIRONMENT=top_srcdir=${top_srcdir} sh TESTS=check-missing-doc -EXTRA_DIST=$(LOCAL_DOCS) $(SGML) $(DOC_FUNCS_FNCS) $(check_SCRIPTS) func.sgml confdir.sgml.in +EXTRA_DIST=$(LOCAL_DOCS) $(SGML) $(DOC_FUNCS_FNCS) $(DOC_FUNCS_SGML) $(check_SCRIPTS) func.sgml confdir.sgml.in SUFFIXES=.fncs .sgml .txt .html if USEDOCBOOK +if CROSS_COMPILING +.fncs.sgml: + @echo Warning: cannot rebuild $@ when cross-compiling +else .fncs.sgml: $(RM) $@ ./edit-sgml$(EXEEXT) $(FNCS_TMPL) < '$<' > $*.sgml +endif .sgml.txt: $(RM) $@ @@ -127,7 +128,7 @@ func.refs: local-fontconfig-devel.sgml $(DOC_FUNCS_SGML) version.sgml confdir.sg local-fontconfig-devel.sgml: fontconfig-devel.sgml $(LN_S) $< $@ -$(DOC_FUNCS_SGML): edit-sgml$(EXEEXT) $(FNCS_TMPL) +$(DOC_FUNCS_SGML): edit-sgml.c $(FNCS_TMPL) fonts-conf.5: local-fontconfig-user.sgml version.sgml confdir.sgml $(RM) $@ @@ -140,9 +141,11 @@ local-fontconfig-user.sgml: fontconfig-user.sgml all-local: $(LOCAL_DOCS) clean-local: - $(RM) $(man3_MANS) $(man5_MANS) $(DOC_FILES) $(DOC_FUNCS_SGML) func.refs + $(RM) $(man3_MANS) $(man5_MANS) $(DOC_FILES) func.refs $(RM) -r $(HTML_DIR) +MAINTAINERCLEANFILES = $(DOC_FUNCS_SGML) + $(HTML_DIR): local-fontconfig-devel.sgml $(DOC_FUNCS_SGML) version.sgml confdir.sgml $(RM) -r $(HTML_DIR) $(DOC2HTML) -V '%use-id-as-filename%' -o $(HTML_DIR) local-fontconfig-devel.sgml diff --git a/fontconfig/doc/confdir.sgml.in b/fontconfig/doc/confdir.sgml.in index 291b26bb3..cfcaa9f6e 100644 --- a/fontconfig/doc/confdir.sgml.in +++ b/fontconfig/doc/confdir.sgml.in @@ -7,9 +7,9 @@ documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting - documentation, and that the name of Keith Packard not be used in + documentation, and that the name of the author(s) not be used in advertising or publicity pertaining to distribution of the software without - specific, written prior permission. Keith Packard makes no + specific, written prior permission. The authors make no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. diff --git a/fontconfig/doc/edit-sgml.c b/fontconfig/doc/edit-sgml.c index b69c93ed7..cc2ee7633 100644 --- a/fontconfig/doc/edit-sgml.c +++ b/fontconfig/doc/edit-sgml.c @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * diff --git a/fontconfig/doc/fcatomic.fncs b/fontconfig/doc/fcatomic.fncs index c6b924d84..017756af1 100644 --- a/fontconfig/doc/fcatomic.fncs +++ b/fontconfig/doc/fcatomic.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * @@ -57,7 +57,7 @@ by <parameter>atomic</parameter>. @TYPE1@ FcAtomic * @ARG1@ atomic @PURPOSE@ return original file name @DESC@ -Returns the file refernced by <parameter>atomic</parameter>. +Returns the file referenced by <parameter>atomic</parameter>. @@ @RET@ FcBool diff --git a/fontconfig/doc/fcblanks.fncs b/fontconfig/doc/fcblanks.fncs index b8ce47d24..b0996d644 100644 --- a/fontconfig/doc/fcblanks.fncs +++ b/fontconfig/doc/fcblanks.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * diff --git a/fontconfig/doc/fccache.fncs b/fontconfig/doc/fccache.fncs index f0c984d79..f35c5d7cb 100644 --- a/fontconfig/doc/fccache.fncs +++ b/fontconfig/doc/fccache.fncs @@ -5,9 +5,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * diff --git a/fontconfig/doc/fccharset.fncs b/fontconfig/doc/fccharset.fncs index b12064a55..036870d3b 100644 --- a/fontconfig/doc/fccharset.fncs +++ b/fontconfig/doc/fccharset.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * @@ -46,11 +46,22 @@ memory referenced is freed. @TYPE2@ FcChar32% @ARG2@ ucs4 @PURPOSE@ Add a character to a charset @DESC@ -<function>FcCharSetAddChar</function> adds a single unicode char to the set, +<function>FcCharSetAddChar</function> adds a single Unicode char to the set, returning FcFalse on failure, either as a result of a constant set or from running out of memory. @@ +@RET@ FcBool +@FUNC@ FcCharSetDelChar +@TYPE1@ FcCharSet * @ARG1@ fcs +@TYPE2@ FcChar32% @ARG2@ ucs4 +@PURPOSE@ Add a character to a charset +@DESC@ +<function>FcCharSetDelChar</function> deletes a single Unicode char from the set, +returning FcFalse on failure, either as a result of a constant set or from +running out of memory. +@@ + @RET@ FcCharSet * @FUNC@ FcCharSetCopy @TYPE1@ FcCharSet * @ARG1@ src @@ -67,7 +78,7 @@ than increment the reference count on <parameter>src</parameter>. @PURPOSE@ Compare two charsets @DESC@ Returns whether <parameter>a</parameter> and <parameter>b</parameter> -contain the same set of unicode chars. +contain the same set of Unicode chars. @@ @RET@ FcCharSet * @@ -127,7 +138,7 @@ Returns whether <parameter>fcs</parameter> contains the char <parameter>ucs4</pa @TYPE1@ const FcCharSet * @ARG1@ a @PURPOSE@ Count entries in a charset @DESC@ -Returns the total number of unicode chars in <parameter>a</parameter>. +Returns the total number of Unicode chars in <parameter>a</parameter>. @@ @RET@ FcChar32 diff --git a/fontconfig/doc/fcconfig.fncs b/fontconfig/doc/fcconfig.fncs index 8bb953b34..fb55adece 100644 --- a/fontconfig/doc/fcconfig.fncs +++ b/fontconfig/doc/fcconfig.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * @@ -90,7 +90,7 @@ is enabled, and NULL otherwise. See also <function>FcConfigEnableHome</function>). @@ -@RET@ FcBol +@RET@ FcBool @FUNC@ FcConfigEnableHome @TYPE1@ FcBool% @ARG1@ enable @PURPOSE@ controls use of the home directory. @@ -309,7 +309,7 @@ by the return value from multiple FcFontSort calls, applications must not modify these patterns. Instead, they should be passed, along with <parameter>p</parameter> to <function>FcFontRenderPrepare</function> which combines them into a complete pattern. </para><para> -The FcFontSet returned by FcFontSort is destroyed by caling FcFontSetDestroy. +The FcFontSet returned by FcFontSort is destroyed by calling FcFontSetDestroy. If <parameter>config</parameter> is NULL, the current configuration is used. @@ diff --git a/fontconfig/doc/fcconstant.fncs b/fontconfig/doc/fcconstant.fncs index 86150f203..2ead0a6f0 100644 --- a/fontconfig/doc/fcconstant.fncs +++ b/fontconfig/doc/fcconstant.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * diff --git a/fontconfig/doc/fcfile.fncs b/fontconfig/doc/fcfile.fncs index d15ab27a3..5f5f32a8a 100644 --- a/fontconfig/doc/fcfile.fncs +++ b/fontconfig/doc/fcfile.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * diff --git a/fontconfig/doc/fcfontset.fncs b/fontconfig/doc/fcfontset.fncs index 57005fdd0..e076d8b92 100644 --- a/fontconfig/doc/fcfontset.fncs +++ b/fontconfig/doc/fcfontset.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * @@ -125,7 +125,7 @@ modify these patterns. Instead, they should be passed, along with <parameter>pattern</parameter> to <function>FcFontRenderPrepare</function> which combines them into a complete pattern. </para><para> -The FcFontSet returned by FcFontSetSort is destroyed by caling FcFontSetDestroy. +The FcFontSet returned by FcFontSetSort is destroyed by calling FcFontSetDestroy. @@ @RET@ diff --git a/fontconfig/doc/fcformat.fncs b/fontconfig/doc/fcformat.fncs index b092449cf..125e6b437 100644 --- a/fontconfig/doc/fcformat.fncs +++ b/fontconfig/doc/fcformat.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * @@ -36,7 +36,7 @@ caller using free(), or NULL if <parameter>format</parameter> is invalid. </para><para> -The format is loosely modelled after printf-style format string. +The format is loosely modeled after printf-style format string. The format string is composed of zero or more directives: ordinary characters (not "%"), which are copied unchanged to the output stream; and tags which are interpreted to construct text from the pattern in a @@ -50,7 +50,7 @@ are meant to be copied to the output as ordinary characters. </para><para> -Each tags is introduced by the character "%", +Each tag is introduced by the character "%", followed by an optional minimum field width, followed by tag contents in curly braces ({}). If the minimum field width value is provided the tag @@ -66,7 +66,7 @@ A <firstterm>simple</firstterm> tag is one where the content is an identifier. When simple tags are expanded, the named identifier will be looked up in <parameter>pattern</parameter> and the resulting list of values returned, -joined together using comma. For example, to print the family name and style the +joined together using comma. For example, to print the family name and style of the pattern, use the format "%{family} %{style}\n". To extend the family column to forty characters use "%-40{family}%{style}\n". @@ -112,7 +112,7 @@ A <firstterm>sub-expression</firstterm> tag is one that expands a sub-expression. The tag contents are the sub-expression to expand placed inside another set of curly braces. Sub-expression tags are useful for aligning an entire sub-expression, or to -apply converters (explained later) on an entire sub-expression. +apply converters (explained later) to the entire sub-expression output. For example, the format "%40{{%{family} %{style}}}" expands the sub-expression to construct the family name followed by the style, then takes the entire string and pads it on the left to be at least forty characters. @@ -164,7 +164,7 @@ a single value for those elements, starting from the first value and continuing as long as any of those elements has a value. For example, the format "%{[]family,familylang{%{family} (%{familylang})\n}}" will expand the pattern "%{family} (%{familylang})\n" with a pattern -having only the first value of the family and familylang elemtns, then expands +having only the first value of the family and familylang elements, then expands it with the second values, then the third, etc. </para><para> diff --git a/fontconfig/doc/fcfreetype.fncs b/fontconfig/doc/fcfreetype.fncs index 366cfaef8..e4cca46a3 100644 --- a/fontconfig/doc/fcfreetype.fncs +++ b/fontconfig/doc/fcfreetype.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * @@ -45,7 +45,7 @@ higher level functions. @FUNC@ FcFreeTypeCharSet @TYPE1@ FT_Face% @ARG1@ face @TYPE2@ FcBlanks * @ARG2@ blanks -@PURPOSE@ compute unicode coverage +@PURPOSE@ compute Unicode coverage @DESC@ Scans a FreeType face and returns the set of encoded Unicode chars. This scans several encoding tables to build as complete a list as possible. @@ -61,7 +61,7 @@ not in 'blanks' are not placed in the returned FcCharSet. @TYPE1@ FT_Face% @ARG1@ face @TYPE2@ FcBlanks * @ARG2@ blanks @TYPE3@ int * @ARG3@ spacing -@PURPOSE@ compute unicode coverage and spacing type +@PURPOSE@ compute Unicode coverage and spacing type @DESC@ Scans a FreeType face and returns the set of encoded Unicode chars. This scans diff --git a/fontconfig/doc/fcinit.fncs b/fontconfig/doc/fcinit.fncs index e9b7947b8..014af0dea 100644 --- a/fontconfig/doc/fcinit.fncs +++ b/fontconfig/doc/fcinit.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * @@ -53,7 +53,7 @@ been loaded, this routine does nothing and returns FcTrue. @RET@ void @FUNC@ FcFini @TYPE1@ void -@PURPOSE@ finalize fonconfig library +@PURPOSE@ finalize fontconfig library @DESC@ Frees all data structures allocated by previous calls to fontconfig functions. Fontconfig returns to an uninitialized state, requiring a @@ -76,7 +76,7 @@ Returns the version number of the library. @DESC@ Forces the default configuration file to be reloaded and resets the default configuration. Returns FcFalse if the configuration cannot be reloaded (due -to config file errors, allocation failures or other issues) and leaves the +to configuration file errors, allocation failures or other issues) and leaves the existing configuration unchanged. Otherwise returns FcTrue. @@ diff --git a/fontconfig/doc/fclangset.fncs b/fontconfig/doc/fclangset.fncs index f9d578e65..0a44b38c2 100644 --- a/fontconfig/doc/fclangset.fncs +++ b/fontconfig/doc/fclangset.fncs @@ -58,6 +58,36 @@ two or three letter language from ISO 639 and Tt is a territory from ISO 3166. @@ +@RET@ FcBool +@FUNC@ FcLangSetDel +@TYPE1@ FcLangSet * @ARG1@ ls +@TYPE2@ const FcChar8 * @ARG2@ lang +@PURPOSE@ delete a language from a langset +@DESC@ +<parameter>lang</parameter> is removed from <parameter>ls</parameter>. +<parameter>lang</parameter> should be of the form Ll-Tt where Ll is a +two or three letter language from ISO 639 and Tt is a territory from ISO +3166. +@@ + +@RET@ FcLangSet * +@FUNC@ FcLangSetUnion +@TYPE1@ const FcLangSet * @ARG1@ ls_a +@TYPE2@ const FcLangSet * @ARG2@ ls_b +@PURPOSE@ Add langsets +@DESC@ +Returns a set including only those languages found in either <parameter>ls_a</parameter> or <parameter>ls_b</parameter>. +@@ + +@RET@ FcLangSet * +@FUNC@ FcLangSetSubtract +@TYPE1@ const FcLangSet * @ARG1@ ls_a +@TYPE2@ const FcLangSet * @ARG2@ ls_b +@PURPOSE@ Subtract langsets +@DESC@ +Returns a set including only those languages found in <parameter>ls_a</parameter> but not in <parameter>ls_b</parameter>. +@@ + @RET@ FcLangResult @FUNC@ FcLangSetCompare @TYPE1@ const FcLangSet * @ARG1@ ls_a @@ -68,7 +98,7 @@ two or three letter language from ISO 639 and Tt is a territory from ISO <parameter>ls_a</parameter> and <parameter>ls_b</parameter>. If they share any language and territory pair, this function returns FcLangEqual. If they share a language but differ in which territory that language is for, this -function returns FcLangDiffentTerritory. If they share no languages in +function returns FcLangDifferentTerritory. If they share no languages in common, this function returns FcLangDifferentLang. @@ @@ -119,7 +149,7 @@ value may not be equal. <parameter>ls</parameter> has a matching language and territory pair, this function returns FcLangEqual. If <parameter>ls</parameter> has a matching language but differs in which territory that language is for, this -function returns FcLangDiffentTerritory. If <parameter>ls</parameter> +function returns FcLangDifferentTerritory. If <parameter>ls</parameter> has no matching language, this function returns FcLangDifferentLang. @@ diff --git a/fontconfig/doc/fcmatrix.fncs b/fontconfig/doc/fcmatrix.fncs index fd680e458..a53ade946 100644 --- a/fontconfig/doc/fcmatrix.fncs +++ b/fontconfig/doc/fcmatrix.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * @@ -97,11 +97,11 @@ matrix: @DESC@ <function>FcMatrixScale</function> multiplies <parameter>matrix</parameter> x values by <parameter>sx</parameter> and y values by -<parameter>sy</parameter>. This is done by multiplying by +<parameter>dy</parameter>. This is done by multiplying by the matrix: <programlisting> sx 0 - 0 sy + 0 dy </programlisting> @@ diff --git a/fontconfig/doc/fcobjectset.fncs b/fontconfig/doc/fcobjectset.fncs index 468a7bfc1..57e1750d1 100644 --- a/fontconfig/doc/fcobjectset.fncs +++ b/fontconfig/doc/fcobjectset.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * @@ -35,7 +35,7 @@ Creates an empty set. @TYPE2@ const char * @ARG2@ object @PURPOSE@ Add to an object set @DESC@ -Adds a proprety name to the set. Returns FcFalse if the property name cannot be +Adds a property name to the set. Returns FcFalse if the property name cannot be inserted into the set (due to allocation failure). Otherwise returns FcTrue. @@ diff --git a/fontconfig/doc/fcobjecttype.fncs b/fontconfig/doc/fcobjecttype.fncs index bc254f3b9..45f3a31a0 100644 --- a/fontconfig/doc/fcobjecttype.fncs +++ b/fontconfig/doc/fcobjecttype.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * diff --git a/fontconfig/doc/fcpattern.fncs b/fontconfig/doc/fcpattern.fncs index e2c2953df..1df1c4f61 100644 --- a/fontconfig/doc/fcpattern.fncs +++ b/fontconfig/doc/fcpattern.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * @@ -108,7 +108,7 @@ equal. @DESC@ Adds a single value to the list of values associated with the property named `object<parameter>. If `append</parameter> is FcTrue, the value is added at the end of any -existing list, otherwise it is inserted at the begining. `value' is saved +existing list, otherwise it is inserted at the beginning. `value' is saved (with FcValueSave) when inserted into the pattern so that the library retains no reference to any application-supplied data structure. @@ diff --git a/fontconfig/doc/fcstring.fncs b/fontconfig/doc/fcstring.fncs index 5f1f93ac1..0412bbd1a 100644 --- a/fontconfig/doc/fcstring.fncs +++ b/fontconfig/doc/fcstring.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * @@ -58,7 +58,7 @@ the char. Counts the number of Unicode chars in <parameter>len</parameter> bytes of <parameter>src</parameter>. Places that count in <parameter>nchar</parameter>. <parameter>wchar</parameter> contains 1, 2 or -4 depending on the number of bytes needed to hold the largest unicode char +4 depending on the number of bytes needed to hold the largest Unicode char counted. The return value indicates whether <parameter>src</parameter> is a well-formed UTF8 string. @@ @@ -92,7 +92,7 @@ Counts the number of Unicode chars in <parameter>len</parameter> bytes of combined into 16-bit units according to <parameter>endian</parameter>. Places that count in <parameter>nchar</parameter>. <parameter>wchar</parameter> contains 1, 2 or 4 depending on the number of -bytes needed to hold the largest unicode char counted. The return value +bytes needed to hold the largest Unicode char counted. The return value indicates whether <parameter>string</parameter> is a well-formed UTF16 string. @@ diff --git a/fontconfig/doc/fcstrset.fncs b/fontconfig/doc/fcstrset.fncs index 61af37b63..737347b00 100644 --- a/fontconfig/doc/fcstrset.fncs +++ b/fontconfig/doc/fcstrset.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * diff --git a/fontconfig/doc/fcvalue.fncs b/fontconfig/doc/fcvalue.fncs index d0c669b1f..83a5b3aa9 100644 --- a/fontconfig/doc/fcvalue.fncs +++ b/fontconfig/doc/fcvalue.fncs @@ -7,9 +7,9 @@ * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * diff --git a/fontconfig/doc/fontconfig-devel.sgml b/fontconfig/doc/fontconfig-devel.sgml index 891251f30..87339511c 100644 --- a/fontconfig/doc/fontconfig-devel.sgml +++ b/fontconfig/doc/fontconfig-devel.sgml @@ -30,9 +30,9 @@ documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting - documentation, and that the name of Keith Packard not be used in + documentation, and that the name of the author(s) not be used in advertising or publicity pertaining to distribution of the software without - specific, written prior permission. Keith Packard makes no + specific, written prior permission. The authors make no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. @@ -65,9 +65,9 @@ Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting -documentation, and that the name of Keith Packard not be used in +documentation, and that the name of the author(s) not be used in advertising or publicity pertaining to distribution of the software without -specific, written prior permission. Keith Packard makes no +specific, written prior permission. The authors make no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. </simpara><simpara> @@ -96,7 +96,7 @@ which accepts font patterns and returns the nearest matching font. <sect2><title>FONT CONFIGURATION</title> <para> The configuration module consists of the FcConfig datatype, libexpat and -FcConfigParse which walks over an XML tree and ammends a configuration with +FcConfigParse which walks over an XML tree and amends a configuration with data found within. From an external perspective, configuration of the library consists of generating a valid XML tree and feeding that to FcConfigParse. The only other mechanism provided to applications for @@ -126,83 +126,83 @@ simplify and regularize font installation and customization. While font patterns may contain essentially any properties, there are some well known properties with associated types. Fontconfig uses some of these properties for font matching and font completion. Others are provided as a -convenience for the applications rendering mechanism. +convenience for the application's rendering mechanism. </para> <programlisting> Property Definitions - Property CPP Symbol Type Description + Property C Preprocessor Symbol Type Description ---------------------------------------------------- - family FC_FAMILY String Font family names - familylang FC_FAMILYLANG String Language cooresponding to - each family name - style FC_STYLE String Font style. Overrides weight - and slant - stylelang FC_STYLELANG String Language cooresponding to - each style name - fullname FC_FULLNAME String Font face full name where - different from family and - family + style - fullnamelang FC_FULLNAMELANG String Language cooresponding to - each fullname - slant FC_SLANT Int Italic, oblique or roman - weight FC_WEIGHT Int Light, medium, demibold, - bold or black - size FC_SIZE Double Point size - width FC_WIDTH Int Condensed, normal or expanded - aspect FC_ASPECT Double Stretches glyphs horizontally - before hinting - pixelsize FC_PIXEL_SIZE Double Pixel size - spacing FC_SPACING Int Proportional, dual-width, - monospace or charcell - foundry FC_FOUNDRY String Font foundry name - antialias FC_ANTIALIAS Bool Whether glyphs can be - antialiased - hinting FC_HINTING Bool Whether the rasterizer should - use hinting - hintstyle FC_HINT_STYLE Int Automatic hinting style - verticallayout FC_VERTICAL_LAYOUT Bool Use vertical layout - autohint FC_AUTOHINT Bool Use autohinter instead of - normal hinter - globaladvance FC_GLOBAL_ADVANCE Bool Use font global advance data - file FC_FILE String The filename holding the font - index FC_INDEX Int The index of the font within - the file - ftface FC_FT_FACE FT_Face Use the specified FreeType - face object - rasterizer FC_RASTERIZER String Which rasterizer is in use - outline FC_OUTLINE Bool Whether the glyphs are outlines - scalable FC_SCALABLE Bool Whether glyphs can be scaled - scale FC_SCALE Double Scale factor for point->pixel - conversions - dpi FC_DPI Double Target dots per inch - rgba FC_RGBA Int unknown, rgb, bgr, vrgb, - vbgr, none - subpixel geometry - lcdfilter FC_LCD_FILTER Int Type of LCD filter - minspace FC_MINSPACE Bool Eliminate leading from line - spacing - charset FC_CHARSET CharSet Unicode chars encoded by - the font - lang FC_LANG LangSet Set of RFC-3066-style - languages this font supports - fontversion FC_FONTVERSION Int Version number of the font - capability FC_CAPABILITY String List of layout capabilities in - the font - embolden FC_EMBOLDEN Bool Rasterizer should - synthetically embolden the font + family FC_FAMILY String Font family names + familylang FC_FAMILYLANG String Language corresponding to + each family name + style FC_STYLE String Font style. Overrides weight + and slant + stylelang FC_STYLELANG String Language corresponding to + each style name + fullname FC_FULLNAME String Font face full name where + different from family and + family + style + fullnamelang FC_FULLNAMELANG String Language corresponding to + each fullname + slant FC_SLANT Int Italic, oblique or roman + weight FC_WEIGHT Int Light, medium, demibold, + bold or black + size FC_SIZE Double Point size + width FC_WIDTH Int Condensed, normal or expanded + aspect FC_ASPECT Double Stretches glyphs horizontally + before hinting + pixelsize FC_PIXEL_SIZE Double Pixel size + spacing FC_SPACING Int Proportional, dual-width, + monospace or charcell + foundry FC_FOUNDRY String Font foundry name + antialias FC_ANTIALIAS Bool Whether glyphs can be + antialiased + hinting FC_HINTING Bool Whether the rasterizer should + use hinting + hintstyle FC_HINT_STYLE Int Automatic hinting style + verticallayout FC_VERTICAL_LAYOUT Bool Use vertical layout + autohint FC_AUTOHINT Bool Use autohinter instead of + normal hinter + globaladvance FC_GLOBAL_ADVANCE Bool Use font global advance data + file FC_FILE String The filename holding the font + index FC_INDEX Int The index of the font within + the file + ftface FC_FT_FACE FT_Face Use the specified FreeType + face object + rasterizer FC_RASTERIZER String Which rasterizer is in use + outline FC_OUTLINE Bool Whether the glyphs are outlines + scalable FC_SCALABLE Bool Whether glyphs can be scaled + scale FC_SCALE Double Scale factor for point->pixel + conversions + dpi FC_DPI Double Target dots per inch + rgba FC_RGBA Int unknown, rgb, bgr, vrgb, + vbgr, none - subpixel geometry + lcdfilter FC_LCD_FILTER Int Type of LCD filter + minspace FC_MINSPACE Bool Eliminate leading from line + spacing + charset FC_CHARSET CharSet Unicode chars encoded by + the font + lang FC_LANG LangSet Set of RFC-3066-style + languages this font supports + fontversion FC_FONTVERSION Int Version number of the font + capability FC_CAPABILITY String List of layout capabilities in + the font + embolden FC_EMBOLDEN Bool Rasterizer should + synthetically embolden the font </programlisting> </sect2> </sect1> <sect1><title>Datatypes</title> <para> -Fontconfig uses abstract datatypes to hide internal implementation details +Fontconfig uses abstract data types to hide internal implementation details for most data structures. A few structures are exposed where appropriate. </para> <sect2><title>FcChar8, FcChar16, FcChar32, FcBool</title> <para> -These are primitive datatypes; the FcChar* types hold precisely the number +These are primitive data types; the FcChar* types hold precisely the number of bits stated (if supported by the C implementation). FcBool holds -one of two CPP symbols: FcFalse or FcTrue. +one of two C preprocessor symbols: FcFalse or FcTrue. </para> </sect2> <sect2><title>FcMatrix</title> @@ -218,7 +218,7 @@ A small set of matrix operations are provided to manipulate these. </sect2> <sect2><title>FcCharSet</title> <para> -An FcCharSet is an abstract type that holds the set of encoded unicode chars +An FcCharSet is an abstract type that holds the set of encoded Unicode chars in a font. Operations to build and compare these sets are provided. </para> </sect2> @@ -378,7 +378,7 @@ public entry points that need global data can take an optional FcConfig* argument; passing 0 uses the default configuration. FcConfig objects hold two sets of fonts, the first contains those specified by the configuration, the second set holds those added by the application at run-time. Interfaces -that need to reference a particulat set use one of the FcSetName enumerated +that need to reference a particular set use one of the FcSetName enumerated values. </para> </sect2> @@ -401,13 +401,13 @@ Used as a return type for functions manipulating FcPattern objects. FcResultTypeMismatch Object exists, but the type doesn't match FcResultNoId Object exists, but has fewer values than specified - FcResultOutOfMemory Malloc failed + FcResultOutOfMemory malloc failed </programlisting> </para> </sect2> <sect2><title>FcAtomic</title> <para> -Used for locking access to config files. Provides a safe way to update +Used for locking access to configuration files. Provides a safe way to update configuration files. </para> </sect2> @@ -423,7 +423,7 @@ included 'fc-cache' program generally suffices for all of that. </sect1> <sect1><title>FUNCTIONS</title> <para> -These are grouped by functionality, often using the main datatype being +These are grouped by functionality, often using the main data type being manipulated. </para> <sect2><title>Initialization</title> @@ -450,7 +450,7 @@ results of listing available fonts. <sect2><title>FcObjectSet</title> <para> An FcObjectSet holds a list of pattern property names; it is used to -indiciate which properties are to be returned in the patterns from +indicate which properties are to be returned in the patterns from FcFontList. </para> &fcobjectset; @@ -475,7 +475,7 @@ typechecking, although that depends on careful programming. </sect2> <sect2><title>FcCharSet</title> <para> -An FcCharSet is a boolean array indicating a set of unicode chars. Those +An FcCharSet is a boolean array indicating a set of Unicode chars. Those associated with a font are marked constant and cannot be edited. FcCharSets may be reference counted internally to reduce memory consumption; this may be visible to applications as the result of FcCharSetCopy may @@ -509,7 +509,7 @@ any function using the data within an FcConfig. </sect2> <sect2><title>FcObjectType</title> <para> -Provides for applcation-specified font name object types so that new +Provides for application-specified font name object types so that new pattern elements can be generated from font names. </para> &fcobjecttype; @@ -532,9 +532,9 @@ accurate CharSet for applications. </sect2> <sect2><title>FcAtomic</title> <para> -These functions provide a safe way to update config files, allowing ongoing -reading of the old config file while locked for writing and ensuring that a -consistent and complete version of the config file is always available. +These functions provide a safe way to update configuration files, allowing ongoing +reading of the old configuration file while locked for writing and ensuring that a +consistent and complete version of the configuration file is always available. </para> &fcatomic; </sect2> diff --git a/fontconfig/doc/fontconfig-user.sgml b/fontconfig/doc/fontconfig-user.sgml index 298f8d5f5..217feb97a 100644 --- a/fontconfig/doc/fontconfig-user.sgml +++ b/fontconfig/doc/fontconfig-user.sgml @@ -9,9 +9,9 @@ documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting - documentation, and that the name of Keith Packard not be used in + documentation, and that the name of the author(s) not be used in advertising or publicity pertaining to distribution of the software without - specific, written prior permission. Keith Packard makes no + specific, written prior permission. The authors make no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. @@ -216,9 +216,9 @@ Here are some examples: with artificial obliquing </programlisting> <para> -The '\', '-', ':' and ',' characters in family names must be preceeded by a +The '\', '-', ':' and ',' characters in family names must be preceded by a '\' character to avoid having them misinterpreted. Similarly, values -containing '\', '=', '_', ':' and ',' must also have them preceeded by a +containing '\', '=', '_', ':' and ',' must also have them preceded by a '\' character. The '\' characters are stripped out of the family name and values as the font name is read. </para> @@ -432,6 +432,18 @@ instead of -.5). This element holds the four <literal><double></literal> elements of an affine transformation. </para></refsect2> + <refsect2><title><literal><range></literal></title><para> +This element holds the two <literal><int></literal> elements of a range +representation. + </para></refsect2> + <refsect2><title><literal><charset></literal></title><para> +This element holds at least one <literal><int></literal> element of +an Unicode code point or more. + </para></refsect2> + <refsect2><title><literal><langset></literal></title><para> +This element holds at least one <literal><string></literal> element of +a RFC-3066-style languages or more. + </para></refsect2> <refsect2><title><literal><name></literal></title><para> Holds a property name. Evaluates to the first value from the property of the font, not the pattern. @@ -647,14 +659,14 @@ This is an example of a per-user configuration file that lives in contains configuration information for the fontconfig library consisting of directories to look at for font information as well as instructions on editing program specified font patterns before attempting to -match the available fonts. It is in xml format. +match the available fonts. It is in XML format. </para> <para> <emphasis>conf.d</emphasis> is the conventional name for a directory of additional configuration files managed by external applications or the local administrator. The filenames starting with decimal digits are sorted in lexicographic order -and used as additional configuration files. All of these files are in xml +and used as additional configuration files. All of these files are in XML format. The master fonts.conf file references this directory in an <include> directive. </para> diff --git a/fontconfig/doc/func.sgml b/fontconfig/doc/func.sgml index 0da5ae4a6..88be32047 100644 --- a/fontconfig/doc/func.sgml +++ b/fontconfig/doc/func.sgml @@ -7,9 +7,9 @@ documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting - documentation, and that the name of Keith Packard not be used in + documentation, and that the name of the author(s) not be used in advertising or publicity pertaining to distribution of the software without - specific, written prior permission. Keith Packard makes no + specific, written prior permission. The authors make no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. diff --git a/fontconfig/doc/version.sgml.in b/fontconfig/doc/version.sgml.in index 9981b1c74..13315ba6d 100644 --- a/fontconfig/doc/version.sgml.in +++ b/fontconfig/doc/version.sgml.in @@ -7,9 +7,9 @@ documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting - documentation, and that the name of Keith Packard not be used in + documentation, and that the name of the author(s) not be used in advertising or publicity pertaining to distribution of the software without - specific, written prior permission. Keith Packard makes no + specific, written prior permission. The authors make no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. |