X-Git-Url: https://git.wh0rd.org/?a=blobdiff_plain;f=doc%2Ffontconfig-user.sgml;h=217feb97adcde17a8e0161dd98602c8ed4d37d13;hb=8c58dc276895cbeb0e9ae79718b1a38a082709d3;hp=5e240ddd14ee841bd6c6b628506b21e5904efcb9;hpb=71f94d0768725eb171e04748d9f561f58b258ae7;p=fontconfig.git

diff --git a/doc/fontconfig-user.sgml b/doc/fontconfig-user.sgml
index 5e240dd..217feb9 100644
--- a/doc/fontconfig-user.sgml
+++ b/doc/fontconfig-user.sgml
@@ -3,23 +3,21 @@
 <!ENTITY confdir SYSTEM "confdir.sgml">
 ]>
 <!--
-    $Id$
-   
     Copyright © 2003 Keith Packard
    
     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.
    
-    KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
     INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
-    EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
     CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
     DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
     TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
@@ -39,6 +37,7 @@
    &confdir;/fonts.conf
    &confdir;/fonts.dtd
    &confdir;/conf.d
+   ~/.fonts.conf.d
    ~/.fonts.conf
 </synopsis>
 </refsynopsisdiv>
@@ -57,7 +56,7 @@ which accepts font patterns and returns the nearest matching font.
   <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
+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
@@ -87,17 +86,17 @@ 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 applications' rendering mechanism.
     </para>
     <programlisting>
   Property        Type    Description
   --------------------------------------------------------------
   family          String  Font family names
-  familylang      String  Languages cooresponding to each family
+  familylang      String  Languages corresponding to each family
   style           String  Font style. Overrides weight and slant
-  stylelang       String  Languages cooresponding to each style
+  stylelang       String  Languages corresponding to each style
   fullname        String  Font full names (often includes style)
-  fullnamelang    String  Languages cooresponding to each fullname
+  fullnamelang    String  Languages corresponding to each fullname
   slant           Int     Italic, oblique or roman
   weight          Int     Light, medium, demibold, bold or black
   size            Double  Point size
@@ -122,6 +121,7 @@ convenience for the applications rendering mechanism.
   dpi             Double  Target dots per inch
   rgba            Int     unknown, rgb, bgr, vrgb, vbgr,
                           none - subpixel geometry
+  lcdfilter       Int     Type of LCD filter
   minspace        Bool    Eliminate leading from line spacing
   charset         CharSet Unicode chars encoded by the font
   lang            String  List of RFC-3066-style languages this
@@ -215,8 +215,46 @@ Here are some examples:
   Monospace:matrix=1 .1 0 1       The users preferred monospace font
                                   with artificial obliquing
     </programlisting>
+    <para>
+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 preceded by a
+'\' character. The '\' characters are stripped out of the family name and
+values as the font name is read.
+    </para>
   </refsect2>
 </refsect1>
+<refsect1><title>Debugging Applications</title>
+  <para>
+To help diagnose font and applications problems, fontconfig is built with a
+large amount of internal debugging left enabled. It is controlled by means
+of the FC_DEBUG environment variable. The value of this variable is
+interpreted as a number, and each bit within that value controls different
+debugging messages.
+  </para>
+  <programlisting>
+  Name         Value    Meaning
+  ---------------------------------------------------------
+  MATCH            1    Brief information about font matching
+  MATCHV           2    Extensive font matching information
+  EDIT             4    Monitor match/test/edit execution
+  FONTSET          8    Track loading of font information at startup
+  CACHE           16    Watch cache files being written
+  CACHEV          32    Extensive cache file writing information
+  PARSE           64    (no longer in use)
+  SCAN           128    Watch font files being scanned to build caches
+  SCANV          256    Verbose font file scanning information
+  MEMORY         512    Monitor fontconfig memory usage
+  CONFIG        1024    Monitor which config files are loaded
+  LANGSET       2048    Dump char sets used to construct lang values
+  OBJTYPES      4096    Display message when value typechecks fail
+  </programlisting>
+  <para>
+Add the value of the desired debug levels together and assign that (in
+base 10) to the FC_DEBUG environment variable before running the
+application. Output from these statements is sent to stdout.
+  </para>
+</refsect1>
 <refsect1><title>Lang Tags</title>
   <para>
 Each font in the database contains a list of languages it supports.  This is
@@ -259,22 +297,22 @@ following structure:
   </para>
 <refsect2><title><literal>&lt;fontconfig&gt;</literal></title><para>
 This is the top level element for a font configuration and can contain
