fc-cache.sgml revision ca08ab68 
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>Aug 13, 2008</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>-frsvVh</option></arg>
67      <arg><option>--force</option></arg>
68      <arg><option>--really-force</option></arg>
69      <arg><option>--system-only</option></arg>
70      <arg><option>--verbose</option></arg>
71      <arg><option>--version</option></arg>
72      <arg><option>--help</option></arg>
73      <arg rep="repeat"><option><replaceable>dir</replaceable></option></arg>
74      
75     </cmdsynopsis>
76  </refsynopsisdiv>
77  <refsect1>
78    <title>DESCRIPTION</title>
79
80      <para><command>&dhpackage;</command> scans the font directories on
81        the system and builds font information cache files for
82        applications using fontconfig for their font handling.</para>
83
84      <para>If directory arguments are not given,
85        <command>&dhpackage;</command> uses each directory in the
86        current font configuration. Each directory is scanned for
87        font files readable by FreeType.  A cache is created which
88        contains properties of each font and the associated filename.
89        This cache is used to speed up application startup when using
90        the fontconfig library.</para>
91
92      <para>Note that <command>&dhpackage;</command> must be executed
93        once per architecture to generate font information customized
94        for that architecture.</para>
95
96  </refsect1>
97  <refsect1>
98    <title>OPTIONS</title>
99
100    <para>This program follows the usual &gnu; command line syntax,
101      with long options starting with two dashes (`-').  A summary of
102      options is included below.</para>
103
104    <variablelist>
105      <varlistentry>
106        <term><option>-f</option>
107          <option>--force</option>
108        </term>
109        <listitem>
110          <para>Force re-generation of apparently up-to-date cache files,
111            overriding the timestamp checking.</para>
112        </listitem>
113      </varlistentry>
114      <varlistentry>
115        <term><option>-r</option>
116          <option>--really-force</option>
117        </term>
118        <listitem>
119          <para>Erase all existing cache files and rescan.</para>
120        </listitem>
121      </varlistentry>
122      <varlistentry>
123        <term><option>-s</option>
124          <option>--system-only</option>
125        </term>
126        <listitem>
127          <para>Only scan system-wide directories, omitting the places
128            located in the user's home directory.</para>
129        </listitem>
130      </varlistentry>
131      <varlistentry>
132        <term><option>-v</option>
133          <option>--verbose</option>
134        </term>
135        <listitem>
136          <para>Display status information while busy.</para>
137        </listitem>
138      </varlistentry>
139      <varlistentry>
140        <term><option>-h</option>
141          <option>--help</option>
142        </term>
143        <listitem>
144          <para>Show summary of options.</para>
145        </listitem>
146      </varlistentry>
147      <varlistentry>
148        <term><option>-V</option>
149          <option>--version</option>
150        </term>
151        <listitem>
152          <para>Show version of the program and exit.</para>
153        </listitem>
154      </varlistentry>
155      <varlistentry>
156        <term><option><replaceable>dir</replaceable></option>
157        </term>
158        <listitem>
159          <para>Directory to scan for fonts.</para>
160        </listitem>
161      </varlistentry>
162    </variablelist>
163  </refsect1>
164
165  <refsect1>
166    <title>FILES</title>
167    <variablelist>
168      <varlistentry>
169        <term><filename><replaceable>%cachdir%</replaceable>/*-<replaceable>%arch%</replaceable>.cache-2</filename></term>
170	<listitem>
171	  <para>These files are generated by <command>&dhpackage;</command>
172            and contain maps from file names to font properties. They are
173            read by the fontconfig library at application startup to locate
174            appropriate fonts.</para>
175	</listitem>
176      </varlistentry>
177    </variablelist>
178  </refsect1>
179
180  <refsect1>
181    <title>SEE ALSO</title>
182
183    <para>
184      <command>fc-cat</command>(1)
185      <command>fc-list</command>(1)
186      <command>fc-match</command>(1)
187      <command>fc-pattern</command>(1)
188      <command>fc-query</command>(1)
189      <command>fc-scan</command>(1)
190    </para>
191
192    <para>The fontconfig user's guide, in HTML format:
193      <filename>/usr/share/doc/fontconfig/fontconfig-user.html</filename>.</para>
194
195 </refsect1>
196  <refsect1>
197    <title>AUTHOR</title>
198
199    <para>This manual page was written by Keith Packard
200      <email>keithp@keithp.com</email> and &dhusername; &dhemail;.</para>
201
202  </refsect1>
203</refentry>
204
205<!-- Keep this comment at the end of the file
206Local variables:
207mode: sgml
208sgml-omittag:t
209sgml-shorttag:t
210sgml-minimize-attributes:nil
211sgml-always-quote-attributes:t
212sgml-indent-step:2
213sgml-indent-data:t
214sgml-parent-document:nil
215sgml-default-dtd-file:nil
216sgml-exposed-tags:nil
217sgml-local-catalogs:nil
218sgml-local-ecat-files:nil
219End:
220-->
221