doc/fontconfig-user.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
   2 <!ENTITY version SYSTEM "version.sgml">
   3 <!ENTITY confdir SYSTEM "confdir.sgml">
   4 ]>
   5 <!--
   6     Copyright © 2003 Keith Packard
   7
   8     Permission to use, copy, modify, distribute, and sell this software and its
   9     documentation for any purpose is hereby granted without fee, provided that
  10     the above copyright notice appear in all copies and that both that
  11     copyright notice and this permission notice appear in supporting
  12     documentation, and that the name of the author(s) not be used in
  13     advertising or publicity pertaining to distribution of the software without
  14     specific, written prior permission.  The authors make no
  15     representations about the suitability of this software for any purpose.  It
  16     is provided "as is" without express or implied warranty.
  17
  18     THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  19     INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  20     EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  21     CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  22     DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  23     TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  24     PERFORMANCE OF THIS SOFTWARE.
  25 -->
  26 <refentry>
  27 <refmeta>
  28   <refentrytitle>fonts-conf</refentrytitle>
  29   <manvolnum>5</manvolnum>
  30 </refmeta>
  31 <refnamediv>
  32         <refname>fonts.conf</refname>
  33         <refpurpose>Font configuration files</refpurpose>
  34 </refnamediv>
  35 <refsynopsisdiv>
  36 <synopsis>
  37    &confdir;/fonts.conf
  38    &confdir;/fonts.dtd
  39    &confdir;/conf.d
  40    $XDG_CONFIG_HOME/fontconfig/conf.d
  41    $XDG_CONFIG_HOME/fontconfig/fonts.conf
  42    ~/.fonts.conf.d
  43    ~/.fonts.conf
  44 </synopsis>
  45 </refsynopsisdiv>
  46 <refsect1><title>Description</title>
  47   <para>
  48 Fontconfig is a library designed to provide system-wide font configuration,
  49 customization and application access.
  50   </para>
  51 </refsect1>
  52 <refsect1><title>Functional Overview</title>
  53   <para>
  54 Fontconfig contains two essential modules, the configuration module which
  55 builds an internal configuration from XML files and the matching module
  56 which accepts font patterns and returns the nearest matching font.
  57   </para>
  58   <refsect2><title>Font Configuration</title>
  59     <para>
  60 The configuration module consists of the FcConfig datatype, libexpat and
  61 FcConfigParse which walks over an XML tree and amends a configuration with
  62 data found within.  From an external perspective, configuration of the
  63 library consists of generating a valid XML tree and feeding that to
  64 FcConfigParse.  The only other mechanism provided to applications for
  65 changing the running configuration is to add fonts and directories to the
  66 list of application-provided font files.
  67     </para><para>
  68 The intent is to make font configurations relatively static, and shared by
  69 as many applications as possible.  It is hoped that this will lead to more
  70 stable font selection when passing names from one application to another.
  71 XML was chosen as a configuration file format because it provides a format
  72 which is easy for external agents to edit while retaining the correct
  73 structure and syntax.
  74     </para><para>
  75 Font configuration is separate from font matching; applications needing to
  76 do their own matching can access the available fonts from the library and
  77 perform private matching.  The intent is to permit applications to pick and
  78 choose appropriate functionality from the library instead of forcing them to
  79 choose between this library and a private configuration mechanism.  The hope
  80 is that this will ensure that configuration of fonts for all applications
  81 can be centralized in one place.  Centralizing font configuration will
  82 simplify and regularize font installation and customization.
  83     </para>
  84   </refsect2>
  85   <refsect2>
  86     <title>Font Properties</title>
  87     <para>
  88 While font patterns may contain essentially any properties, there are some
  89 well known properties with associated types.  Fontconfig uses some of these
  90 properties for font matching and font completion.  Others are provided as a
  91 convenience for the applications' rendering mechanism.
  92     </para>
  93     <programlisting>
  94   Property        Type    Description
  95   --------------------------------------------------------------
  96   family          String  Font family names
  97   familylang      String  Languages corresponding to each family
  98   style           String  Font style. Overrides weight and slant
  99   stylelang       String  Languages corresponding to each style
 100   fullname        String  Font full names (often includes style)
 101   fullnamelang    String  Languages corresponding to each fullname
 102   slant           Int     Italic, oblique or roman
 103   weight          Int     Light, medium, demibold, bold or black
 104   size            Double  Point size
 105   width           Int     Condensed, normal or expanded
 106   aspect          Double  Stretches glyphs horizontally before hinting
 107   pixelsize       Double  Pixel size
 108   spacing         Int     Proportional, dual-width, monospace or charcell
 109   foundry         String  Font foundry name
 110   antialias       Bool    Whether glyphs can be antialiased
 111   hinting         Bool    Whether the rasterizer should use hinting
 112   hintstyle       Int     Automatic hinting style
 113   verticallayout  Bool    Use vertical layout
 114   autohint        Bool    Use autohinter instead of normal hinter
 115   globaladvance   Bool    Use font global advance data (deprecated)
 116   file            String  The filename holding the font
 117   index           Int     The index of the font within the file
 118   ftface          FT_Face Use the specified FreeType face object
 119   rasterizer      String  Which rasterizer is in use (deprecated)
 120   outline         Bool    Whether the glyphs are outlines
 121   scalable        Bool    Whether glyphs can be scaled
 122   color           Bool    Whether any glyphs have color
 123   scale           Double  Scale factor for point->pixel conversions
 124   dpi             Double  Target dots per inch
 125   rgba            Int     unknown, rgb, bgr, vrgb, vbgr,
 126                           none - subpixel geometry
 127   lcdfilter       Int     Type of LCD filter
 128   minspace        Bool    Eliminate leading from line spacing
 129   charset         CharSet Unicode chars encoded by the font
 130   lang            String  List of RFC-3066-style languages this
 131                           font supports
 132   fontversion     Int     Version number of the font
 133   capability      String  List of layout capabilities in the font
 134   fontformat      String  String name of the font format
 135   embolden        Bool    Rasterizer should synthetically embolden the font
 136   embeddedbitmap  Bool    Use the embedded bitmap instead of the outline
 137   decorative      Bool    Whether the style is a decorative variant
 138   fontfeatures    String  List of the feature tags in OpenType to be enabled
 139   namelang        String  Language name to be used for the default value of
 140                           familylang, stylelang, and fullnamelang
 141   prgname         String  String  Name of the running program
 142   postscriptname  String  Font family name in PostScript
 143     </programlisting>
 144   </refsect2>
 145   <refsect2>
 146   <title>Font Matching</title>
 147     <para>
 148 Fontconfig performs matching by measuring the distance from a provided
 149 pattern to all of the available fonts in the system.  The closest matching
 150 font is selected.  This ensures that a font will always be returned, but
 151 doesn't ensure that it is anything like the requested pattern.
 152     </para><para>
 153 Font matching starts with an application constructed pattern.  The desired
 154 attributes of the resulting font are collected together in a pattern.  Each
 155 property of the pattern can contain one or more values; these are listed in
 156 priority order; matches earlier in the list are considered "closer" than
 157 matches later in the list.
 158     </para><para>
 159 The initial pattern is modified by applying the list of editing instructions
 160 specific to patterns found in the configuration; each consists of a match
 161 predicate and a set of editing operations.  They are executed in the order
 162 they appeared in the configuration.  Each match causes the associated
 163 sequence of editing operations to be applied.
 164     </para><para>
 165 After the pattern has been edited, a sequence of default substitutions are
 166 performed to canonicalize the set of available properties; this avoids the
 167 need for the lower layers to constantly provide default values for various
 168 font properties during rendering.
 169     </para><para>
 170 The canonical font pattern is finally matched against all available fonts.
 171 The distance from the pattern to the font is measured for each of several
 172 properties: foundry, charset, family, lang, spacing, pixelsize, style,
 173 slant, weight, antialias, rasterizer and outline.  This list is in priority
 174 order -- results of comparing earlier elements of this list weigh more
 175 heavily than later elements.
 176     </para><para>
 177 There is one special case to this rule; family names are split into two
 178 bindings; strong and weak.  Strong family names are given greater precedence
 179 in the match than lang elements while weak family names are given lower
 180 precedence than lang elements.  This permits the document language to drive
 181 font selection when any document specified font is unavailable.
 182     </para><para>
 183 The pattern representing that font is augmented to include any properties
 184 found in the pattern but not found in the font itself; this permits the
 185 application to pass rendering instructions or any other data through the
 186 matching system.  Finally, the list of editing instructions specific to
 187 fonts found in the configuration are applied to the pattern.  This modified
 188 pattern is returned to the application.
 189     </para><para>
 190 The return value contains sufficient information to locate and rasterize the
 191 font, including the file name, pixel size and other rendering data.  As
 192 none of the information involved pertains to the FreeType library,
 193 applications are free to use any rasterization engine or even to take
 194 the identified font file and access it directly.
 195     </para><para>
 196 The match/edit sequences in the configuration are performed in two passes
 197 because there are essentially two different operations necessary -- the
 198 first is to modify how fonts are selected; aliasing families and adding
 199 suitable defaults.  The second is to modify how the selected fonts are
 200 rasterized.  Those must apply to the selected font, not the original pattern
 201 as false matches will often occur.
 202     </para>
 203   </refsect2>
 204   <refsect2><title>Font Names</title>
 205     <para>
 206 Fontconfig provides a textual representation for patterns that the library
 207 can both accept and generate.  The representation is in three parts, first a
 208 list of family names, second a list of point sizes and finally a list of
 209 additional properties:
 210     </para>
 211     <programlisting>
 212         &lt;families&gt;-&lt;point sizes&gt;:&lt;name1&gt;=&lt;values1&gt;:&lt;name2&gt;=&lt;values2&gt;...
 213     </programlisting>
 214     <para>
 215 Values in a list are separated with commas.  The name needn't include either
 216 families or point sizes; they can be elided.  In addition, there are
 217 symbolic constants that simultaneously indicate both a name and a value.
 218 Here are some examples:
 219     </para>
 220     <programlisting>
 221   Name                            Meaning
 222   ----------------------------------------------------------
 223   Times-12                        12 point Times Roman
 224   Times-12:bold                   12 point Times Bold
 225   Courier:italic                  Courier Italic in the default size
 226   Monospace:matrix=1 .1 0 1       The users preferred monospace font
 227                                   with artificial obliquing
 228     </programlisting>
 229     <para>
 230 The '\', '-', ':' and ',' characters in family names must be preceded by a
 231 '\' character to avoid having them misinterpreted. Similarly, values
 232 containing '\', '=', '_', ':' and ',' must also have them preceded by a
 233 '\' character. The '\' characters are stripped out of the family name and
 234 values as the font name is read.
 235     </para>
 236   </refsect2>
 237 </refsect1>
 238 <refsect1 id="debug"><title>Debugging Applications</title>
 239   <para>
 240 To help diagnose font and applications problems, fontconfig is built with a
 241 large amount of internal debugging left enabled. It is controlled by means
 242 of the FC_DEBUG environment variable. The value of this variable is
 243 interpreted as a number, and each bit within that value controls different
 244 debugging messages.
 245   </para>
 246   <programlisting>
 247   Name         Value    Meaning
 248   ---------------------------------------------------------
 249   MATCH            1    Brief information about font matching
 250   MATCHV           2    Extensive font matching information
 251   EDIT             4    Monitor match/test/edit execution
 252   FONTSET          8    Track loading of font information at startup
 253   CACHE           16    Watch cache files being written
 254   CACHEV          32    Extensive cache file writing information
 255   PARSE           64    (no longer in use)
 256   SCAN           128    Watch font files being scanned to build caches
 257   SCANV          256    Verbose font file scanning information
 258   MEMORY         512    Monitor fontconfig memory usage
 259   CONFIG        1024    Monitor which config files are loaded
 260   LANGSET       2048    Dump char sets used to construct lang values
 261   OBJTYPES      4096    Display message when value typechecks fail
 262   </programlisting>
 263   <para>
 264 Add the value of the desired debug levels together and assign that (in
 265 base 10) to the FC_DEBUG environment variable before running the
 266 application. Output from these statements is sent to stdout.
 267   </para>
 268 </refsect1>
 269 <refsect1><title>Lang Tags</title>
 270   <para>
 271 Each font in the database contains a list of languages it supports.  This is
 272 computed by comparing the Unicode coverage of the font with the orthography
 273 of each language.  Languages are tagged using an RFC-3066 compatible naming
 274 and occur in two parts -- the ISO 639 language tag followed a hyphen and then
 275 by the ISO 3166 country code.  The hyphen and country code may be elided.
 276   </para><para>
 277 Fontconfig has orthographies for several languages built into the library.
 278 No provision has been made for adding new ones aside from rebuilding the
 279 library.  It currently supports 122 of the 139 languages named in ISO 639-1,
 280 141 of the languages with two-letter codes from ISO 639-2 and another 30
 281 languages with only three-letter codes.  Languages with both two and three
 282 letter codes are provided with only the two letter code.
 283   </para><para>
 284 For languages used in multiple territories with radically different
 285 character sets, fontconfig includes per-territory orthographies.  This
 286 includes Azerbaijani, Kurdish, Pashto, Tigrinya and Chinese.
 287   </para>
 288 </refsect1>
 289 <refsect1><title>Configuration File Format</title>
 290   <para>
 291 Configuration files for fontconfig are stored in XML format; this
 292 format makes external configuration tools easier to write and ensures that
 293 they will generate syntactically correct configuration files.  As XML
 294 files are plain text, they can also be manipulated by the expert user using
 295 a text editor.
 296   </para><para>
 297 The fontconfig document type definition resides in the external entity
 298 "fonts.dtd"; this is normally stored in the default font configuration
 299 directory (&confdir;).  Each configuration file should contain the
 300 following structure:
 301     <programlisting>
 302         &lt;?xml version="1.0"?&gt;
 303         &lt;!DOCTYPE fontconfig SYSTEM "fonts.dtd"&gt;
 304         &lt;fontconfig&gt;
 305         ...
 306         &lt;/fontconfig&gt;
 307     </programlisting>
 308   </para>
 309 <refsect2><title><literal>&lt;fontconfig&gt;</literal></title><para>
 310 This is the top level element for a font configuration and can contain
 311 <literal>&lt;dir&gt;</literal>, <literal>&lt;cachedir&gt;</literal>, <literal>&lt;include&gt;</literal>, <literal>&lt;match&gt;</literal> and <literal>&lt;alias&gt;</literal> elements in any order.
 312   </para></refsect2>
 313   <refsect2><title><literal>&lt;dir prefix="default"&gt;</literal></title><para>
 314 This element contains a directory name which will be scanned for font files
 315 to include in the set of available fonts. If 'prefix' is set to "xdg", the value in the XDG_DATA_HOME environment variable will be added as the path prefix. please see XDG Base Directory Specification for more details.
 316   </para></refsect2>
 317   <refsect2><title><literal>&lt;cachedir prefix="default"&gt;</literal></title><para>
 318 This element contains a directory name that is supposed to be stored or read
 319 the cache of font information.  If multiple elements are specified in
 320 the configuration file, the directory that can be accessed first in the list
 321 will be used to store the cache files.  If it starts with '~', it refers to
 322 a directory in the users home directory.  If 'prefix' is set to "xdg", the value in the XDG_CACHE_HOME environment variable will be added as the path prefix. please see XDG Base Directory Specification for more details.
 323 The default directory is ``$XDG_CACHE_HOME/fontconfig'' and it contains the cache files
 324 named ``<literal>&lt;hash value&gt;</literal>-<literal>&lt;architecture&gt;</literal>.cache-<literal>&lt;version&gt;</literal>'',
 325 where <literal>&lt;version&gt;</literal> is the font configureation file
 326 version number (currently 3).
 327   </para></refsect2>
 328   <refsect2><title><literal>&lt;include ignore_missing="no" prefix="default"&gt;</literal></title><para>
 329 This element contains the name of an additional configuration file or
 330 directory.  If a directory, every file within that directory starting with an
 331 ASCII digit (U+0030 - U+0039) and ending with the string ``.conf'' will be processed in sorted order.  When
 332 the XML datatype is traversed by FcConfigParse, the contents of the file(s)
 333 will also be incorporated into the configuration by passing the filename(s) to
 334 FcConfigLoadAndParse.  If 'ignore_missing' is set to "yes" instead of the
 335 default "no", a missing file or directory will elicit no warning message from
 336 the library.  If 'prefix' is set to "xdg", the value in the XDG_CONFIG_HOME environment variable will be added as the path prefix. please see XDG Base Directory Specification for more details.
 337   </para></refsect2>
 338   <refsect2><title><literal>&lt;config&gt;</literal></title><para>
 339 This element provides a place to consolidate additional configuration
 340 information.  <literal>&lt;config&gt;</literal> can contain <literal>&lt;blank&gt;</literal> and <literal>&lt;rescan&gt;</literal> elements in any
 341 order.
 342   </para></refsect2>
 343   <refsect2><title><literal>&lt;blank&gt;</literal></title><para>
 344 Fonts often include "broken" glyphs which appear in the encoding but are
 345 drawn as blanks on the screen.  Within the <literal>&lt;blank&gt;</literal> element, place each
 346 Unicode characters which is supposed to be blank in an <literal>&lt;int&gt;</literal> element.
 347 Characters outside of this set which are drawn as blank will be elided from
 348 the set of characters supported by the font.
 349   </para></refsect2>
 350   <refsect2><title><literal>&lt;rescan&gt;</literal></title><para>
 351 The <literal>&lt;rescan&gt;</literal> element holds an <literal>&lt;int&gt;</literal> element which indicates the default
 352 interval between automatic checks for font configuration changes.
 353 Fontconfig will validate all of the configuration files and directories and
 354 automatically rebuild the internal datastructures when this interval passes.
 355   </para></refsect2>
 356   <refsect2><title><literal>&lt;selectfont&gt;</literal></title><para>
 357 This element is used to black/white list fonts from being listed or matched
 358 against.  It holds acceptfont and rejectfont elements.
 359   </para></refsect2>
 360   <refsect2><title><literal>&lt;acceptfont&gt;</literal></title><para>
 361 Fonts matched by an acceptfont element are "whitelisted"; such fonts are
 362 explicitly included in the set of fonts used to resolve list and match
 363 requests; including them in this list protects them from being "blacklisted"
 364 by a rejectfont element.  Acceptfont elements include glob and pattern
 365 elements which are used to match fonts.
 366   </para></refsect2>
 367   <refsect2><title><literal>&lt;rejectfont&gt;</literal></title><para>
 368 Fonts matched by an rejectfont element are "blacklisted"; such fonts are
 369 excluded from the set of fonts used to resolve list and match requests as if
 370 they didn't exist in the system.  Rejectfont elements include glob and
 371 pattern elements which are used to match fonts.
 372   </para></refsect2>
 373   <refsect2><title><literal>&lt;glob&gt;</literal></title><para>
 374 Glob elements hold shell-style filename matching patterns (including ? and
 375 *) which match fonts based on their complete pathnames.  This can be used to
 376 exclude a set of directories (/usr/share/fonts/uglyfont*), or particular
 377 font file types (*.pcf.gz), but the latter mechanism relies rather heavily
 378 on filenaming conventions which can't be relied upon.  Note that globs
 379 only apply to directories, not to individual fonts.
 380   </para></refsect2>
 381   <refsect2><title><literal>&lt;pattern&gt;</literal></title><para>
 382 Pattern elements perform list-style matching on incoming fonts; that is,
 383 they hold a list of elements and associated values.  If all of those
 384 elements have a matching value, then the pattern matches the font.  This can
 385 be used to select fonts based on attributes of the font (scalable, bold,
 386 etc), which is a more reliable mechanism than using file extensions.
 387 Pattern elements include patelt elements.
 388   </para></refsect2>
 389   <refsect2><title><literal>&lt;patelt name="property"&gt;</literal></title><para>
 390 Patelt elements hold a single pattern element and list of values.  They must
 391 have a 'name' attribute which indicates the pattern element name.  Patelt
 392 elements include int, double, string, matrix, bool, charset and const
 393 elements.
 394   </para></refsect2>
 395   <refsect2><title><literal>&lt;match target="pattern"&gt;</literal></title><para>
 396 This element holds first a (possibly empty) list of <literal>&lt;test&gt;</literal> elements and then
 397 a (possibly empty) list of <literal>&lt;edit&gt;</literal> elements.  Patterns which match all of the
 398 tests are subjected to all the edits.  If 'target' is set to "font" instead
 399 of the default "pattern", then this element applies to the font name
 400 resulting from a match rather than a font pattern to be matched. If 'target'
 401 is set to "scan", then this element applies when the font is scanned to
 402 build the fontconfig database.
 403   </para></refsect2>
 404   <refsect2><title><literal>&lt;test qual="any" name="property" target="default" compare="eq"&gt;</literal></title><para>
 405 This element contains a single value which is compared with the target
 406 ('pattern', 'font', 'scan' or 'default') property "property" (substitute any of the property names seen
 407 above). 'compare' can be one of "eq", "not_eq", "less", "less_eq", "more", "more_eq", "contains" or
 408 "not_contains".  'qual' may either be the default, "any", in which case the match
 409 succeeds if any value associated with the property matches the test value, or
 410 "all", in which case all of the values associated with the property must
 411 match the test value.  'ignore-blanks' takes a boolean value. if 'ignore-blanks' is set "true", any blanks in the string will be ignored on its comparison. this takes effects only when compare="eq" or compare="not_eq".
 412 When used in a &lt;match target="font"&gt; element,
 413 the target= attribute in the &lt;test&gt; element selects between matching
 414 the original pattern or the font.  "default" selects whichever target the
 415 outer &lt;match&gt; element has selected.
 416   </para></refsect2>
 417   <refsect2><title><literal>&lt;edit name="property" mode="assign" binding="weak"&gt;</literal></title><para>
 418 This element contains a list of expression elements (any of the value or
 419 operator elements).  The expression elements are evaluated at run-time and
 420 modify the property "property".  The modification depends on whether
 421 "property" was matched by one of the associated <literal>&lt;test&gt;</literal> elements, if so, the
 422 modification may affect the first matched value.  Any values inserted into
 423 the property are given the indicated binding ("strong", "weak" or "same")
 424 with "same" binding using the value from the matched pattern element.
 425 'mode' is one of:
 426     <programlisting>
 427   Mode                    With Match              Without Match
 428   ---------------------------------------------------------------------
 429   "assign"                Replace matching value  Replace all values
 430   "assign_replace"        Replace all values      Replace all values
 431   "prepend"               Insert before matching  Insert at head of list
 432   "prepend_first"         Insert at head of list  Insert at head of list
 433   "append"                Append after matching   Append at end of list
 434   "append_last"           Append at end of list   Append at end of list
 435   "delete"                Delete matching value   Delete all values
 436   "delete_all"            Delete all values       Delete all values
 437     </programlisting>
 438   </para></refsect2>
 439   <refsect2><title><literal>&lt;int&gt;</literal>, <literal>&lt;double&gt;</literal>, <literal>&lt;string&gt;</literal>, <literal>&lt;bool&gt;</literal></title><para>
 440 These elements hold a single value of the indicated type.  <literal>&lt;bool&gt;</literal>
 441 elements hold either true or false.  An important limitation exists in
 442 the parsing of floating point numbers -- fontconfig requires that
 443 the mantissa start with a digit, not a decimal point, so insert a leading
 444 zero for purely fractional values (e.g. use 0.5 instead of .5 and -0.5
 445 instead of -.5).
 446   </para></refsect2>
 447   <refsect2><title><literal>&lt;matrix&gt;</literal></title><para>
 448 This element holds four numerical expressions of an affine transformation.
 449 At their simplest these will be four <literal>&lt;double&gt;</literal> elements
 450 but they can also be more involved expressions.
 451   </para></refsect2>
 452   <refsect2><title><literal>&lt;range&gt;</literal></title><para>
 453 This element holds the two <literal>&lt;int&gt;</literal> elements of a range
 454 representation.
 455   </para></refsect2>
 456   <refsect2><title><literal>&lt;charset&gt;</literal></title><para>
 457 This element holds at least one <literal>&lt;int&gt;</literal> element of
 458 an Unicode code point or more.
 459   </para></refsect2>
 460   <refsect2><title><literal>&lt;langset&gt;</literal></title><para>
 461 This element holds at least one <literal>&lt;string&gt;</literal> element of
 462 a RFC-3066-style languages or more.
 463   </para></refsect2>
 464   <refsect2><title><literal>&lt;name&gt;</literal></title><para>
 465 Holds a property name.  Evaluates to the first value from the property of
 466 the pattern.  If the 'target' attribute is not present, it will default to
 467 'default', in which case the property is returned from the font pattern
 468 during a target="font" match, and to the pattern during a target="pattern"
 469 match.  The attribute can also take the values 'font' or 'pattern' to
 470 explicitly choose which pattern to use.  It is an error to use a target
 471 of 'font' in a match that has target="pattern".
 472   </para></refsect2>
 473   <refsect2><title><literal>&lt;const&gt;</literal></title><para>
 474 Holds the name of a constant; these are always integers and serve as
 475 symbolic names for common font values:
 476     <programlisting>
 477   Constant        Property        Value
 478   -------------------------------------
 479   thin            weight          0
 480   extralight      weight          40
 481   ultralight      weight          40
 482   light           weight          50
 483   demilight       weight          55
 484   semilight       weight          55
 485   book            weight          75
 486   regular         weight          80
 487   normal          weight          80
 488   medium          weight          100
 489   demibold        weight          180
 490   semibold        weight          180
 491   bold            weight          200
 492   extrabold       weight          205
 493   black           weight          210
 494   heavy           weight          210
 495   roman           slant           0
 496   italic          slant           100
 497   oblique         slant           110
 498   ultracondensed  width           50
 499   extracondensed  width           63
 500   condensed       width           75
 501   semicondensed   width           87
 502   normal          width           100
 503   semiexpanded    width           113
 504   expanded        width           125
 505   extraexpanded   width           150
 506   ultraexpanded   width           200
 507   proportional    spacing         0
 508   dual            spacing         90
 509   mono            spacing         100
 510   charcell        spacing         110
 511   unknown         rgba            0
 512   rgb             rgba            1
 513   bgr             rgba            2
 514   vrgb            rgba            3
 515   vbgr            rgba            4
 516   none            rgba            5
 517   lcdnone         lcdfilter       0
 518   lcddefault      lcdfilter       1
 519   lcdlight        lcdfilter       2
 520   lcdlegacy       lcdfilter       3
 521   hintnone        hintstyle       0
 522   hintslight      hintstyle       1
 523   hintmedium      hintstyle       2
 524   hintfull        hintstyle       3
 525     </programlisting>
 526       </para>
 527     </refsect2>
 528   <refsect2>
 529       <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>
 530       <para>
 531 These elements perform the specified operation on a list of expression
 532 elements.  <literal>&lt;or&gt;</literal> and <literal>&lt;and&gt;</literal> are boolean, not bitwise.
 533       </para>
 534     </refsect2>
 535   <refsect2>
 536     <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>, <literal>&lt;contains&gt;</literal>, <literal>&lt;not_contains</literal></title>
 537     <para>
 538 These elements compare two values, producing a boolean result.
 539   </para></refsect2>
 540   <refsect2><title><literal>&lt;not&gt;</literal></title><para>
 541 Inverts the boolean sense of its one expression element
 542   </para></refsect2>
 543   <refsect2><title><literal>&lt;if&gt;</literal></title><para>
 544 This element takes three expression elements; if the value of the first is
 545 true, it produces the value of the second, otherwise it produces the value
 546 of the third.
 547   </para></refsect2>
 548   <refsect2><title><literal>&lt;alias&gt;</literal></title><para>
 549 Alias elements provide a shorthand notation for the set of common match
 550 operations needed to substitute one font family for another.  They contain a
 551 <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>
 552 elements.  Fonts matching the <literal>&lt;family&gt;</literal> element are edited to prepend the
 553 list of <literal>&lt;prefer&gt;</literal>ed families before the matching <literal>&lt;family&gt;</literal>, append the
 554 <literal>&lt;accept&gt;</literal>able families after the matching <literal>&lt;family&gt;</literal> and append the <literal>&lt;default&gt;</literal>
 555 families to the end of the family list.
 556   </para></refsect2>
 557   <refsect2><title><literal>&lt;family&gt;</literal></title><para>
 558 Holds a single font family name
 559   </para></refsect2>
 560   <refsect2><title><literal>&lt;prefer&gt;</literal>, <literal>&lt;accept&gt;</literal>, <literal>&lt;default&gt;</literal></title><para>
 561 These hold a list of <literal>&lt;family&gt;</literal> elements to be used by the <literal>&lt;alias&gt;</literal> element.
 562   </para></refsect2>
 563 </refsect1>
 564 <refsect1><title>EXAMPLE CONFIGURATION FILE</title>
 565   <refsect2><title>System configuration file</title>
 566     <para>
 567 This is an example of a system-wide configuration file
 568     </para>
 569     <programlisting>
 570 &lt;?xml version="1.0"?&gt;
 571 &lt;!DOCTYPE fontconfig SYSTEM "fonts.dtd"&gt;
 572 &lt;!-- &confdir;/fonts.conf file to configure system font access --&gt;
 573 &lt;fontconfig&gt;
 574 &lt;!--
 575         Find fonts in these directories
 576 --&gt;
 577 &lt;dir&gt;/usr/share/fonts&lt;/dir&gt;
 578 &lt;dir&gt;/usr/X11R6/lib/X11/fonts&lt;/dir&gt;
 579
 580 &lt;!--
 581         Accept deprecated 'mono' alias, replacing it with 'monospace'
 582 --&gt;
 583 &lt;match target="pattern"&gt;
 584         &lt;test qual="any" name="family"&gt;&lt;string&gt;mono&lt;/string&gt;&lt;/test&gt;
 585         &lt;edit name="family" mode="assign"&gt;&lt;string&gt;monospace&lt;/string&gt;&lt;/edit&gt;
 586 &lt;/match&gt;
 587
 588 &lt;!--
 589         Names not including any well known alias are given 'sans-serif'
 590 --&gt;
 591 &lt;match target="pattern"&gt;
 592         &lt;test qual="all" name="family" mode="not_eq"&gt;&lt;string&gt;sans-serif&lt;/string&gt;&lt;/test&gt;
 593         &lt;test qual="all" name="family" mode="not_eq"&gt;&lt;string&gt;serif&lt;/string&gt;&lt;/test&gt;
 594         &lt;test qual="all" name="family" mode="not_eq"&gt;&lt;string&gt;monospace&lt;/string&gt;&lt;/test&gt;
 595         &lt;edit name="family" mode="append_last"&gt;&lt;string&gt;sans-serif&lt;/string&gt;&lt;/edit&gt;
 596 &lt;/match&gt;
 597
 598 &lt;!--
 599         Load per-user customization file, but don't complain
 600         if it doesn't exist
 601 --&gt;
 602 &lt;include ignore_missing="yes" prefix="xdg"&gt;fontconfig/fonts.conf&lt;/include&gt;
 603
 604 &lt;!--
 605         Load local customization files, but don't complain
 606         if there aren't any
 607 --&gt;
 608 &lt;include ignore_missing="yes"&gt;conf.d&lt;/include&gt;
 609 &lt;include ignore_missing="yes"&gt;local.conf&lt;/include&gt;
 610
 611 &lt;!--
 612         Alias well known font names to available TrueType fonts.
 613         These substitute TrueType faces for similar Type1
 614         faces to improve screen appearance.
 615 --&gt;
 616 &lt;alias&gt;
 617         &lt;family&gt;Times&lt;/family&gt;
 618         &lt;prefer&gt;&lt;family&gt;Times New Roman&lt;/family&gt;&lt;/prefer&gt;
 619         &lt;default&gt;&lt;family&gt;serif&lt;/family&gt;&lt;/default&gt;
 620 &lt;/alias&gt;
 621 &lt;alias&gt;
 622         &lt;family&gt;Helvetica&lt;/family&gt;
 623         &lt;prefer&gt;&lt;family&gt;Arial&lt;/family&gt;&lt;/prefer&gt;
 624         &lt;default&gt;&lt;family&gt;sans&lt;/family&gt;&lt;/default&gt;
 625 &lt;/alias&gt;
 626 &lt;alias&gt;
 627         &lt;family&gt;Courier&lt;/family&gt;
 628         &lt;prefer&gt;&lt;family&gt;Courier New&lt;/family&gt;&lt;/prefer&gt;
 629         &lt;default&gt;&lt;family&gt;monospace&lt;/family&gt;&lt;/default&gt;
 630 &lt;/alias&gt;
 631
 632 &lt;!--
 633         Provide required aliases for standard names
 634         Do these after the users configuration file so that
 635         any aliases there are used preferentially
 636 --&gt;
 637 &lt;alias&gt;
 638         &lt;family&gt;serif&lt;/family&gt;
 639         &lt;prefer&gt;&lt;family&gt;Times New Roman&lt;/family&gt;&lt;/prefer&gt;
 640 &lt;/alias&gt;
 641 &lt;alias&gt;
 642         &lt;family&gt;sans&lt;/family&gt;
 643         &lt;prefer&gt;&lt;family&gt;Arial&lt;/family&gt;&lt;/prefer&gt;
 644 &lt;/alias&gt;
 645 &lt;alias&gt;
 646         &lt;family&gt;monospace&lt;/family&gt;
 647         &lt;prefer&gt;&lt;family&gt;Andale Mono&lt;/family&gt;&lt;/prefer&gt;
 648 &lt;/alias&gt;
 649
 650 &lt;--
 651         The example of the requirements of OR operator;
 652         If the 'family' contains 'Courier New' OR 'Courier'
 653         add 'monospace' as the alternative
 654 --&gt;
 655 &lt;match target="pattern"&gt;
 656         &lt;test name="family" mode="eq"&gt;
 657                 &lt;string&gt;Courier New&lt;/string&gt;
 658         &lt;/test&gt;
 659         &lt;edit name="family" mode="prepend"&gt;
 660                 &lt;string&gt;monospace&lt;/string&gt;
 661         &lt;/edit&gt;
 662 &lt;/match&gt;
 663 &lt;match target="pattern"&gt;
 664         &lt;test name="family" mode="eq"&gt;
 665                 &lt;string&gt;Courier&lt;/string&gt;
 666         &lt;/test&gt;
 667         &lt;edit name="family" mode="prepend"&gt;
 668                 &lt;string&gt;monospace&lt;/string&gt;
 669         &lt;/edit&gt;
 670 &lt;/match&gt;
 671
 672 &lt;/fontconfig&gt;
 673     </programlisting>
 674   </refsect2>
 675   <refsect2><title>User configuration file</title>
 676     <para>
 677 This is an example of a per-user configuration file that lives in
 678 $XDG_CONFIG_HOME/fontconfig/fonts.conf
 679     </para>
 680     <programlisting>
 681 &lt;?xml version="1.0"?&gt;
 682 &lt;!DOCTYPE fontconfig SYSTEM "fonts.dtd"&gt;
 683 &lt;!-- $XDG_CONFIG_HOME/fontconfig/fonts.conf for per-user font configuration --&gt;
 684 &lt;fontconfig&gt;
 685
 686 &lt;!--
 687         Private font directory
 688 --&gt;
 689 &lt;dir prefix="xdg"&gt;fonts&lt;/dir&gt;
 690
 691 &lt;!--
 692         use rgb sub-pixel ordering to improve glyph appearance on
 693         LCD screens.  Changes affecting rendering, but not matching
 694         should always use target="font".
 695 --&gt;
 696 &lt;match target="font"&gt;
 697         &lt;edit name="rgba" mode="assign"&gt;&lt;const&gt;rgb&lt;/const&gt;&lt;/edit&gt;
 698 &lt;/match&gt;
 699 &lt;!--
 700         use WenQuanYi Zen Hei font when serif is requested for Chinese
 701 --&gt;
 702 &lt;match&gt;
 703         &lt;!--
 704                 If you don't want to use WenQuanYi Zen Hei font for zh-tw etc,
 705                 you can use zh-cn instead of zh.
 706                 Please note, even if you set zh-cn, it still matches zh.
 707                 if you don't like it, you can use compare="eq"
 708                 instead of compare="contains".
 709         --&gt;
 710         &lt;test name="lang" compare="contains"&gt;
 711                 &lt;string&gt;zh&lt;/string&gt;
 712         &lt;/test&gt;
 713         &lt;test name="family"&gt;
 714                 &lt;string&gt;serif&lt;/string&gt;
 715         &lt;/test&gt;
 716         &lt;edit name="family" mode="prepend"&gt;
 717                 &lt;string&gt;WenQuanYi Zen Hei&lt;/string&gt;
 718         &lt;/edit&gt;
 719 &lt;/match&gt;
 720 &lt;!--
 721         use VL Gothic font when sans-serif is requested for Japanese
 722 --&gt;
 723 &lt;match&gt;
 724         &lt;test name="lang" compare="contains"&gt;
 725                 &lt;string&gt;ja&lt;/string&gt;
 726         &lt;/test&gt;
 727         &lt;test name="family"&gt;
 728                 &lt;string&gt;sans-serif&lt;/string&gt;
 729         &lt;/test&gt;
 730         &lt;edit name="family" mode="prepend"&gt;
 731                 &lt;string&gt;VL Gothic&lt;/string&gt;
 732         &lt;/edit&gt;
 733 &lt;/match&gt;
 734 &lt;/fontconfig&gt;
 735     </programlisting>
 736   </refsect2>
 737 </refsect1>
 738 <refsect1><title>Files</title>
 739   <para>
 740 <emphasis>fonts.conf</emphasis>
 741 contains configuration information for the fontconfig library
 742 consisting of directories to look at for font information as well as
 743 instructions on editing program specified font patterns before attempting to
 744 match the available fonts.  It is in XML format.
 745   </para>
 746   <para>
 747 <emphasis>conf.d</emphasis>
 748 is the conventional name for a directory of additional configuration files
 749 managed by external applications or the local administrator.  The
 750 filenames starting with decimal digits are sorted in lexicographic order
 751 and used as additional configuration files.  All of these files are in XML
 752 format.  The master fonts.conf file references this directory in an
 753 &lt;include&gt; directive.
 754   </para>
 755   <para>
 756 <emphasis>fonts.dtd</emphasis>
 757 is a DTD that describes the format of the configuration files.
 758   </para>
 759   <para>
 760 <emphasis>$XDG_CONFIG_HOME/fontconfig/conf.d</emphasis> and <emphasis>~/.fonts.conf.d</emphasis>
 761 is the conventional name for a per-user directory of (typically
 762 auto-generated) configuration files, although the
 763 actual location is specified in the global fonts.conf file. please note that ~/.fonts.conf.d is deprecated now. it will not be read by default in the future version.
 764   </para>
 765   <para>
 766 <emphasis>$XDG_CONFIG_HOME/fontconfig/fonts.conf</emphasis> and <emphasis>~/.fonts.conf</emphasis>
 767 is the conventional location for per-user font configuration, although the
 768 actual location is specified in the global fonts.conf file. please note that ~/.fonts.conf is deprecated now. it will not be read by default in the future version.
 769   </para>
 770   <para>
 771 <emphasis>$XDG_CACHE_HOME/fontconfig/*.cache-*</emphasis> and <emphasis> ~/.fontconfig/*.cache-*</emphasis>
 772 is the conventional repository of font information that isn't found in the
 773 per-directory caches.  This file is automatically maintained by fontconfig. please note that ~/.fontconfig/*.cache-* is deprecated now. it will not be read by default in the future version.
 774   </para>
 775 </refsect1>
 776 <refsect1><title>Environment variables</title>
 777   <para>
 778 <emphasis>FONTCONFIG_FILE</emphasis>
 779 is used to override the default configuration file.
 780   </para>
 781   <para>
 782 <emphasis>FONTCONFIG_PATH</emphasis>
 783 is used to override the default configuration directory.
 784   </para>
 785   <para>
 786 <emphasis>FC_DEBUG</emphasis>
 787 is used to output the detailed debugging messages. see <link linkend="debug">Debugging Applications</link> section for more details.
 788   </para>
 789   <para>
 790 <emphasis>FONTCONFIG_USE_MMAP</emphasis>
 791 is used to control the use of mmap(2) for the cache files if available. this take a boolean value. fontconfig will checks if the cache files are stored on the filesystem that is safe to use mmap(2). explicitly setting this environment variable will causes skipping this check and enforce to use or not use mmap(2) anyway.
 792   </para>
 793 </refsect1>
 794 <refsect1><title>See Also</title>
 795   <para>
 796 fc-cat(1), fc-cache(1), fc-list(1), fc-match(1), fc-query(1)
 797   </para>
 798 </refsect1>
 799 <refsect1><title>Version</title>
 800             <para>
 801 Fontconfig version &version;
 802             </para>
 803 </refsect1>
 804 </refentry>