-<sgmltag>dir</>, <sgmltag>cache</>, <sgmltag>include</>, <sgmltag>match</> and <sgmltag>alias</> elements in any order.
+<literal>&lt;dir&gt;</literal>, <literal>&lt;cache&gt;</literal>, <literal>&lt;include&gt;</literal>, <literal>&lt;match&gt;</literal> and <literal>&lt;alias&gt;</literal> elements in any order.
   </para></refsect2>
-  <refsect2><title><sgmltag>dir</></title><para>
+  <refsect2><title><literal>&lt;dir&gt;</literal></title><para>
 This element contains a directory name which will be scanned for font files
 to include in the set of available fonts.
   </para></refsect2>
-  <refsect2><title><sgmltag>cache</></title><para>
+  <refsect2><title><literal>&lt;cache&gt;</literal></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-<sgmltag>version</>'', where <sgmltag>version</> is the font configuration
-file version number (currently 1).
+is ``~/.fonts.cache-<literal>&lt;version&gt;</literal>'', where <literal>&lt;version&gt;</literal> is the font configuration
+file version number (currently 2).
   </para></refsect2>
-  <refsect2><title><sgmltag>include ignore_missing="no"</></title><para>
+  <refsect2><title><literal>&lt;include ignore_missing="no"&gt;</literal></title><para>
 This element contains the name of an additional configuration file or
 directory.  If a directory, every file within that directory starting with an
 ASCII digit (U+0030 - U+0039) and ending with the string ``.conf'' will be processed in sorted order.  When
@@ -284,49 +322,50 @@ FcConfigLoadAndParse.  If 'ignore_missing' is set to "yes" instead of the
 default "no", a missing file or directory will elicit no warning message from
 the library.
   </para></refsect2>
-  <refsect2><title><sgmltag>config</></title><para>
-This element provides a place to consolodate additional configuration
-information.  <sgmltag>config</> can contain <sgmltag>blank</> and <sgmltag>rescan</> elements in any
+  <refsect2><title><literal>&lt;config&gt;</literal></title><para>
+This element provides a place to consolidate additional configuration
+information.  <literal>&lt;config&gt;</literal> can contain <literal>&lt;blank&gt;</literal> and <literal>&lt;rescan&gt;</literal> elements in any
 order.
   </para></refsect2>
-  <refsect2><title><sgmltag>blank</></title><para>
+  <refsect2><title><literal>&lt;blank&gt;</literal></title><para>
 Fonts often include "broken" glyphs which appear in the encoding but are
-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.
+drawn as blanks on the screen.  Within the <literal>&lt;blank&gt;</literal> element, place each
+Unicode characters which is supposed to be blank in an <literal>&lt;int&gt;</literal> element.
 Characters outside of this set which are drawn as blank will be elided from
 the set of characters supported by the font.
   </para></refsect2>
-  <refsect2><title><sgmltag>rescan</></title><para>
-The <sgmltag>rescan</> element holds an <sgmltag>int</> element which indicates the default
+  <refsect2><title><literal>&lt;rescan&gt;</literal></title><para>
+The <literal>&lt;rescan&gt;</literal> element holds an <literal>&lt;int&gt;</literal> 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></refsect2>
-  <refsect2><title><sgmltag>selectfont</></title><para>
+  <refsect2><title><literal>&lt;selectfont&gt;</literal></title><para>
 This element is used to black/white list fonts from being listed or matched
 against.  It holds acceptfont and rejectfont elements.
   </para></refsect2>
-  <refsect2><title><sgmltag>acceptfont</></title><para>
+  <refsect2><title><literal>&lt;acceptfont&gt;</literal></title><para>
 Fonts matched by an acceptfont element are "whitelisted"; such fonts are
 explicitly included in the set of fonts used to resolve list and match
 requests; including them in this list protects them from being "blacklisted"
 by a rejectfont element.  Acceptfont elements include glob and pattern
 elements which are used to match fonts.
   </para></refsect2>
-  <refsect2><title><sgmltag>rejectfont</></title><para>
+  <refsect2><title><literal>&lt;rejectfont&gt;</literal></title><para>
 Fonts matched by an rejectfont element are "blacklisted"; such fonts are
 excluded from the set of fonts used to resolve list and match requests as if
 they didn't exist in the system.  Rejectfont elements include glob and
 pattern elements which are used to match fonts.
   </para></refsect2>
-  <refsect2><title><sgmltag>glob</></title><para>
+  <refsect2><title><literal>&lt;glob&gt;</literal></title><para>
 Glob elements hold shell-style filename matching patterns (including ? and
 *) which match fonts based on their complete pathnames.  This can be used to
 exclude a set of directories (/usr/share/fonts/uglyfont*), or particular
 font file types (*.pcf.gz), but the latter mechanism relies rather heavily
