diff options
authorKeith Packard <>2006-09-01 22:04:52 -0700
committerKeith Packard <>2006-09-01 22:04:52 -0700
commit5cafbd4da08aa8110a94deba59dc631c39ef7285 (patch)
parent7295c6f5faa595422e0825aa2e91883147d5b50e (diff)
Document FC_DEBUG values (bug 6393). Document name \ escape syntax.
Limited FC_DEBUG documentation (just shows values and vague idea of what they're related to). Also document \ escape syntax for font names, including how family name and values have different escape requirements.
1 files changed, 38 insertions, 2 deletions
diff --git a/doc/fontconfig-user.sgml b/doc/fontconfig-user.sgml
index 6c2a446..32a637c 100644
--- a/doc/fontconfig-user.sgml
+++ b/doc/fontconfig-user.sgml
@@ -3,8 +3,6 @@
<!ENTITY confdir SYSTEM "confdir.sgml">
- $Id$
Copyright © 2003 Keith Packard
Permission to use, copy, modify, distribute, and sell this software and its
@@ -215,8 +213,46 @@ Here are some examples:
Monospace:matrix=1 .1 0 1 The users preferred monospace font
with artificial obliquing
+ <para>
+The '\', '-', ':' and ',' characters in family names must be preceeded by a
+'\' character to avoid having them misinterpreted. Similarly, values
+containing '\', '=', '_', ':' and ',' must also have them preceeded by a
+'\' character. The '\' characters are stripped out of the family name and
+values as the font name is read.
+ </para>
+<refsect1><title>Debugging Applications</title>
+ <para>
+To help diagnose font and applications problems, fontconfig is built with a
+large amount of internal debugging left enabled. It is controlled by means
+of the FC_DEBUG environment variable. The value of this variable is
+interpreted as a number, and each bit within that value controls different
+debugging messages.
+ </para>
+ <programlisting>
+ Name Value Meaning
+ ---------------------------------------------------------
+ MATCH 1 Brief information about font matching
+ MATCHV 2 Extensive font matching information
+ EDIT 4 Monitor match/test/edit execution
+ FONTSET 8 Track loading of font information at startup
+ CACHE 16 Watch cache files being written
+ CACHEV 32 Extensive cache file writing information
+ PARSE 64 (no longer in use)
+ SCAN 128 Watch font files being scanned to build caches
+ SCANV 256 Verbose font file scanning information
+ MEMORY 512 Monitor fontconfig memory usage
+ CONFIG 1024 Monitor which config files are loaded
+ LANGSET 2048 Dump char sets used to construct lang values
+ OBJTYPES 4096 Display message when value typechecks fail
+ </programlisting>
+ <para>
+Add the value of the desired debug levels together and assign that (in
+base 10) to the FC_DEBUG environment variable before running the
+application. Output from these statements is sent to stdout.
+ </para>
<refsect1><title>Lang Tags</title>
Each font in the database contains a list of languages it supports. This is