fc-cat/fc-cat.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>Patrick</firstname>">
  21   <!ENTITY dhsurname   "<surname>Lam</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>plam@mit.edu</email>">
  28   <!ENTITY dhusername  "Patrick Lam">
  29   <!ENTITY dhucpackage "<refentrytitle>fc-cat</refentrytitle>">
  30   <!ENTITY dhpackage   "fc-cat">
  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>2005</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>read font information cache files</refpurpose>
  61   </refnamediv>
  62   <refsynopsisdiv>
  63     <cmdsynopsis>
  64       <command>&dhpackage;</command>
  65
  66       <arg><option>-rvVh</option></arg>
  67       <arg><option>--recurse</option></arg>
  68       <arg><option>--verbose</option></arg>
  69       <arg><option>--version</option></arg>
  70       <arg><option>--help</option></arg>
  71       <sbr>
  72       <group rep="repeat">
  73           <arg><option><replaceable>fonts-cache-2-files</replaceable></option></arg>
  74           <arg><option><replaceable>dirs</replaceable></option></arg>
  75       </group>
  76
  77      </cmdsynopsis>
  78   </refsynopsisdiv>
  79   <refsect1>
  80     <title>DESCRIPTION</title>
  81
  82       <para><command>&dhpackage;</command> reads the font information from
  83         cache files or related to font directories
  84         and emits it in ASCII form.</para>
  85
  86   </refsect1>
  87   <refsect1>
  88     <title>OPTIONS</title>
  89
  90     <para>This program follows the usual &gnu; command line syntax,
  91       with long options starting with two dashes (`-').  A summary of
  92       options is included below.</para>
  93
  94     <variablelist>
  95       <varlistentry>
  96         <term><option>-r</option>
  97           <option>--recurse</option>
  98         </term>
  99         <listitem>
 100           <para>Recurse into subdirectories.</para>
 101         </listitem>
 102       </varlistentry>
 103       <varlistentry>
 104         <term><option>-v</option>
 105           <option>--verbose</option>
 106         </term>
 107         <listitem>
 108           <para>Be verbose.</para>
 109         </listitem>
 110       </varlistentry>
 111       <varlistentry>
 112         <term><option>-h</option>
 113           <option>--help</option>
 114         </term>
 115         <listitem>
 116           <para>Show summary of options.</para>
 117         </listitem>
 118       </varlistentry>
 119       <varlistentry>
 120         <term><option>-V</option>
 121           <option>--version</option>
 122         </term>
 123         <listitem>
 124           <para>Show version of the program and exit.</para>
 125         </listitem>
 126       </varlistentry>
 127     </variablelist>
 128   </refsect1>
 129
 130   <refsect1>
 131     <title>SEE ALSO</title>
 132
 133     <para>
 134       <command>fc-cache</command>(1)
 135       <command>fc-list</command>(1)
 136       <command>fc-match</command>(1)
 137       <command>fc-pattern</command>(1)
 138       <command>fc-query</command>(1)
 139       <command>fc-scan</command>(1)
 140     </para>
 141
 142     <para>The fontconfig user's guide, in HTML format:
 143       <filename>/usr/share/doc/fontconfig/fontconfig-user.html</filename>.</para>
 144
 145  </refsect1>
 146   <refsect1>
 147     <title>AUTHOR</title>
 148
 149     <para>This manual page was written by &dhusername; &dhemail;.</para>
 150
 151   </refsect1>
 152 </refentry>
 153
 154 <!-- Keep this comment at the end of the file
 155 Local variables:
 156 mode: sgml
 157 sgml-omittag:t
 158 sgml-shorttag:t
 159 sgml-minimize-attributes:nil
 160 sgml-always-quote-attributes:t
 161 sgml-indent-step:2
 162 sgml-indent-data:t
 163 sgml-parent-document:nil
 164 sgml-default-dtd-file:nil
 165 sgml-exposed-tags:nil
 166 sgml-local-catalogs:nil
 167 sgml-local-ecat-files:nil
 168 End:
 169 -->