-on filenaming conventions which can't be relied upon.
+on filenaming conventions which can't be relied upon.  Note that globs
+only apply to directories, not to individual fonts.
   </para></refsect2>
-  <refsect2><title><sgmltag>pattern</></title><para>
+  <refsect2><title><literal>&lt;pattern&gt;</literal></title><para>
 Pattern elements perform list-style matching on incoming fonts; that is,
 they hold a list of elements and associated values.  If all of those
 elements have a matching value, then the pattern matches the font.  This can
@@ -334,22 +373,24 @@ be used to select fonts based on attributes of the font (scalable, bold,
 etc), which is a more reliable mechanism than using file extensions.
 Pattern elements include patelt elements.
   </para></refsect2>
-  <refsect2><title><sgmltag>patelt name="property"</></title><para>
+  <refsect2><title><literal>&lt;patelt name="property"&gt;</literal></title><para>
 Patelt elements hold a single pattern element and list of values.  They must
 have a 'name' attribute which indicates the pattern element name.  Patelt
 elements include int, double, string, matrix, bool, charset and const
 elements.
   </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
+  <refsect2><title><literal>&lt;match target="pattern"&gt;</literal></title><para>
+This element holds first a (possibly empty) list of <literal>&lt;test&gt;</literal> elements and then
+a (possibly empty) list of <literal>&lt;edit&gt;</literal> 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.
+resulting from a match rather than a font pattern to be matched. If 'target'
+is set to "scan", then this element applies when the font is scanned to
+build the fontconfig database.
   </para></refsect2>
-  <refsect2><title><sgmltag>test qual="any" name="property" target="default" compare="eq"</></title><para>
+  <refsect2><title><literal>&lt;test qual="any" name="property" target="default" compare="eq"&gt;</literal></title><para>
 This element contains a single value which is compared with the target
