fc-cache/fc-cache.sgml

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