fc-cache.sgml revision 2c393a42 
1<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
3<!-- Process this file with docbook-to-man to generate an nroff manual
4     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
5     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
6     less'.  A typical entry in a Makefile or Makefile.am is:
7
8manpage.1: manpage.sgml
9	docbook-to-man $< > $@
10
11    
12	The docbook-to-man binary is found in the docbook-to-man package.
13	Please remember that if you create the nroff version in one of the
14	debian/rules file targets (such as build), you will need to include
15	docbook-to-man in your Build-Depends control field.
16
17  -->
18
19  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
20  <!ENTITY dhfirstname "<firstname>Josselin</firstname>">
21  <!ENTITY dhsurname   "<surname>Mouette</surname>">
22  <!-- Please adjust the date whenever revising the manpage. -->
23  <!ENTITY dhdate      "<date>Sep 22, 2005</date>">
24  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
25       allowed: see man(7), man(1). -->
26  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
27  <!ENTITY dhemail     "<email>joss@debian.org</email>">
28  <!ENTITY dhusername  "Josselin Mouette">
29  <!ENTITY dhucpackage "<refentrytitle>fc-cache</refentrytitle>">
30  <!ENTITY dhpackage   "fc-cache">
31
32  <!ENTITY debian      "<productname>Debian</productname>">
33  <!ENTITY gnu         "<acronym>GNU</acronym>">
34  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
35]>
36
37<refentry>
38  <refentryinfo>
39    <address>
40      &dhemail;
41    </address>
42    <author>
43      &dhfirstname;
44      &dhsurname;
45    </author>
46    <copyright>
47      <year>2003</year>
48      <holder>&dhusername;</holder>
49    </copyright>
50    &dhdate;
51  </refentryinfo>
52  <refmeta>
53    &dhucpackage;
54
55    &dhsection;
56  </refmeta>
57  <refnamediv>
58    <refname>&dhpackage;</refname>
59
60    <refpurpose>build font information cache files</refpurpose>
61  </refnamediv>
62  <refsynopsisdiv>
63    <cmdsynopsis>
64      <command>&dhpackage;</command>
65
66      <arg><option>-fsvV?</option></arg>
67      <arg><option>--force</option></arg>
68      <arg><option>--system-only</option></arg>
69      <arg><option>--verbose</option></arg>
70      <arg><option>--version</option></arg>
71      <arg><option>--help</option></arg>
72      <arg><option><replaceable>dirs</replaceable></option></arg>
73      
74     </cmdsynopsis>
75  </refsynopsisdiv>
76  <refsect1>
77    <title>DESCRIPTION</title>
78
79      <para><command>&dhpackage;</command> scans the font directories on
80        the system and builds font information cache files for
81        applications using fontconfig for their font handling.</para>
82
83      <para>If directory arguments are not given,
84        <command>&dhpackage;</command> uses each directory in the
85        current font configuration. Each directory is scanned for
86        font files readable by FreeType.  A cache is created which
87        contains properties of each font and the associated filename.
88        This cache is used to speed up application startup when using
89        the fontconfig library.</para>
90
91      <para>Note that <command>&dhpackage;</command> must be executed
92        once per architecture to generate font information customized
93        for that architecture.  On a subsequent run,
94        <command>&dhpackage;</command> will augment the cache
95        information files with the information for the new
96        architecture. </para>
97
98  </refsect1>
99  <refsect1>
100    <title>OPTIONS</title>
101
102    <para>This program follows the usual &gnu; command line syntax,
103      with long options starting with two dashes (`-').  A summary of
104      options is included below.</para>
105
106    <variablelist>
107      <varlistentry>
108        <term><option>-f</option>
109          <option>--force</option>
110        </term>
111        <listitem>
112          <para>Force re-generation of apparently up-to-date cache files,
113            overriding the timestamp checking.</para>
114        </listitem>
115      </varlistentry>
116      <varlistentry>
117        <term><option>-s</option>
118          <option>--system-only</option>
119        </term>
120        <listitem>
121          <para>Only scan system-wide directories, omitting the places
122            located in the user's home directory.</para>
123        </listitem>
124      </varlistentry>
125      <varlistentry>
126        <term><option>-v</option>
127          <option>--verbose</option>
128        </term>
129        <listitem>
130          <para>Display status information while busy.</para>
131        </listitem>
132      </varlistentry>
133      <varlistentry>
134        <term><option>-?</option>
135          <option>--help</option>
136        </term>
137        <listitem>
138          <para>Show summary of options.</para>
139        </listitem>
140      </varlistentry>
141      <varlistentry>
142        <term><option>-V</option>
143          <option>--version</option>
144        </term>
145        <listitem>
146          <para>Show version of the program and exit.</para>
147        </listitem>
148      </varlistentry>
149      <varlistentry>
150        <term><option><replaceable>dirs</replaceable></option>
151        </term>
152        <listitem>
153          <para>A list of directories to scan for fonts.</para>
154        </listitem>
155      </varlistentry>
156    </variablelist>
157  </refsect1>
158
159  <refsect1>
160    <title>FILES</title>
161    <variablelist>
162      <varlistentry>
163        <term><filename>fonts.cache-2</filename></term>
164	<listitem>
165	  <para>These files are generated by <command>&dhpackage;</command>
166            and contain maps from file names to font properties. They are
167            read by the fontconfig library at application startup to locate
168            appropriate fonts.</para>
169	</listitem>
170      </varlistentry>
171    </variablelist>
172  </refsect1>
173
174  <refsect1>
175    <title>SEE ALSO</title>
176
177    <para><command>fc-list</command> (1).</para>
178
179    <para>The fontconfig user's guide, in HTML format:
180      <filename>/usr/share/doc/fontconfig/fontconfig-user.html</filename>.</para>
181
182 </refsect1>
183  <refsect1>
184    <title>AUTHOR</title>
185
186    <para>This manual page was written by Keith Packard
187      <email>keithp@keithp.com</email> and &dhusername; &dhemail;.</para>
188
189  </refsect1>
190</refentry>
191
192<!-- Keep this comment at the end of the file
193Local variables:
194mode: sgml
195sgml-omittag:t
196sgml-shorttag:t
197sgml-minimize-attributes:nil
198sgml-always-quote-attributes:t
199sgml-indent-step:2
200sgml-indent-data:t
201sgml-parent-document:nil
202sgml-default-dtd-file:nil
203sgml-exposed-tags:nil
204sgml-local-catalogs:nil
205sgml-local-ecat-files:nil
206End:
207-->
208