-('pattern', 'font' or 'default') property "property" (substitute any of the property names seen 
+('pattern', 'font', 'scan' or 'default') property "property" (substitute any of the property names seen 
 above). 'compare' can be one of "eq", "not_eq", "less", "less_eq", "more", or
 "more_eq".  'qual' may either be the default, "any", in which case the match
 succeeds if any value associated with the property matches the test value, or
@@ -359,11 +400,11 @@ the target= attribute in the &lt;test&gt; element selects between matching
 the original pattern or the font.  "default" selects whichever target the
 outer &lt;match&gt; element has selected.
   </para></refsect2>
-  <refsect2><title><sgmltag>edit name="property" mode="assign" binding="weak"</></title><para>
+  <refsect2><title><literal>&lt;edit name="property" mode="assign" binding="weak"&gt;</literal></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 <sgmltag>test</> elements, if so, the
+"property" was matched by one of the associated <literal>&lt;test&gt;</literal> elements, if so, the
 modification may affect the first matched value.  Any values inserted into
 the property are given the indicated binding ("strong", "weak" or "same")
 with "same" binding using the value from the matched pattern element.
@@ -379,23 +420,35 @@ with "same" binding using the value from the matched pattern element.
   "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</>
+  <refsect2><title><literal>&lt;int&gt;</literal>, <literal>&lt;double&gt;</literal>, <literal>&lt;string&gt;</literal>, <literal>&lt;bool&gt;</literal></title><para>
+These elements hold a single value of the indicated type.  <literal>&lt;bool&gt;</literal>
 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
+  <refsect2><title><literal>&lt;matrix&gt;</literal></title><para>
+This element holds the four <literal>&lt;double&gt;</literal> elements of an affine
 transformation.
   </para></refsect2>
-  <refsect2><title><sgmltag>name</></title><para>
+  <refsect2><title><literal>&lt;range&gt;</literal></title><para>
+This element holds the two <literal>&lt;int&gt;</literal> elements of a range
+representation.
+  </para></refsect2>
+  <refsect2><title><literal>&lt;charset&gt;</literal></title><para>
+This element holds at least one <literal>&lt;int&gt;</literal> element of
+an Unicode code point or more.
+  </para></refsect2>
+  <refsect2><title><literal>&lt;langset&gt;</literal></title><para>
+This element holds at least one <literal>&lt;string&gt;</literal> element of
+a RFC-3066-style languages or more.
+  </para></refsect2>
+  <refsect2><title><literal>&lt;name&gt;</literal></title><para>
 Holds a property name.  Evaluates to the first value from the property of
 the font, not the pattern.
   </para></refsect2>
-  <refsect2><title><sgmltag>const</></title><para>
+  <refsect2><title><literal>&lt;const&gt;</literal></title><para>
 Holds the name of a constant; these are always integers and serve as
 symbolic names for common font values:
     <programlisting>
@@ -437,6 +490,10 @@ symbolic names for common font values:
   vrgb            rgba            3
   vbgr            rgba            4
   none            rgba            5
+  lcdnone         lcdfilter       0
+  lcddefault      lcdfilter       1
+  lcdlight        lcdfilter       2
+  lcdlegacy       lcdfilter       3
   hintnone        hintstyle       0
   hintslight      hintstyle       1
   hintmedium      hintstyle       2
@@ -445,40 +502,39 @@ symbolic names for common font values:
       </para>
     </refsect2>
   <refsect2>
-      <title><sgmltag>or</>, <sgmltag>and</>, <sgmltag>plus</>, <sgmltag>minus</>, <sgmltag>times</>, <sgmltag>divide</></title>
+      <title><literal>&lt;or&gt;</literal>, <literal>&lt;and&gt;</literal>, <literal>&lt;plus&gt;</literal>, <literal>&lt;minus&gt;</literal>, <literal>&lt;times&gt;</literal>, <literal>&lt;divide&gt;</literal></title>
       <para>
 These elements perform the specified operation on a list of expression
-elements.  <sgmltag>or</> and <sgmltag>and</> are boolean, not bitwise.
+elements.  <literal>&lt;or&gt;</literal> and <literal>&lt;and&gt;</literal> are boolean, not bitwise.
       </para>
     </refsect2>
   <refsect2>
-    <title><sgmltag>eq</>, <sgmltag>not_eq</>, <sgmltag>less</>, <sgmltag>less_eq</>, <sgmltag>more</>, <sgmltag>more_eq</></title>
+    <title><literal>&lt;eq&gt;</literal>, <literal>&lt;not_eq&gt;</literal>, <literal>&lt;less&gt;</literal>, <literal>&lt;less_eq&gt;</literal>, <literal>&lt;more&gt;</literal>, <literal>&lt;more_eq&gt;</literal></title>
     <para>
 These elements compare two values, producing a boolean result.
   </para></refsect2>
-  <refsect2><title><sgmltag>not</></title><para>
+  <refsect2><title><literal>&lt;not&gt;</literal></title><para>
 Inverts the boolean sense of its one expression element
   </para></refsect2>
-  <refsect2><title><sgmltag>if</></title><para>
+  <refsect2><title><literal>&lt;if&gt;</literal></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></refsect2>
-  <refsect2><title><sgmltag>alias</></title><para>
+  <refsect2><title><literal>&lt;alias&gt;</literal></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
-<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</>
+<literal>&lt;family&gt;</literal> element followed by optional <literal>&lt;prefer&gt;</literal>, <literal>&lt;accept&gt;</literal> and <literal>&lt;default&gt;</literal>
+elements.  Fonts matching the <literal>&lt;family&gt;</literal> element are edited to prepend the
+list of <literal>&lt;prefer&gt;</literal>ed families before the matching <literal>&lt;family&gt;</literal>, append the
+<literal>&lt;accept&gt;</literal>able families after the matching <literal>&lt;family&gt;</literal> and append the <literal>&lt;default&gt;</literal>
 families to the end of the family list.
   </para></refsect2>
-  <refsect2><title><sgmltag>family</></title><para>
+  <refsect2><title><literal>&lt;family&gt;</literal></title><para>
 Holds a single font family name
   </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</>
+  <refsect2><title><literal>&lt;prefer&gt;</literal>, <literal>&lt;accept&gt;</literal>, <literal>&lt;default&gt;</literal></title><para>
+These hold a list of <literal>&lt;family&gt;</literal> elements to be used by the <literal>&lt;alias&gt;</literal> element.
   </para></refsect2>
 </refsect1>
 <refsect1><title>EXAMPLE CONFIGURATION FILE</title>
@@ -603,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 
 &lt;include&gt; directive.
   </para>
@@ -619,6 +675,12 @@ format.  The master fonts.conf file references this directory in an
 is a DTD that describes the format of the configuration files.
   </para>
   <para>
+<emphasis>~/.fonts.conf.d</emphasis>
+is the conventional name for a per-user directory of (typically
+auto-generated) configuration files, although the
+actual location is specified in the global fonts.conf file.
+  </para>
+  <para>
 <emphasis>~/.fonts.conf</emphasis>
 is the conventional location for per-user font configuration, although the
 actual location is specified in the global fonts.conf file.
@@ -631,7 +693,7 @@ per-directory caches.  This file is automatically maintained by fontconfig.
 </refsect1>
 <refsect1><title>See Also</title>
   <para>
-fc-cache(1), fc-match(1), fc-list(1)
+fc-cat(1), fc-cache(1), fc-list(1), fc-match(1), fc-query(1)
   </para>
 </refsect1>
 <refsect1><title>Version</title>