]> git.wh0rd.org - fontconfig.git/blobdiff - doc/fontconfig-user.sgml
Testing syncmail yet again.
[fontconfig.git] / doc / fontconfig-user.sgml
index 1bb089aaef36a15684c64ce18546996fbdb8525c..450be524b9bc9009e7902aaf7f783306b782c870 100644 (file)
@@ -1,4 +1,7 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
+<!ENTITY version SYSTEM "version.sgml">
+<!ENTITY confdir SYSTEM "confdir.sgml">
+]>
 <!--
     $Id$
    
 </refnamediv>
 <refsynopsisdiv>
 <synopsis>
-   /etc/fonts/fonts.conf
-   /etc/fonts/fonts.dtd
+   &confdir;/fonts.conf
+   &confdir;/fonts.dtd
    ~/.fonts.conf
 </synopsis>
 </refsynopsisdiv>
-<refsect1><title>DESCRIPTION</title>
+<refsect1><title>Description</title>
   <para>
 Fontconfig is a library designed to provide system-wide font configuration,
 customization and application access.
   </para>
 </refsect1>
-<refsect1><title>FUNCTIONAL OVERVIEW</title>
+<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>
-  <refsect2><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
@@ -78,7 +81,7 @@ simplify and regularize font installation and customization.
     </para>
   </refsect2>
   <refsect2>
-    <title>FONT PROPERTIES</title>
+    <title>Font Properties</title>
     <para>
 While font patterns may contain essentially any properties, there are some
 well known properties with associated types.  Fontconfig uses some of these
@@ -119,7 +122,7 @@ convenience for the applications rendering mechanism.
     </programlisting>
   </refsect2>
   <refsect2>
-  <title>FONT MATCHING</title>
+  <title>Font Matching</title>
     <para>
 Fontconfig performs matching by measuring the distance from a provided
 pattern to all of the available fonts in the system.  The closest matching
@@ -177,7 +180,7 @@ rasterized.  Those must apply to the selected font, not the original pattern
 as false matches will often occur.
     </para>
   </refsect2>
-  <refsect2><title>FONT NAMES</title>
+  <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
@@ -204,7 +207,7 @@ Here are some examples:
     </programlisting>
   </refsect2>
 </refsect1>
-<refsect1><title>LANG TAGS</title>
+<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
@@ -219,7 +222,7 @@ library.  It currently supports 122 of the 139 languages named in ISO 639-1,
 languages with only three-letter codes.
   </para>
 </refsect1>
-<refsect1><title>CONFIGURATION FILE FORMAT</title>
+<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
@@ -229,7 +232,7 @@ a text editor.
   </para><para>
 The fontconfig document type definition resides in the external entity
 "fonts.dtd"; this is normally stored in the default font configuration
-directory (/etc/fonts).  Each configuration file should contain the
+directory (&confdir;).  Each configuration file should contain the
 following structure:
     <programlisting>
        &lt;?xml version="1.0"?&gt;
@@ -316,8 +319,12 @@ the property are given the indicated binding. 'mode' is one of:
     </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.
+These elements hold a single value of the indicated type.  <sgmltag>bool</>
+elements hold either true or false.  An important limitation exists in
+the parsing of floating point numbers -- fontconfig requires that
+the mantissa start with a digit, not a decimal point, so insert a leading
+zero for purely fractional values (e.g. use 0.5 instead of .5 and -0.5
+instead of -.5).
   </para></refsect2>
   <refsect2><title><sgmltag>matrix</></title><para>
 This element holds the four <sgmltag>double</> elements of an affine
@@ -398,7 +405,7 @@ This is an example of a system-wide configuration file
     <programlisting>
 &lt;?xml version="1.0"?&gt;
 &lt;!DOCTYPE fontconfig SYSTEM "fonts.dtd"&gt;
-&lt;!-- /etc/fonts/fonts.conf file to configure system font access --&gt;
+&lt;!-- &confdir;/fonts.conf file to configure system font access --&gt;
 &lt;fontconfig&gt;
 &lt;!-- 
        Find fonts in these directories
@@ -499,7 +506,7 @@ This is an example of a per-user configuration file that lives in
     </programlisting>
   </refsect2>
 </refsect1>
-<refsect1><title>FILES</title>
+<refsect1><title>Files</title>
   <para>
 <emphasis>fonts.conf</emphasis>
 contains configuration information for the fontconfig library
@@ -522,4 +529,9 @@ is the conventional repository of font information that isn't found in the
 per-directory caches.  This file is automatically maintained by fontconfig.
   </para>
 </refsect1>
+<refsect1><title>Version</title>
+           <para>
+Fontconfig version &version;
+           </para>
+</refsect1>
 </refentry>