/usr/share/doc/fontconfig/fontconfig-user.html is in fontconfig 2.11.0-0ubuntu4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>fonts-conf</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="AEN1"
></A
>fonts-conf</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5"
></A
><H2
>Name</H2
>fonts.conf -- Font configuration files</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN8"
></A
><H2
>Synopsis</H2
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="SYNOPSIS"
> /etc/fonts/fonts.conf
/etc/fonts/fonts.dtd
/etc/fonts/conf.d
$XDG_CONFIG_HOME/fontconfig/conf.d
$XDG_CONFIG_HOME/fontconfig/fonts.conf
~/.fonts.conf.d
~/.fonts.conf</PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN10"
></A
><H2
>Description</H2
><P
>Fontconfig is a library designed to provide system-wide font configuration,
customization and application access.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN13"
></A
><H2
>Functional Overview</H2
><P
>Fontconfig contains two essential modules, the configuration module which
builds an internal configuration from XML files and the matching module
which accepts font patterns and returns the nearest matching font.
</P
><DIV
CLASS="REFSECT2"
><A
NAME="AEN16"
></A
><H3
>Font Configuration</H3
><P
>The configuration module consists of the FcConfig datatype, libexpat and
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
changing the running configuration is to add fonts and directories to the
list of application-provided font files.
</P
><P
>The intent is to make font configurations relatively static, and shared by
as many applications as possible. It is hoped that this will lead to more
stable font selection when passing names from one application to another.
XML was chosen as a configuration file format because it provides a format
which is easy for external agents to edit while retaining the correct
structure and syntax.
</P
><P
>Font configuration is separate from font matching; applications needing to
do their own matching can access the available fonts from the library and
perform private matching. The intent is to permit applications to pick and
choose appropriate functionality from the library instead of forcing them to
choose between this library and a private configuration mechanism. The hope
is that this will ensure that configuration of fonts for all applications
can be centralized in one place. Centralizing font configuration will
simplify and regularize font installation and customization.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN21"
></A
><H3
>Font Properties</H3
><P
>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.
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> Property Type Description
--------------------------------------------------------------
family String Font family names
familylang String Languages corresponding to each family
style String Font style. Overrides weight and slant
stylelang String Languages corresponding to each style
fullname String Font full names (often includes style)
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
width Int Condensed, normal or expanded
aspect Double Stretches glyphs horizontally before hinting
pixelsize Double Pixel size
spacing Int Proportional, dual-width, monospace or charcell
foundry String Font foundry name
antialias Bool Whether glyphs can be antialiased
hinting Bool Whether the rasterizer should use hinting
hintstyle Int Automatic hinting style
verticallayout Bool Use vertical layout
autohint Bool Use autohinter instead of normal hinter
globaladvance Bool Use font global advance data (deprecated)
file String The filename holding the font
index Int The index of the font within the file
ftface FT_Face Use the specified FreeType face object
rasterizer String Which rasterizer is in use (deprecated)
outline Bool Whether the glyphs are outlines
scalable Bool Whether glyphs can be scaled
scale Double Scale factor for point->pixel conversions
dpi Double Target dots per inch
rgba Int unknown, rgb, bgr, vrgb, vbgr,
none - subpixel geometry
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
font supports
fontversion Int Version number of the font
capability String List of layout capabilities in the font
embolden Bool Rasterizer should synthetically embolden the font
fontfeatures String List of the feature tags in OpenType to be enabled
prgname String String Name of the running program
</PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN25"
></A
><H3
>Font Matching</H3
><P
>Fontconfig performs matching by measuring the distance from a provided
pattern to all of the available fonts in the system. The closest matching
font is selected. This ensures that a font will always be returned, but
doesn't ensure that it is anything like the requested pattern.
</P
><P
>
Font matching starts with an application constructed pattern. The desired
attributes of the resulting font are collected together in a pattern. Each
property of the pattern can contain one or more values; these are listed in
priority order; matches earlier in the list are considered "closer" than
matches later in the list.
</P
><P
>The initial pattern is modified by applying the list of editing instructions
specific to patterns found in the configuration; each consists of a match
predicate and a set of editing operations. They are executed in the order
they appeared in the configuration. Each match causes the associated
sequence of editing operations to be applied.
</P
><P
>After the pattern has been edited, a sequence of default substitutions are
performed to canonicalize the set of available properties; this avoids the
need for the lower layers to constantly provide default values for various
font properties during rendering.
</P
><P
>The canonical font pattern is finally matched against all available fonts.
The distance from the pattern to the font is measured for each of several
properties: foundry, charset, family, lang, spacing, pixelsize, style,
slant, weight, antialias, rasterizer and outline. This list is in priority
order -- results of comparing earlier elements of this list weigh more
heavily than later elements.
</P
><P
>There is one special case to this rule; family names are split into two
bindings; strong and weak. Strong family names are given greater precedence
in the match than lang elements while weak family names are given lower
precedence than lang elements. This permits the document language to drive
font selection when any document specified font is unavailable.
</P
><P
>The pattern representing that font is augmented to include any properties
found in the pattern but not found in the font itself; this permits the
application to pass rendering instructions or any other data through the
matching system. Finally, the list of editing instructions specific to
fonts found in the configuration are applied to the pattern. This modified
pattern is returned to the application.
</P
><P
>The return value contains sufficient information to locate and rasterize the
font, including the file name, pixel size and other rendering data. As
none of the information involved pertains to the FreeType library,
applications are free to use any rasterization engine or even to take
the identified font file and access it directly.
</P
><P
>The match/edit sequences in the configuration are performed in two passes
because there are essentially two different operations necessary -- the
first is to modify how fonts are selected; aliasing families and adding
suitable defaults. The second is to modify how the selected fonts are
rasterized. Those must apply to the selected font, not the original pattern
as false matches will often occur.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN36"
></A
><H3
>Font Names</H3
><P
>Fontconfig provides a textual representation for patterns that the library
can both accept and generate. The representation is in three parts, first a
list of family names, second a list of point sizes and finally a list of
additional properties:
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> <families>-<point sizes>:<name1>=<values1>:<name2>=<values2>...
</PRE
></TD
></TR
></TABLE
><P
>Values in a list are separated with commas. The name needn't include either
families or point sizes; they can be elided. In addition, there are
symbolic constants that simultaneously indicate both a name and a value.
Here are some examples:
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> Name Meaning
----------------------------------------------------------
Times-12 12 point Times Roman
Times-12:bold 12 point Times Bold
Courier:italic Courier Italic in the default size
Monospace:matrix=1 .1 0 1 The users preferred monospace font
with artificial obliquing
</PRE
></TD
></TR
></TABLE
><P
>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.
</P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="DEBUG"
></A
><H2
>Debugging Applications</H2
><P
>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.
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="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
</PRE
></TD
></TR
></TABLE
><P
>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.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN48"
></A
><H2
>Lang Tags</H2
><P
>Each font in the database contains a list of languages it supports. This is
computed by comparing the Unicode coverage of the font with the orthography
of each language. Languages are tagged using an RFC-3066 compatible naming
and occur in two parts -- the ISO 639 language tag followed a hyphen and then
by the ISO 3166 country code. The hyphen and country code may be elided.
</P
><P
>Fontconfig has orthographies for several languages built into the library.
No provision has been made for adding new ones aside from rebuilding the
library. It currently supports 122 of the 139 languages named in ISO 639-1,
141 of the languages with two-letter codes from ISO 639-2 and another 30
languages with only three-letter codes. Languages with both two and three
letter codes are provided with only the two letter code.
</P
><P
>For languages used in multiple territories with radically different
character sets, fontconfig includes per-territory orthographies. This
includes Azerbaijani, Kurdish, Pashto, Tigrinya and Chinese.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN53"
></A
><H2
>Configuration File Format</H2
><P
>Configuration files for fontconfig are stored in XML format; this
format makes external configuration tools easier to write and ensures that
they will generate syntactically correct configuration files. As XML
files are plain text, they can also be manipulated by the expert user using
a text editor.
</P
><P
>The fontconfig document type definition resides in the external entity
"fonts.dtd"; this is normally stored in the default font configuration
directory (/etc/fonts). Each configuration file should contain the
following structure:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> <?xml version="1.0"?>
<!DOCTYPE fontconfig SYSTEM "fonts.dtd">
<fontconfig>
...
</fontconfig>
</PRE
></TD
></TR
></TABLE
>
</P
><DIV
CLASS="REFSECT2"
><A
NAME="AEN58"
></A
><H3
><TT
CLASS="LITERAL"
><fontconfig></TT
></H3
><P
>This is the top level element for a font configuration and can contain
<TT
CLASS="LITERAL"
><dir></TT
>, <TT
CLASS="LITERAL"
><cachedir></TT
>, <TT
CLASS="LITERAL"
><include></TT
>, <TT
CLASS="LITERAL"
><match></TT
> and <TT
CLASS="LITERAL"
><alias></TT
> elements in any order.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN67"
></A
><H3
><TT
CLASS="LITERAL"
><dir prefix="default"></TT
></H3
><P
>This element contains a directory name which will be scanned for font files
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.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN71"
></A
><H3
><TT
CLASS="LITERAL"
><cachedir prefix="default"></TT
></H3
><P
>This element contains a directory name that is supposed to be stored or read
the cache of font information. If multiple elements are specified in
the configuration file, the directory that can be accessed first in the list
will be used to store the cache files. If it starts with '~', it refers to
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.
The default directory is ``$XDG_CACHE_HOME/fontconfig'' and it contains the cache files
named ``<TT
CLASS="LITERAL"
><hash value></TT
>-<TT
CLASS="LITERAL"
><architecture></TT
>.cache-<TT
CLASS="LITERAL"
><version</TT
>'',
where <TT
CLASS="LITERAL"
><version></TT
> is the font configureation file
version number (currently 3).
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN79"
></A
><H3
><TT
CLASS="LITERAL"
><include ignore_missing="no" prefix="default"></TT
></H3
><P
>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
the XML datatype is traversed by FcConfigParse, the contents of the file(s)
will also be incorporated into the configuration by passing the filename(s) to
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. 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.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN83"
></A
><H3
><TT
CLASS="LITERAL"
><config></TT
></H3
><P
>This element provides a place to consolidate additional configuration
information. <TT
CLASS="LITERAL"
><config></TT
> can contain <TT
CLASS="LITERAL"
><blank></TT
> and <TT
CLASS="LITERAL"
><rescan></TT
> elements in any
order.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN90"
></A
><H3
><TT
CLASS="LITERAL"
><blank></TT
></H3
><P
>Fonts often include "broken" glyphs which appear in the encoding but are
drawn as blanks on the screen. Within the <TT
CLASS="LITERAL"
><blank></TT
> element, place each
Unicode characters which is supposed to be blank in an <TT
CLASS="LITERAL"
><int></TT
> element.
Characters outside of this set which are drawn as blank will be elided from
the set of characters supported by the font.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN96"
></A
><H3
><TT
CLASS="LITERAL"
><rescan></TT
></H3
><P
>The <TT
CLASS="LITERAL"
><rescan></TT
> element holds an <TT
CLASS="LITERAL"
><int></TT
> 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.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN102"
></A
><H3
><TT
CLASS="LITERAL"
><selectfont></TT
></H3
><P
>This element is used to black/white list fonts from being listed or matched
against. It holds acceptfont and rejectfont elements.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN106"
></A
><H3
><TT
CLASS="LITERAL"
><acceptfont></TT
></H3
><P
>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.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN110"
></A
><H3
><TT
CLASS="LITERAL"
><rejectfont></TT
></H3
><P
>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.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN114"
></A
><H3
><TT
CLASS="LITERAL"
><glob></TT
></H3
><P
>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. Note that globs
only apply to directories, not to individual fonts.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN118"
></A
><H3
><TT
CLASS="LITERAL"
><pattern></TT
></H3
><P
>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
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.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN122"
></A
><H3
><TT
CLASS="LITERAL"
><patelt name="property"></TT
></H3
><P
>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.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN126"
></A
><H3
><TT
CLASS="LITERAL"
><match target="pattern"></TT
></H3
><P
>This element holds first a (possibly empty) list of <TT
CLASS="LITERAL"
><test></TT
> elements and then
a (possibly empty) list of <TT
CLASS="LITERAL"
><edit></TT
> 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. If 'target'
is set to "scan", then this element applies when the font is scanned to
build the fontconfig database.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN132"
></A
><H3
><TT
CLASS="LITERAL"
><test qual="any" name="property" target="default" compare="eq"></TT
></H3
><P
>This element contains a single value which is compared with the target
('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", "more_eq", "contains" or
"not_contains". '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
"all", in which case all of the values associated with the property must
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".
When used in a <match target="font"> element,
the target= attribute in the <test> element selects between matching
the original pattern or the font. "default" selects whichever target the
outer <match> element has selected.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN136"
></A
><H3
><TT
CLASS="LITERAL"
><edit name="property" mode="assign" binding="weak"></TT
></H3
><P
>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 <TT
CLASS="LITERAL"
><test></TT
> 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.
'mode' is one of:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> Mode With Match Without Match
---------------------------------------------------------------------
"assign" Replace matching value Replace all values
"assign_replace" Replace all values Replace all values
"prepend" Insert before matching Insert at head of list
"prepend_first" Insert at head of list Insert at head of list
"append" Append after matching Append at end of list
"append_last" Append at end of list Append at end of list
"delete" Delete matching value Delete all values
"delete_all" Delete all values Delete all values
</PRE
></TD
></TR
></TABLE
>
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN142"
></A
><H3
><TT
CLASS="LITERAL"
><int></TT
>, <TT
CLASS="LITERAL"
><double></TT
>, <TT
CLASS="LITERAL"
><string></TT
>, <TT
CLASS="LITERAL"
><bool></TT
></H3
><P
>These elements hold a single value of the indicated type. <TT
CLASS="LITERAL"
><bool></TT
>
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).
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN150"
></A
><H3
><TT
CLASS="LITERAL"
><matrix></TT
></H3
><P
>This element holds four numerical expressions of an affine transformation.
At their simplest these will be four <TT
CLASS="LITERAL"
><double></TT
> elements
but they can also be more involved expressions.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN155"
></A
><H3
><TT
CLASS="LITERAL"
><range></TT
></H3
><P
>This element holds the two <TT
CLASS="LITERAL"
><int></TT
> elements of a range
representation.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN160"
></A
><H3
><TT
CLASS="LITERAL"
><charset></TT
></H3
><P
>This element holds at least one <TT
CLASS="LITERAL"
><int></TT
> element of
an Unicode code point or more.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN165"
></A
><H3
><TT
CLASS="LITERAL"
><langset></TT
></H3
><P
>This element holds at least one <TT
CLASS="LITERAL"
><string></TT
> element of
a RFC-3066-style languages or more.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN170"
></A
><H3
><TT
CLASS="LITERAL"
><name></TT
></H3
><P
>Holds a property name. Evaluates to the first value from the property of
the pattern. If the 'target' attribute is not present, it will default to
'default', in which case the property is returned from the font pattern
during a target="font" match, and to the pattern during a target="pattern"
match. The attribute can also take the values 'font' or 'pattern' to
explicitly choose which pattern to use. It is an error to use a target
of 'font' in a match that has target="pattern".
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN174"
></A
><H3
><TT
CLASS="LITERAL"
><const></TT
></H3
><P
>Holds the name of a constant; these are always integers and serve as
symbolic names for common font values:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> Constant Property Value
-------------------------------------
thin weight 0
extralight weight 40
ultralight weight 40
light weight 50
book weight 75
regular weight 80
normal weight 80
medium weight 100
demibold weight 180
semibold weight 180
bold weight 200
extrabold weight 205
black weight 210
heavy weight 210
roman slant 0
italic slant 100
oblique slant 110
ultracondensed width 50
extracondensed width 63
condensed width 75
semicondensed width 87
normal width 100
semiexpanded width 113
expanded width 125
extraexpanded width 150
ultraexpanded width 200
proportional spacing 0
dual spacing 90
mono spacing 100
charcell spacing 110
unknown rgba 0
rgb rgba 1
bgr rgba 2
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
hintfull hintstyle 3
</PRE
></TD
></TR
></TABLE
>
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN179"
></A
><H3
><TT
CLASS="LITERAL"
><or></TT
>, <TT
CLASS="LITERAL"
><and></TT
>, <TT
CLASS="LITERAL"
><plus></TT
>, <TT
CLASS="LITERAL"
><minus></TT
>, <TT
CLASS="LITERAL"
><times></TT
>, <TT
CLASS="LITERAL"
><divide></TT
></H3
><P
>These elements perform the specified operation on a list of expression
elements. <TT
CLASS="LITERAL"
><or></TT
> and <TT
CLASS="LITERAL"
><and></TT
> are boolean, not bitwise.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN190"
></A
><H3
><TT
CLASS="LITERAL"
><eq></TT
>, <TT
CLASS="LITERAL"
><not_eq></TT
>, <TT
CLASS="LITERAL"
><less></TT
>, <TT
CLASS="LITERAL"
><less_eq></TT
>, <TT
CLASS="LITERAL"
><more></TT
>, <TT
CLASS="LITERAL"
><more_eq></TT
>, <TT
CLASS="LITERAL"
><contains></TT
>, <TT
CLASS="LITERAL"
><not_contains</TT
></H3
><P
>These elements compare two values, producing a boolean result.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN201"
></A
><H3
><TT
CLASS="LITERAL"
><not></TT
></H3
><P
>Inverts the boolean sense of its one expression element
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN205"
></A
><H3
><TT
CLASS="LITERAL"
><if></TT
></H3
><P
>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.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN209"
></A
><H3
><TT
CLASS="LITERAL"
><alias></TT
></H3
><P
>Alias elements provide a shorthand notation for the set of common match
operations needed to substitute one font family for another. They contain a
<TT
CLASS="LITERAL"
><family></TT
> element followed by optional <TT
CLASS="LITERAL"
><prefer></TT
>, <TT
CLASS="LITERAL"
><accept></TT
> and <TT
CLASS="LITERAL"
><default></TT
>
elements. Fonts matching the <TT
CLASS="LITERAL"
><family></TT
> element are edited to prepend the
list of <TT
CLASS="LITERAL"
><prefer></TT
>ed families before the matching <TT
CLASS="LITERAL"
><family></TT
>, append the
<TT
CLASS="LITERAL"
><accept></TT
>able families after the matching <TT
CLASS="LITERAL"
><family></TT
> and append the <TT
CLASS="LITERAL"
><default></TT
>
families to the end of the family list.
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN223"
></A
><H3
><TT
CLASS="LITERAL"
><family></TT
></H3
><P
>Holds a single font family name
</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN227"
></A
><H3
><TT
CLASS="LITERAL"
><prefer></TT
>, <TT
CLASS="LITERAL"
><accept></TT
>, <TT
CLASS="LITERAL"
><default></TT
></H3
><P
>These hold a list of <TT
CLASS="LITERAL"
><family></TT
> elements to be used by the <TT
CLASS="LITERAL"
><alias></TT
> element.
</P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN235"
></A
><H2
>EXAMPLE CONFIGURATION FILE</H2
><DIV
CLASS="REFSECT2"
><A
NAME="AEN237"
></A
><H3
>System configuration file</H3
><P
>This is an example of a system-wide configuration file
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><?xml version="1.0"?>
<!DOCTYPE fontconfig SYSTEM "fonts.dtd">
<!-- /etc/fonts/fonts.conf file to configure system font access -->
<fontconfig>
<!--
Find fonts in these directories
-->
<dir>/usr/share/fonts</dir>
<dir>/usr/X11R6/lib/X11/fonts</dir>
<!--
Accept deprecated 'mono' alias, replacing it with 'monospace'
-->
<match target="pattern">
<test qual="any" name="family"><string>mono</string></test>
<edit name="family" mode="assign"><string>monospace</string></edit>
</match>
<!--
Names not including any well known alias are given 'sans-serif'
-->
<match target="pattern">
<test qual="all" name="family" mode="not_eq"><string>sans-serif</string></test>
<test qual="all" name="family" mode="not_eq"><string>serif</string></test>
<test qual="all" name="family" mode="not_eq"><string>monospace</string></test>
<edit name="family" mode="append_last"><string>sans-serif</string></edit>
</match>
<!--
Load per-user customization file, but don't complain
if it doesn't exist
-->
<include ignore_missing="yes" prefix="xdg">fontconfig/fonts.conf</include>
<!--
Load local customization files, but don't complain
if there aren't any
-->
<include ignore_missing="yes">conf.d</include>
<include ignore_missing="yes">local.conf</include>
<!--
Alias well known font names to available TrueType fonts.
These substitute TrueType faces for similar Type1
faces to improve screen appearance.
-->
<alias>
<family>Times</family>
<prefer><family>Times New Roman</family></prefer>
<default><family>serif</family></default>
</alias>
<alias>
<family>Helvetica</family>
<prefer><family>Arial</family></prefer>
<default><family>sans</family></default>
</alias>
<alias>
<family>Courier</family>
<prefer><family>Courier New</family></prefer>
<default><family>monospace</family></default>
</alias>
<!--
Provide required aliases for standard names
Do these after the users configuration file so that
any aliases there are used preferentially
-->
<alias>
<family>serif</family>
<prefer><family>Times New Roman</family></prefer>
</alias>
<alias>
<family>sans</family>
<prefer><family>Arial</family></prefer>
</alias>
<alias>
<family>monospace</family>
<prefer><family>Andale Mono</family></prefer>
</alias>
<--
The example of the requirements of OR operator;
If the 'family' contains 'Courier New' OR 'Courier'
add 'monospace' as the alternative
-->
<match target="pattern">
<test name="family" mode="eq">
<string>Courier New</string>
</test>
<edit name="family" mode="prepend">
<string>monospace</string>
</edit>
</match>
<match target="pattern">
<test name="family" mode="eq">
<string>Courier</string>
</test>
<edit name="family" mode="prepend">
<string>monospace</string>
</edit>
</match>
</fontconfig>
</PRE
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN241"
></A
><H3
>User configuration file</H3
><P
>This is an example of a per-user configuration file that lives in
$XDG_CONFIG_HOME/fontconfig/fonts.conf
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
><?xml version="1.0"?>
<!DOCTYPE fontconfig SYSTEM "fonts.dtd">
<!-- $XDG_CONFIG_HOME/fontconfig/fonts.conf for per-user font configuration -->
<fontconfig>
<!--
Private font directory
-->
<dir prefix="xdg">fonts</dir>
<!--
use rgb sub-pixel ordering to improve glyph appearance on
LCD screens. Changes affecting rendering, but not matching
should always use target="font".
-->
<match target="font">
<edit name="rgba" mode="assign"><const>rgb</const></edit>
</match>
<!--
use WenQuanYi Zen Hei font when serif is requested for Chinese
-->
<match>
<!--
If you don't want to use WenQuanYi Zen Hei font for zh-tw etc,
you can use zh-cn instead of zh.
Please note, even if you set zh-cn, it still matches zh.
if you don't like it, you can use compare="eq"
instead of compare="contains".
-->
<test name="lang" compare="contains">
<string>zh</string>
</test>
<test name="family">
<string>serif</string>
</test>
<edit name="family" mode="prepend">
<string>WenQuanYi Zen Hei</string>
</edit>
</match>
<!--
use VL Gothic font when sans-serif is requested for Japanese
-->
<match>
<test name="lang" compare="contains">
<string>ja</string>
</test>
<test name="family">
<string>sans-serif</string>
</test>
<edit name="family" mode="prepend">
<string>VL Gothic</string>
</edit>
</match>
</fontconfig>
</PRE
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN245"
></A
><H2
>Files</H2
><P
><I
CLASS="EMPHASIS"
>fonts.conf</I
>
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.
</P
><P
><I
CLASS="EMPHASIS"
>conf.d</I
>
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
format. The master fonts.conf file references this directory in an
<include> directive.
</P
><P
><I
CLASS="EMPHASIS"
>fonts.dtd</I
>
is a DTD that describes the format of the configuration files.
</P
><P
><I
CLASS="EMPHASIS"
>$XDG_CONFIG_HOME/fontconfig/conf.d</I
> and <I
CLASS="EMPHASIS"
>~/.fonts.conf.d</I
>
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. please note that ~/.fonts.conf.d is deprecated now. it will not be read by default in the future version.
</P
><P
><I
CLASS="EMPHASIS"
>$XDG_CONFIG_HOME/fontconfig/fonts.conf</I
> and <I
CLASS="EMPHASIS"
>~/.fonts.conf</I
>
is the conventional location for per-user font configuration, although the
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.
</P
><P
><I
CLASS="EMPHASIS"
>$XDG_CACHE_HOME/fontconfig/*.cache-*</I
> and <I
CLASS="EMPHASIS"
> ~/.fontconfig/*.cache-*</I
>
is the conventional repository of font information that isn't found in the
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.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN262"
></A
><H2
>Environment variables</H2
><P
><I
CLASS="EMPHASIS"
>FONTCONFIG_FILE</I
>
is used to override the default configuration file.
</P
><P
><I
CLASS="EMPHASIS"
>FONTCONFIG_PATH</I
>
is used to override the default configuration directory.
</P
><P
><I
CLASS="EMPHASIS"
>FC_DEBUG</I
>
is used to output the detailed debugging messages. see <A
HREF="#DEBUG"
>Debugging Applications</A
> section for more details.
</P
><P
><I
CLASS="EMPHASIS"
>FONTCONFIG_USE_MMAP</I
>
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.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN273"
></A
><H2
>See Also</H2
><P
>fc-cat(1), fc-cache(1), fc-list(1), fc-match(1), fc-query(1)
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN276"
></A
><H2
>Version</H2
><P
>Fontconfig version 2.11.0
</P
></DIV
></BODY
></HTML
>
|