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