diff options
| author | Keith Packard <keithp@keithp.com> | 2003-03-07 07:12:51 +0000 |
|---|---|---|
| committer | Keith Packard <keithp@keithp.com> | 2003-03-07 07:12:51 +0000 |
| commit | 22671e25510e77af1a8f2b569314ba2de1c93353 (patch) | |
| tree | 6cbfa163c4d49662f390ed4cd60d803e629bfade /doc/fontconfig-user.sgml | |
| parent | 5e1f56b567c0226da9ab650ee4809e16be2ae8eb (diff) | |
Rework documentation to build man pages for each function
Diffstat (limited to 'doc/fontconfig-user.sgml')
| -rw-r--r-- | doc/fontconfig-user.sgml | 396 |
1 files changed, 178 insertions, 218 deletions
diff --git a/doc/fontconfig-user.sgml b/doc/fontconfig-user.sgml index 49c6065..9122e10 100644 --- a/doc/fontconfig-user.sgml +++ b/doc/fontconfig-user.sgml @@ -1,4 +1,4 @@ -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <!-- $Id$ @@ -22,31 +22,35 @@ TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. --> -<article> -<artheader> - <title>Fontconfig Users Guide</title> - <titleabbrev>Fontconfig</titleabbrev> - <author><firstname>Keith</><surname>Packard</></author> - <authorinitials>krp</authorinitials> -</artheader> -<sect1><title>NAME</title> - <para> - fontconfig - Font configuration and customization library - </para> -</sect1> -<sect1><title>DESCRIPTION</title> +<refentry> +<refmeta> + <refentrytitle>fonts.conf</refentrytitle> + <manvolnum>5</manvolnum> +</refmeta> +<refnamediv> + <refname>fonts.conf</refname> + <refpurpose>Font configuration files</refpurpose> +</refnamediv> +<refsynopsisdiv> +<synopsis> + /etc/fonts/fonts.conf + /etc/fonts/fonts.dtd + ~/.fonts.conf +</synopsis> +</refsynopsisdiv> +<refsect1><title>DESCRIPTION</title> <para> Fontconfig is a library designed to provide system-wide font configuration, customization and application access. </para> -</sect1> -<sect1><title>FUNCTIONAL OVERVIEW</title> +</refsect1> +<refsect1><title>FUNCTIONAL OVERVIEW</title> <para> Fontconfig contains two essential modules, the configuration module which builds an internal configuration from XML files and the matching module which accepts font patterns and returns the nearest matching font. </para> - <sect2><title>FONT CONFIGURATION</title> + <refsect2><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 @@ -72,8 +76,8 @@ is that this will ensure that configuration of fonts for all applications can be centralized in one place. Centralizing font configuration will simplify and regularize font installation and customization. </para> - </sect2> - <sect2> + </refsect2> + <refsect2> <title>FONT PROPERTIES</title> <para> While font patterns may contain essentially any properties, there are some @@ -81,51 +85,40 @@ 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. </para> - <table> - <title>Property Definitions</title> - <tgroup cols=3 align=left colsep=1 rowsep=1> - <colspec colname=Property> - <colspec colname=Type> - <colspec colname=Description> - <thead> - <row> - <entry>Property</entry> - <entry>Type</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> -<row><entry>family</entry><entry>String</entry><entry>Font family name</entry></row> -<row><entry>style</entry><entry>String</entry><entry>Font style. Overrides weight and slant</entry></row> -<row><entry>slant</entry><entry>Int</entry><entry>Italic, oblique or roman</entry></row> -<row><entry>weight</entry><entry>Int</entry><entry>Light, medium, demibold, bold or black</entry></row> -<row><entry>size</entry><entry>Double</entry><entry>Point size</entry></row> -<row><entry>aspect</entry><entry>Double</entry><entry>Stretches glyphs horizontally before hinting</entry></row> -<row><entry>pixelsize</entry><entry>Double</entry><entry>Pixel size</entry></row> -<row><entry>spacing</entry><entry>Int</entry><entry>Proportional, monospace or charcell</entry></row> -<row><entry>foundry</entry><entry>String</entry><entry>Font foundry name</entry></row> -<row><entry>antialias</entry><entry>Bool</entry><entry>Whether glyphs can be antialiased</entry></row> -<row><entry>hinting</entry><entry>Bool</entry><entry>Whether the rasterizer should use hinting</entry></row> -<row><entry>verticallayout</entry><entry>Bool</entry><entry>Use vertical layout</entry></row> -<row><entry>autohint</entry><entry>Bool</entry><entry>Use autohinter instead of normal hinter</entry></row> -<row><entry>globaladvance</entry><entry>Bool</entry><entry>Use font global advance data</entry></row> -<row><entry>file</entry><entry>String</entry><entry>The filename holding the font</entry></row> -<row><entry>index</entry><entry>Int</entry><entry>The index of the font within the file</entry></row> -<row><entry>ftface</entry><entry>FT_Face</entry><entry>Use the specified FreeType face object</entry></row> -<row><entry>rasterizer</entry><entry>String</entry><entry>Which rasterizer is in use</entry></row> -<row><entry>outline</entry><entry>Bool</entry><entry>Whether the glyphs are outlines</entry></row> -<row><entry>scalable</entry><entry>Bool</entry><entry>Whether glyphs can be scaled</entry></row> -<row><entry>scale</entry><entry>Double</entry><entry>Scale factor for point->pixel conversions</entry></row> -<row><entry>dpi</entry><entry>Double</entry><entry>Target dots per inch</entry></row> -<row><entry>rgba</entry><entry>Int</entry><entry>unknown, rgb, bgr, vrgb, vbgr, none - subpixel geometry</entry></row> -<row><entry>minspace</entry><entry>Bool</entry><entry>Eliminate leading from line spacing</entry></row> -<row><entry>charset</entry><entry>CharSet</entry><entry>Unicode chars encoded by the font</entry></row> -<row><entry>lang</entry><entry>String</entry><entry>List of RFC-3066-style languages this font supports</entry></row> - </tbody> - </tgroup> - </table> - </sect2> - <sect2> + <programlisting> + Property Type Description + -------------------------------------------------------------- + family String Font family name + style String Font style. Overrides weight and slant + slant Int Italic, oblique or roman + weight Int Light, medium, demibold, bold or black + size Double Point size + aspect Double Stretches glyphs horizontally before hinting + pixelsize Double Pixel size + spacing Int Proportional, monospace or charcell + foundry String Font foundry name + antialias Bool Whether glyphs can be antialiased + hinting Bool Whether the rasterizer should use hinting + verticallayout Bool Use vertical layout + autohint Bool Use autohinter instead of normal hinter + globaladvance Bool Use font global advance data + file String The filename holding the font + index Int The index of the font within the file + ftface FT_Face Use the specified FreeType face object + rasterizer String Which rasterizer is in use + outline Bool Whether the glyphs are outlines + scalable Bool Whether glyphs can be scaled + scale Double Scale factor for point->pixel conversions + dpi Double Target dots per inch + rgba Int unknown, rgb, bgr, vrgb, vbgr, + none - subpixel geometry + minspace Bool Eliminate leading from line spacing + charset CharSet Unicode chars encoded by the font + lang String List of RFC-3066-style languages this + font supports + </programlisting> + </refsect2> + <refsect2> <title>FONT MATCHING</title> <para> Fontconfig performs matching by measuring the distance from a provided @@ -183,8 +176,8 @@ suitable defaults. The second is to modify how the selected fonts are rasterized. Those must apply to the selected font, not the original pattern as false matches will often occur. </para> - </sect2> - <sect2><title>FONT NAMES</title> + </refsect2> + <refsect2><title>FONT NAMES</title> <para> Fontconfig provides a textual representation for patterns that the library can both accept and generate. The representation is in three parts, first a @@ -200,25 +193,18 @@ families or point sizes; they can be elided. In addition, there are symbolic constants that simultaneously indicate both a name and a value. Here are some examples: </para> - <table colsep=0 rowsep=0> - <title>Sample Font Names</title> - <tgroup cols=2 align=left colsep=0 rowsep=0> - <thead><row> - <entry>Name</entry> - <entry>Meaning</entry> - </row></thead> - <tbody> -<row><entry>Times-12</entry><entry>12 point Times Roman</entry></row> -<row><entry>Times-12:bold</entry><entry>12 point Times Bold</entry></row> -<row><entry>Courier:italic</entry><entry>Courier Italic in the default size</entry></row> -<row><entry>Monospace:matrix=1 .1 0 1</entry><entry>The users preferred monospace font -with artificial obliquing</entry></row> - </tbody> - </tgroup> - </table> - </sect2> -</sect1> -<sect1><title>LANG TAGS</title> + <programlisting> + Name Meaning + ---------------------------------------------------------- + Times-12 12 point Times Roman + Times-12:bold 12 point Times Bold + Courier:italic Courier Italic in the default size + Monospace:matrix=1 .1 0 1 The users preferred monospace font + with artificial obliquing + </programlisting> + </refsect2> +</refsect1> +<refsect1><title>LANG TAGS</title> <para> Each font in the database contains a list of languages it supports. This is computed by comparing the Unicode coverage of the font with the orthography @@ -232,8 +218,8 @@ library. It currently supports 122 of the 139 languages named in ISO 639-1, 141 of the languages with two-letter codes from ISO 639-2 and another 30 languages with only three-letter codes. </para> -</sect1> -<sect1><title>CONFIGURATION FILE FORMAT</title> +</refsect1> +<refsect1><title>CONFIGURATION FILE FORMAT</title> <para> Configuration files for fontconfig are stored in XML format; this format makes external configuration tools easier to write and ensures that @@ -253,56 +239,56 @@ following structure: </fontconfig> </programlisting> </para> - <sect2><title><fontconfig></title><para> +<refsect2><title><literal><fontconfig></literal></title><para> This is the top level element for a font configuration and can contain -<dir>, <cache>, <include>, <match> and <alias> elements in any order. - </para></sect2> - <sect2><title><dir></title><para> +<sgmltag>dir</>, <sgmltag>cache</>, <sgmltag>include</>, <sgmltag>match</> and <sgmltag>alias</> elements in any order. + </para></refsect2> + <refsect2><title><sgmltag>dir</></title><para> This element contains a directory name which will be scanned for font files to include in the set of available fonts. - </para></sect2> - <sect2><title><cache></title><para> + </para></refsect2> + <refsect2><title><sgmltag>cache</></title><para> This element contains a file name for the per-user cache of font information. If it starts with '~', it refers to a file in the users home directory. This file is used to hold information about fonts that isn't present in the per-directory cache files. It is automatically maintained by the fontconfig library. The default for this file -is ``~/.fonts.cache-<version>'', where <version> is the font configuration +is ``~/.fonts.cache-<sgmltag>version</>'', where <sgmltag>version</> is the font configuration file version number (currently 1). - </para></sect2> - <sect2><title><include ignore_missing="no"></title><para> + </para></refsect2> + <refsect2><title><sgmltag>include ignore_missing="no"</></title><para> This element contains the name of an additional configuration file. When the XML datatype is traversed by FcConfigParse, the contents of the file will also be incorporated into the configuration by passing the filename to FcConfigLoadAndParse. If 'ignore_missing' is set to "yes" instead of the default "no", a missing file will elicit no warning message from the library. - </para></sect2> - <sect2><title><config></title><para> + </para></refsect2> + <refsect2><title><sgmltag>config</></title><para> This element provides a place to consolodate additional configuration -information. <config> can contain <blank> and <rescan> elements in any +information. <sgmltag>config</> can contain <sgmltag>blank</> and <sgmltag>rescan</> elements in any order. - </para></sect2> - <sect2><title><blank></title><para> + </para></refsect2> + <refsect2><title><sgmltag>blank</></title><para> Fonts often include "broken" glyphs which appear in the encoding but are -drawn as blanks on the screen. Within the <blank> element, place each -Unicode characters which is supposed to be blank in an <int> element. +drawn as blanks on the screen. Within the <sgmltag>blank</> element, place each +Unicode characters which is supposed to be blank in an <sgmltag>int</> element. Characters outside of this set which are drawn as blank will be elided from the set of characters supported by the font. - </para></sect2> - <sect2><title><rescan></title><para> -The <rescan> element holds an <int> element which indicates the default + </para></refsect2> + <refsect2><title><sgmltag>rescan</></title><para> +The <sgmltag>rescan</> element holds an <sgmltag>int</> element which indicates the default interval between automatic checks for font configuration changes. Fontconfig will validate all of the configuration files and directories and automatically rebuild the internal datastructures when this interval passes. - </para></sect2> - <sect2><title><match target="pattern"></title><para> -This element holds first a (possibly empty) list of <test> elements and then -a (possibly empty) list of <edit> elements. Patterns which match all of the + </para></refsect2> + <refsect2><title><sgmltag>match target="pattern"</></title><para> +This element holds first a (possibly empty) list of <sgmltag>test</> elements and then +a (possibly empty) list of <sgmltag>edit</> elements. Patterns which match all of the tests are subjected to all the edits. If 'target' is set to "font" instead of the default "pattern", then this element applies to the font name resulting from a match rather than a font pattern to be matched. - </para></sect2> - <sect2><title><test qual="any" name="property" compare="eq"></title><para> + </para></refsect2> + <refsect2><title><sgmltag>test qual="any" name="property" compare="eq"</></title><para> This element contains a single value which is compared with the pattern property "property" (substitute any of the property names seen above). 'compare' can be one of "eq", "not_eq", "less", "less_eq", "more", or @@ -310,128 +296,102 @@ above). 'compare' can be one of "eq", "not_eq", "less", "less_eq", "more", or succeeds if any value associated with the property matches the test value, or "all", in which case all of the values associated with the property must match the test value. - </para></sect2> - <sect2><title><edit name="property" mode="assign" binding="weak"></title><para> + </para></refsect2> + <refsect2><title><sgmltag>edit name="property" mode="assign" binding="weak"</></title><para> This element contains a list of expression elements (any of the value or operator elements). The expression elements are evaluated at run-time and modify the property "property". The modification depends on whether -"property" was matched by one of the associated <test> elements, if so, the +"property" was matched by one of the associated <sgmltag>test</> elements, if so, the modification may affect the first matched value. Any values inserted into the property are given the indicated binding. 'mode' is one of: - <table> - <title>Edit Element Modes</title> - <tgroup cols=3 align=left colsep=0 rowsep=0> - <thead> - <row> - <entry>Mode</entry> - <entry>Operation With Match</entry> - <entry>Operation Without Match</entry> - </row> - </thead> - <tbody> -<row><entry>"assign"</entry><entry>Replace matching value</entry><entry>Replace all values</entry></row> -<row><entry>"assign_replace"</entry><entry>Replace all values</entry><entry>Replace all values</entry></row> -<row><entry>"prepend"</entry><entry>Insert before matching value</entry><entry>Insert at head of list</entry></row> -<row><entry>"prepend_first"</entry><entry>Insert at head of list</entry><entry>Insert at head of list</entry></row> -<row><entry>"append"</entry><entry>Append after matching value</entry><entry>Append at end of list</entry></row> -<row><entry>"append_last"</entry><entry>Append at end of list</entry><entry>Append at end of list</entry></row> - </tbody> - </tgroup> - </table> - </para></sect2> - <sect2><title><int>, <double>, <string>, <bool></title><para> -These elements hold a single value of the indicated type. <bool> elements + <programlisting> + Mode With Match Without Match + --------------------------------------------------------------------- + "assign" Replace matching value Replace all values + "assign_replace" Replace all values Replace all values + "prepend" Insert before matching Insert at head of list + "prepend_first" Insert at head of list Insert at head of list + "append" Append after matching Append at end of list + "append_last" Append at end of list Append at end of list + </programlisting> + </para></refsect2> + <refsect2><title><sgmltag>int</>, <sgmltag>double</>, <sgmltag>string</>, <sgmltag>bool</></title><para> +These elements hold a single value of the indicated type. <sgmltag>bool</> elements hold either true or false. - </para></sect2> - <sect2><title><matrix></title><para> -This element holds the four <double> elements of an affine + </para></refsect2> + <refsect2><title><sgmltag>matrix</></title><para> +This element holds the four <sgmltag>double</> elements of an affine transformation. - </para></sect2> - <sect2><title><name></title><para> + </para></refsect2> + <refsect2><title><sgmltag>name</></title><para> Holds a property name. Evaluates to the first value from the property of the font, not the pattern. - </para></sect2> - <sect2><title><const></title><para> + </para></refsect2> + <refsect2><title><sgmltag>const</></title><para> Holds the name of a constant; these are always integers and serve as symbolic names for common font values: - <table> - <title>Symbolic Constants</title> - <tgroup cols=3 align=left colsep=0 rowsep=0> - <thead> - <row> - <entry>Constant</entry> - <entry>Property</entry> - <entry>CPP Symbol</entry> - </row> - </thead> - <tbody> -<row><entry>light</entry><entry>weight</entry></row> -<row><entry>medium</entry><entry>weight</entry></row> -<row><entry>demibold</entry><entry>weight</entry></row> -<row><entry>bold</entry><entry>weight</entry></row> -<row><entry>black</entry><entry>weight</entry></row> -<row><entry>roman</entry><entry>slant</entry></row> -<row><entry>italic</entry><entry>slant</entry></row> -<row><entry>oblique</entry><entry>slant</entry></row> -<row><entry>proportional</entry><entry>spacing</entry></row> -<row><entry>mono</entry><entry>spacing</entry></row> -<row><entry>charcell</entry><entry>spacing</entry></row> -<row><entry>unknown</entry><entry>rgba</entry></row> -<row><entry>rgb</entry><entry>rgba</entry></row> -<row><entry>bgr</entry><entry>rgba</entry></row> -<row><entry>vrgb</entry><entry>rgba</entry></row> -<row><entry>vbgr</entry><entry>rgba</entry></row> -<row><entry>none</entry><entry>rgba</entry></row> - </tbody> - </tgroup> - </table> + <programlisting> + Constant Property Value + ------------------------------------- + light weight 0 + medium weight 100 + demibold weight 180 + bold weight 200 + black weight 210 + roman slant 0 + italic slant 100 + oblique slant 110 + proportional spacing 0 + mono spacing 100 + charcell spacing 110 + unknown rgba 0 + rgb rgba 1 + bgr rgba 2 + vrgb rgba 3 + vbgr rgba 4 + none rgba 5 + </programlisting> </para> - </sect2> - <sect2><title><or>, - <and>, - <plus>, - <minus>, - <times>, - <divide></title><para> + </refsect2> + <refsect2> + <title><sgmltag>or</>, <sgmltag>and</>, <sgmltag>plus</>, <sgmltag>minus</>, <sgmltag>times</>, <sgmltag>divide</></title> + <para> These elements perform the specified operation on a list of expression -elements. <or> and <and> are boolean, not bitwise. +elements. <sgmltag>or</> and <sgmltag>and</> are boolean, not bitwise. </para> - </sect2> - <sect2><title><eq>, - <not_eq>, - <less>, - <less_eq>, - <more>, - <more_eq></title><para> + </refsect2> + <refsect2> + <title><sgmltag>eq</>, <sgmltag>not_eq</>, <sgmltag>less</>, <sgmltag>less_eq</>, <sgmltag>more</>, <sgmltag>more_eq</></title> + <para> These elements compare two values, producing a boolean result. - </para></sect2> - <sect2><title><not></title><para> + </para></refsect2> + <refsect2><title><sgmltag>not</></title><para> Inverts the boolean sense of its one expression element - </para></sect2> - <sect2><title><if></title><para> + </para></refsect2> + <refsect2><title><sgmltag>if</></title><para> This element takes three expression elements; if the value of the first is true, it produces the value of the second, otherwise it produces the value of the third. - </para></sect2> - <sect2><title><alias></title><para> + </para></refsect2> + <refsect2><title><sgmltag>alias</></title><para> Alias elements provide a shorthand notation for the set of common match operations needed to substitute one font family for another. They contain a -<family> element followed by optional <prefer>, <accept> and <default> -elements. Fonts matching the <family> element are edited to prepend the -list of <prefer>ed families before the matching <family>, append the -<accept>able familys after the matching <family> and append the <default> +<sgmltag>family</> element followed by optional <sgmltag>prefer</>, <sgmltag>accept</> and <sgmltag>default</> +elements. Fonts matching the <sgmltag>family</> element are edited to prepend the +list of <sgmltag>prefer</>ed families before the matching <sgmltag>family</>, append the +<sgmltag>accept</>able familys after the matching <sgmltag>family</> and append the <sgmltag>default</> families to the end of the family list. - </para></sect2> - <sect2><title><family></title><para> + </para></refsect2> + <refsect2><title><sgmltag>family</></title><para> Holds a single font family name - </para></sect2> - <sect2><title><prefer>, <accept>, <default></title><para> -These hold a list of <family> elements to be used by the <alias> element. -</article> - </para></sect2> -</sect1> -<sect1><title>EXAMPLE CONFIGURATION FILE</title> - <sect2><title>System configuration file</title> + </para></refsect2> + <refsect2><title><sgmltag>prefer</>, <sgmltag>accept</>, <sgmltag>default</></title><para> +These hold a list of <sgmltag>family</> elements to be used by the <sgmltag>alias</> element. +<sgmltag>/article</> + </para></refsect2> +</refsect1> +<refsect1><title>EXAMPLE CONFIGURATION FILE</title> + <refsect2><title>System configuration file</title> <para> This is an example of a system-wide configuration file </para> @@ -510,8 +470,8 @@ This is an example of a system-wide configuration file </alias> </fontconfig> </programlisting> - </sect2> - <sect2><title>User configuration file</title> + </refsect2> + <refsect2><title>User configuration file</title> <para> This is an example of a per-user configuration file that lives in ~/.fonts.conf @@ -537,9 +497,9 @@ This is an example of a per-user configuration file that lives in </match> </fontconfig> </programlisting> - </sect2> -</sect1> -<sect1><title>FILES</title> + </refsect2> +</refsect1> +<refsect1><title>FILES</title> <para> <emphasis>fonts.conf</emphasis> contains configuration information for the fontconfig library @@ -561,5 +521,5 @@ actual location is specified in the global fonts.conf file. is the conventional repository of font information that isn't found in the per-directory caches. This file is automatically maintained by fontconfig. </para> -</sect1> -</article> +</refsect1> +</refentry> |