1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
2 <!ENTITY version SYSTEM "version.sgml">
3 <!ENTITY confdir SYSTEM "confdir.sgml">
6 Copyright © 2003 Keith Packard
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.
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.
28 <refentrytitle>fonts-conf</refentrytitle>
29 <manvolnum>5</manvolnum>
32 <refname>fonts.conf</refname>
33 <refpurpose>Font configuration files</refpurpose>
40 $XDG_CONFIG_HOME/fontconfig/conf.d
41 $XDG_CONFIG_HOME/fontconfig/fonts.conf
46 <refsect1><title>Description</title>
48 Fontconfig is a library designed to provide system-wide font configuration,
49 customization and application access.
52 <refsect1><title>Functional Overview</title>
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.
58 <refsect2><title>Font Configuration</title>
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.
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
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.
86 <title>Font Properties</title>
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.
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 (deprecated)
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
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 fonthashint Bool Whether the font has hinting
144 order Int Order number of the font
148 <title>Font Matching</title>
150 Fontconfig performs matching by measuring the distance from a provided
151 pattern to all of the available fonts in the system. The closest matching
152 font is selected. This ensures that a font will always be returned, but
153 doesn't ensure that it is anything like the requested pattern.
155 Font matching starts with an application constructed pattern. The desired
156 attributes of the resulting font are collected together in a pattern. Each
157 property of the pattern can contain one or more values; these are listed in
158 priority order; matches earlier in the list are considered "closer" than
159 matches later in the list.
161 The initial pattern is modified by applying the list of editing instructions
162 specific to patterns found in the configuration; each consists of a match
163 predicate and a set of editing operations. They are executed in the order
164 they appeared in the configuration. Each match causes the associated
165 sequence of editing operations to be applied.
167 After the pattern has been edited, a sequence of default substitutions are
168 performed to canonicalize the set of available properties; this avoids the
169 need for the lower layers to constantly provide default values for various
170 font properties during rendering.
172 The canonical font pattern is finally matched against all available fonts.
173 The distance from the pattern to the font is measured for each of several
174 properties: foundry, charset, family, lang, spacing, pixelsize, style,
175 slant, weight, antialias, rasterizer and outline. This list is in priority
176 order -- results of comparing earlier elements of this list weigh more
177 heavily than later elements.
179 There is one special case to this rule; family names are split into two
180 bindings; strong and weak. Strong family names are given greater precedence
181 in the match than lang elements while weak family names are given lower
182 precedence than lang elements. This permits the document language to drive
183 font selection when any document specified font is unavailable.
185 The pattern representing that font is augmented to include any properties
186 found in the pattern but not found in the font itself; this permits the
187 application to pass rendering instructions or any other data through the
188 matching system. Finally, the list of editing instructions specific to
189 fonts found in the configuration are applied to the pattern. This modified
190 pattern is returned to the application.
192 The return value contains sufficient information to locate and rasterize the
193 font, including the file name, pixel size and other rendering data. As
194 none of the information involved pertains to the FreeType library,
195 applications are free to use any rasterization engine or even to take
196 the identified font file and access it directly.
198 The match/edit sequences in the configuration are performed in two passes
199 because there are essentially two different operations necessary -- the
200 first is to modify how fonts are selected; aliasing families and adding
201 suitable defaults. The second is to modify how the selected fonts are
202 rasterized. Those must apply to the selected font, not the original pattern
203 as false matches will often occur.
206 <refsect2><title>Font Names</title>
208 Fontconfig provides a textual representation for patterns that the library
209 can both accept and generate. The representation is in three parts, first a
210 list of family names, second a list of point sizes and finally a list of
211 additional properties:
214 <families>-<point sizes>:<name1>=<values1>:<name2>=<values2>...
217 Values in a list are separated with commas. The name needn't include either
218 families or point sizes; they can be elided. In addition, there are
219 symbolic constants that simultaneously indicate both a name and a value.
220 Here are some examples:
224 ----------------------------------------------------------
225 Times-12 12 point Times Roman
226 Times-12:bold 12 point Times Bold
227 Courier:italic Courier Italic in the default size
228 Monospace:matrix=1 .1 0 1 The users preferred monospace font
229 with artificial obliquing
232 The '\', '-', ':' and ',' characters in family names must be preceded by a
233 '\' character to avoid having them misinterpreted. Similarly, values
234 containing '\', '=', '_', ':' and ',' must also have them preceded by a
235 '\' character. The '\' characters are stripped out of the family name and
236 values as the font name is read.
240 <refsect1 id="debug"><title>Debugging Applications</title>
242 To help diagnose font and applications problems, fontconfig is built with a
243 large amount of internal debugging left enabled. It is controlled by means
244 of the FC_DEBUG environment variable. The value of this variable is
245 interpreted as a number, and each bit within that value controls different
250 ---------------------------------------------------------
251 MATCH 1 Brief information about font matching
252 MATCHV 2 Extensive font matching information
253 EDIT 4 Monitor match/test/edit execution
254 FONTSET 8 Track loading of font information at startup
255 CACHE 16 Watch cache files being written
256 CACHEV 32 Extensive cache file writing information
257 PARSE 64 (no longer in use)
258 SCAN 128 Watch font files being scanned to build caches
259 SCANV 256 Verbose font file scanning information
260 MEMORY 512 Monitor fontconfig memory usage
261 CONFIG 1024 Monitor which config files are loaded
262 LANGSET 2048 Dump char sets used to construct lang values
263 MATCH2 4096 Display font-matching transformation in patterns
266 Add the value of the desired debug levels together and assign that (in
267 base 10) to the FC_DEBUG environment variable before running the
268 application. Output from these statements is sent to stdout.
271 <refsect1><title>Lang Tags</title>
273 Each font in the database contains a list of languages it supports. This is
274 computed by comparing the Unicode coverage of the font with the orthography
275 of each language. Languages are tagged using an RFC-3066 compatible naming
276 and occur in two parts -- the ISO 639 language tag followed a hyphen and then
277 by the ISO 3166 country code. The hyphen and country code may be elided.
279 Fontconfig has orthographies for several languages built into the library.
280 No provision has been made for adding new ones aside from rebuilding the
281 library. It currently supports 122 of the 139 languages named in ISO 639-1,
282 141 of the languages with two-letter codes from ISO 639-2 and another 30
283 languages with only three-letter codes. Languages with both two and three
284 letter codes are provided with only the two letter code.
286 For languages used in multiple territories with radically different
287 character sets, fontconfig includes per-territory orthographies. This
288 includes Azerbaijani, Kurdish, Pashto, Tigrinya and Chinese.
291 <refsect1><title>Configuration File Format</title>
293 Configuration files for fontconfig are stored in XML format; this
294 format makes external configuration tools easier to write and ensures that
295 they will generate syntactically correct configuration files. As XML
296 files are plain text, they can also be manipulated by the expert user using
299 The fontconfig document type definition resides in the external entity
300 "fonts.dtd"; this is normally stored in the default font configuration
301 directory (&confdir;). Each configuration file should contain the
304 <?xml version="1.0"?>
305 <!DOCTYPE fontconfig SYSTEM "urn:fontconfig:fonts.dtd">
311 <refsect2><title><literal><fontconfig></literal></title><para>
312 This is the top level element for a font configuration and can contain
313 <literal><dir></literal>, <literal><cachedir></literal>, <literal><include></literal>, <literal><match></literal> and <literal><alias></literal> elements in any order.
315 <refsect2><title><literal><dir prefix="default" salt=""></literal></title><para>
316 This element contains a directory name which will be scanned for font files
317 to include in the set of available fonts.
319 If 'prefix' is set to "default" or "cwd", the current working directory will be added as the path prefix prior to the value. 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. If 'prefix' is set to "relative", the path of current file will be added prior to the value.
321 'salt' property affects to determine cache filename. this is useful for example when having different fonts sets on same path at container and share fonts from host on different font path.
323 <refsect2><title><literal><cachedir prefix="default"></literal></title><para>
324 This element contains a directory name that is supposed to be stored or read
325 the cache of font information. If multiple elements are specified in
326 the configuration file, the directory that can be accessed first in the list
327 will be used to store the cache files. If it starts with '~', it refers to
328 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.
329 The default directory is ``$XDG_CACHE_HOME/fontconfig'' and it contains the cache files
330 named ``<literal><hash value></literal>-<literal><architecture></literal>.cache-<literal><version></literal>'',
331 where <literal><version></literal> is the fontconfig cache file
332 version number (currently 7).
334 <refsect2><title><literal><include ignore_missing="no" prefix="default"></literal></title><para>
335 This element contains the name of an additional configuration file or
336 directory. If a directory, every file within that directory starting with an
337 ASCII digit (U+0030 - U+0039) and ending with the string ``.conf'' will be processed in sorted order. When
338 the XML datatype is traversed by FcConfigParse, the contents of the file(s)
339 will also be incorporated into the configuration by passing the filename(s) to
340 FcConfigLoadAndParse. If 'ignore_missing' is set to "yes" instead of the
341 default "no", a missing file or directory will elicit no warning message from
342 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.
344 <refsect2><title><literal><config></literal></title><para>
345 This element provides a place to consolidate additional configuration
346 information. <literal><config></literal> can contain <literal><blank></literal> and <literal><rescan></literal> elements in any
349 <refsect2><title><literal><description domain="fontconfig-conf"></literal></title><para>
350 This element is supposed to hold strings which describe what a config is used for.
351 This string can be translated through gettext. 'domain' needs to be set the proper name to apply then.
352 fontconfig will tries to retrieve translations with 'domain' from gettext.
354 <refsect2><title><literal><blank></literal></title><para>
355 Fonts often include "broken" glyphs which appear in the encoding but are
356 drawn as blanks on the screen. Within the <literal><blank></literal> element, place each
357 Unicode characters which is supposed to be blank in an <literal><int></literal> element.
358 Characters outside of this set which are drawn as blank will be elided from
359 the set of characters supported by the font.
361 <refsect2><title><literal><remap-dir prefix="default" as-path="" salt=""></literal></title><para>
362 This element contains a directory name where will be mapped
363 as the path 'as-path' in cached information.
364 This is useful if the directory name is an alias
365 (via a bind mount or symlink) to another directory in the system for
366 which cached font information is likely to exist.
368 'salt' property affects to determine cache filename as same as <literal><dir></literal> element.
370 <refsect2><title><literal><reset-dirs /></literal></title><para>
371 This element removes all of fonts directories where added by <literal><dir></literal> elements.
372 This is useful to override fonts directories from system to own fonts directories only.
374 <refsect2><title><literal><rescan></literal></title><para>
375 The <literal><rescan></literal> element holds an <literal><int></literal> element which indicates the default
376 interval between automatic checks for font configuration changes.
377 Fontconfig will validate all of the configuration files and directories and
378 automatically rebuild the internal datastructures when this interval passes.
380 <refsect2><title><literal><selectfont></literal></title><para>
381 This element is used to black/white list fonts from being listed or matched
382 against. It holds acceptfont and rejectfont elements.
384 <refsect2><title><literal><acceptfont></literal></title><para>
385 Fonts matched by an acceptfont element are "whitelisted"; such fonts are
386 explicitly included in the set of fonts used to resolve list and match
387 requests; including them in this list protects them from being "blacklisted"
388 by a rejectfont element. Acceptfont elements include glob and pattern
389 elements which are used to match fonts.
391 <refsect2><title><literal><rejectfont></literal></title><para>
392 Fonts matched by an rejectfont element are "blacklisted"; such fonts are
393 excluded from the set of fonts used to resolve list and match requests as if
394 they didn't exist in the system. Rejectfont elements include glob and
395 pattern elements which are used to match fonts.
397 <refsect2><title><literal><glob></literal></title><para>
398 Glob elements hold shell-style filename matching patterns (including ? and
399 *) which match fonts based on their complete pathnames. This can be used to
400 exclude a set of directories (/usr/share/fonts/uglyfont*), or particular
401 font file types (*.pcf.gz), but the latter mechanism relies rather heavily
402 on filenaming conventions which can't be relied upon. Note that globs
403 only apply to directories, not to individual fonts.
405 <refsect2><title><literal><pattern></literal></title><para>
406 Pattern elements perform list-style matching on incoming fonts; that is,
407 they hold a list of elements and associated values. If all of those
408 elements have a matching value, then the pattern matches the font. This can
409 be used to select fonts based on attributes of the font (scalable, bold,
410 etc), which is a more reliable mechanism than using file extensions.
411 Pattern elements include patelt elements.
413 <refsect2><title><literal><patelt name="property"></literal></title><para>
414 Patelt elements hold a single pattern element and list of values. They must
415 have a 'name' attribute which indicates the pattern element name. Patelt
416 elements include int, double, string, matrix, bool, charset and const
419 <refsect2><title><literal><match target="pattern"></literal></title><para>
420 This element holds first a (possibly empty) list of <literal><test></literal> elements and then
421 a (possibly empty) list of <literal><edit></literal> elements. Patterns which match all of the
422 tests are subjected to all the edits. If 'target' is set to "font" instead
423 of the default "pattern", then this element applies to the font name
424 resulting from a match rather than a font pattern to be matched. If 'target'
425 is set to "scan", then this element applies when the font is scanned to
426 build the fontconfig database.
428 <refsect2><title><literal><test qual="any" name="property" target="default" compare="eq"></literal></title><para>
429 This element contains a single value which is compared with the target
430 ('pattern', 'font', 'scan' or 'default') property "property" (substitute any of the property names seen
431 above). 'compare' can be one of "eq", "not_eq", "less", "less_eq", "more", "more_eq", "contains" or
432 "not_contains". 'qual' may either be the default, "any", in which case the match
433 succeeds if any value associated with the property matches the test value, or
434 "all", in which case all of the values associated with the property must
435 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".
436 When used in a <match target="font"> element,
437 the target= attribute in the <test> element selects between matching
438 the original pattern or the font. "default" selects whichever target the
439 outer <match> element has selected.
441 <refsect2><title><literal><edit name="property" mode="assign" binding="weak"></literal></title><para>
442 This element contains a list of expression elements (any of the value or
443 operator elements). The expression elements are evaluated at run-time and
444 modify the property "property". The modification depends on whether
445 "property" was matched by one of the associated <literal><test></literal> elements, if so, the
446 modification may affect the first matched value. Any values inserted into
447 the property are given the indicated binding ("strong", "weak" or "same")
448 with "same" binding using the value from the matched pattern element.
451 Mode With Match Without Match
452 ---------------------------------------------------------------------
453 "assign" Replace matching value Replace all values
454 "assign_replace" Replace all values Replace all values
455 "prepend" Insert before matching Insert at head of list
456 "prepend_first" Insert at head of list Insert at head of list
457 "append" Append after matching Append at end of list
458 "append_last" Append at end of list Append at end of list
459 "delete" Delete matching value Delete all values
460 "delete_all" Delete all values Delete all values
463 <refsect2><title><literal><int></literal>, <literal><double></literal>, <literal><string></literal>, <literal><bool></literal></title><para>
464 These elements hold a single value of the indicated type. <literal><bool></literal>
465 elements hold either true or false. An important limitation exists in
466 the parsing of floating point numbers -- fontconfig requires that
467 the mantissa start with a digit, not a decimal point, so insert a leading
468 zero for purely fractional values (e.g. use 0.5 instead of .5 and -0.5
471 <refsect2><title><literal><matrix></literal></title><para>
472 This element holds four numerical expressions of an affine transformation.
473 At their simplest these will be four <literal><double></literal> elements
474 but they can also be more involved expressions.
476 <refsect2><title><literal><range></literal></title><para>
477 This element holds the two <literal><int></literal> elements of a range
480 <refsect2><title><literal><charset></literal></title><para>
481 This element holds at least one <literal><int></literal> element of
482 an Unicode code point or more.
484 <refsect2><title><literal><langset></literal></title><para>
485 This element holds at least one <literal><string></literal> element of
486 a RFC-3066-style languages or more.
488 <refsect2><title><literal><name></literal></title><para>
489 Holds a property name. Evaluates to the first value from the property of
490 the pattern. If the 'target' attribute is not present, it will default to
491 'default', in which case the property is returned from the font pattern
492 during a target="font" match, and to the pattern during a target="pattern"
493 match. The attribute can also take the values 'font' or 'pattern' to
494 explicitly choose which pattern to use. It is an error to use a target
495 of 'font' in a match that has target="pattern".
497 <refsect2><title><literal><const></literal></title><para>
498 Holds the name of a constant; these are always integers and serve as
499 symbolic names for common font values:
501 Constant Property Value
502 -------------------------------------
522 ultracondensed width 50
523 extracondensed width 63
525 semicondensed width 87
527 semiexpanded width 113
529 extraexpanded width 150
530 ultraexpanded width 200
531 proportional spacing 0
542 lcddefault lcdfilter 1
544 lcdlegacy lcdfilter 3
546 hintslight hintstyle 1
547 hintmedium hintstyle 2
553 <title><literal><or></literal>, <literal><and></literal>, <literal><plus></literal>, <literal><minus></literal>, <literal><times></literal>, <literal><divide></literal></title>
555 These elements perform the specified operation on a list of expression
556 elements. <literal><or></literal> and <literal><and></literal> are boolean, not bitwise.
560 <title><literal><eq></literal>, <literal><not_eq></literal>, <literal><less></literal>, <literal><less_eq></literal>, <literal><more></literal>, <literal><more_eq></literal>, <literal><contains></literal>, <literal><not_contains</literal></title>
562 These elements compare two values, producing a boolean result.
564 <refsect2><title><literal><not></literal></title><para>
565 Inverts the boolean sense of its one expression element
567 <refsect2><title><literal><if></literal></title><para>
568 This element takes three expression elements; if the value of the first is
569 true, it produces the value of the second, otherwise it produces the value
572 <refsect2><title><literal><alias></literal></title><para>
573 Alias elements provide a shorthand notation for the set of common match
574 operations needed to substitute one font family for another. They contain a
575 <literal><family></literal> element followed by optional <literal><prefer></literal>, <literal><accept></literal> and <literal><default></literal>
576 elements. Fonts matching the <literal><family></literal> element are edited to prepend the
577 list of <literal><prefer></literal>ed families before the matching <literal><family></literal>, append the
578 <literal><accept></literal>able families after the matching <literal><family></literal> and append the <literal><default></literal>
579 families to the end of the family list.
581 <refsect2><title><literal><family></literal></title><para>
582 Holds a single font family name
584 <refsect2><title><literal><prefer></literal>, <literal><accept></literal>, <literal><default></literal></title><para>
585 These hold a list of <literal><family></literal> elements to be used by the <literal><alias></literal> element.
588 <refsect1><title>EXAMPLE CONFIGURATION FILE</title>
589 <refsect2><title>System configuration file</title>
591 This is an example of a system-wide configuration file
594 <?xml version="1.0"?>
595 <!DOCTYPE fontconfig SYSTEM "urn:fontconfig:fonts.dtd">
596 <!-- &confdir;/fonts.conf file to configure system font access -->
599 Find fonts in these directories
601 <dir>/usr/share/fonts</dir>
602 <dir>/usr/X11R6/lib/X11/fonts</dir>
605 Accept deprecated 'mono' alias, replacing it with 'monospace'
607 <match target="pattern">
608 <test qual="any" name="family"><string>mono</string></test>
609 <edit name="family" mode="assign"><string>monospace</string></edit>
613 Names not including any well known alias are given 'sans-serif'
615 <match target="pattern">
616 <test qual="all" name="family" compare="not_eq"><string>sans-serif</string></test>
617 <test qual="all" name="family" compare="not_eq"><string>serif</string></test>
618 <test qual="all" name="family" compare="not_eq"><string>monospace</string></test>
619 <edit name="family" mode="append_last"><string>sans-serif</string></edit>
623 Load per-user customization file, but don't complain
626 <include ignore_missing="yes" prefix="xdg">fontconfig/fonts.conf</include>
629 Load local customization files, but don't complain
632 <include ignore_missing="yes">conf.d</include>
633 <include ignore_missing="yes">local.conf</include>
636 Alias well known font names to available TrueType fonts.
637 These substitute TrueType faces for similar Type1
638 faces to improve screen appearance.
641 <family>Times</family>
642 <prefer><family>Times New Roman</family></prefer>
643 <default><family>serif</family></default>
646 <family>Helvetica</family>
647 <prefer><family>Arial</family></prefer>
648 <default><family>sans</family></default>
651 <family>Courier</family>
652 <prefer><family>Courier New</family></prefer>
653 <default><family>monospace</family></default>
657 Provide required aliases for standard names
658 Do these after the users configuration file so that
659 any aliases there are used preferentially
662 <family>serif</family>
663 <prefer><family>Times New Roman</family></prefer>
666 <family>sans</family>
667 <prefer><family>Arial</family></prefer>
670 <family>monospace</family>
671 <prefer><family>Andale Mono</family></prefer>
675 The example of the requirements of OR operator;
676 If the 'family' contains 'Courier New' OR 'Courier'
677 add 'monospace' as the alternative
679 <match target="pattern">
680 <test name="family" compare="eq">
681 <string>Courier New</string>
683 <edit name="family" mode="prepend">
684 <string>monospace</string>
687 <match target="pattern">
688 <test name="family" compare="eq">
689 <string>Courier</string>
691 <edit name="family" mode="prepend">
692 <string>monospace</string>
699 <refsect2><title>User configuration file</title>
701 This is an example of a per-user configuration file that lives in
702 $XDG_CONFIG_HOME/fontconfig/fonts.conf
705 <?xml version="1.0"?>
706 <!DOCTYPE fontconfig SYSTEM "urn:fontconfig:fonts.dtd">
707 <!-- $XDG_CONFIG_HOME/fontconfig/fonts.conf for per-user font configuration -->
711 Private font directory
713 <dir prefix="xdg">fonts</dir>
716 use rgb sub-pixel ordering to improve glyph appearance on
717 LCD screens. Changes affecting rendering, but not matching
718 should always use target="font".
720 <match target="font">
721 <edit name="rgba" mode="assign"><const>rgb</const></edit>
724 use WenQuanYi Zen Hei font when serif is requested for Chinese
728 If you don't want to use WenQuanYi Zen Hei font for zh-tw etc,
729 you can use zh-cn instead of zh.
730 Please note, even if you set zh-cn, it still matches zh.
731 if you don't like it, you can use compare="eq"
732 instead of compare="contains".
734 <test name="lang" compare="contains">
735 <string>zh</string>
737 <test name="family">
738 <string>serif</string>
740 <edit name="family" mode="prepend">
741 <string>WenQuanYi Zen Hei</string>
745 use VL Gothic font when sans-serif is requested for Japanese
748 <test name="lang" compare="contains">
749 <string>ja</string>
751 <test name="family">
752 <string>sans-serif</string>
754 <edit name="family" mode="prepend">
755 <string>VL Gothic</string>
762 <refsect1><title>Files</title>
764 <emphasis>fonts.conf</emphasis>
765 contains configuration information for the fontconfig library
766 consisting of directories to look at for font information as well as
767 instructions on editing program specified font patterns before attempting to
768 match the available fonts. It is in XML format.
771 <emphasis>conf.d</emphasis>
772 is the conventional name for a directory of additional configuration files
773 managed by external applications or the local administrator. The
774 filenames starting with decimal digits are sorted in lexicographic order
775 and used as additional configuration files. All of these files are in XML
776 format. The master fonts.conf file references this directory in an
777 <include> directive.
780 <emphasis>fonts.dtd</emphasis>
781 is a DTD that describes the format of the configuration files.
784 <emphasis>$XDG_CONFIG_HOME/fontconfig/conf.d</emphasis> and <emphasis>~/.fonts.conf.d</emphasis>
785 is the conventional name for a per-user directory of (typically
786 auto-generated) configuration files, although the
787 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.
790 <emphasis>$XDG_CONFIG_HOME/fontconfig/fonts.conf</emphasis> and <emphasis>~/.fonts.conf</emphasis>
791 is the conventional location for per-user font configuration, although the
792 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.
795 <emphasis>$XDG_CACHE_HOME/fontconfig/*.cache-*</emphasis> and <emphasis> ~/.fontconfig/*.cache-*</emphasis>
796 is the conventional repository of font information that isn't found in the
797 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.
800 <refsect1><title>Environment variables</title>
802 <emphasis>FONTCONFIG_FILE</emphasis>
803 is used to override the default configuration file.
806 <emphasis>FONTCONFIG_PATH</emphasis>
807 is used to override the default configuration directory.
810 <emphasis>FONTCONFIG_SYSROOT</emphasis>
811 is used to set a default sysroot directory.
814 <emphasis>FC_DEBUG</emphasis>
815 is used to output the detailed debugging messages. see <link linkend="debug">Debugging Applications</link> section for more details.
818 <emphasis>FC_DBG_MATCH_FILTER</emphasis>
819 is used to filter out the patterns. this takes a comma-separated list of object names and effects only when FC_DEBUG has MATCH2. see <link linkend="debug">Debugging Applications</link> section for more details.
822 <emphasis>FC_LANG</emphasis>
823 is used to specify the default language as the weak binding in the query. if this isn't set, the default language will be determined from current locale.
826 <emphasis>FONTCONFIG_USE_MMAP</emphasis>
827 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.
830 <emphasis>SOURCE_DATE_EPOCH</emphasis>
831 is used to ensure <literal>fc-cache(1)</literal> generates files in a deterministic manner in order to support reproducible builds. When set to a numeric representation of UNIX timestamp, fontconfig will prefer this value over using the modification timestamps of the input files in order to identify which cache files require regeneration. If <literal>SOURCE_DATE_EPOCH</literal> is not set (or is newer than the mtime of the directory), the existing behaviour is unchanged.
834 <refsect1><title>See Also</title>
836 fc-cat(1), fc-cache(1), fc-list(1), fc-match(1), fc-query(1), <ulink url="https://reproducible-builds.org/specs/source-date-epoch/">SOURCE_DATE_EPOCH</ulink>.
839 <refsect1><title>Version</title>
841 Fontconfig version &version;
projects / platform / upstream / fontconfig.git / blob