fc-cat/fc-cat.sgml

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2
   3 <!--
   4 Copyright © 2008 Patrick Lam
   5
   6 Permission to use, copy, modify, distribute, and sell this software and its
   7 documentation for any purpose is hereby granted without fee, provided that
   8 the above copyright notice appear in all copies and that both that
   9 copyright notice and this permission notice appear in supporting
  10 documentation, and that the name of the author(s) not be used in
  11 advertising or publicity pertaining to distribution of the software without
  12 specific, written prior permission.  The authors make no
  13 representations about the suitability of this software for any purpose.  It
  14 is provided "as is" without express or implied warranty.
  15
  16 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  17 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  18 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  19 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  20 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  21 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  22 PERFORMANCE OF THIS SOFTWARE.
  23 -->
  24
  25 <!-- Process this file with docbook-to-man to generate an nroff manual
  26      page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
  27      the manual page with: `docbook-to-man manpage.sgml | nroff -man |
  28      less'.  A typical entry in a Makefile or Makefile.am is:
  29
  30 manpage.1: manpage.sgml
  31         docbook-to-man $< > $@
  32
  33
  34         The docbook-to-man binary is found in the docbook-to-man package.
  35         Please remember that if you create the nroff version in one of the
  36         debian/rules file targets (such as build), you will need to include
  37         docbook-to-man in your Build-Depends control field.
  38
  39   -->
  40
  41   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  42   <!ENTITY dhfirstname "<firstname>Patrick</firstname>">
  43   <!ENTITY dhsurname   "<surname>Lam</surname>">
  44   <!-- Please adjust the date whenever revising the manpage. -->
  45   <!ENTITY dhdate      "<date>Aug 13, 2008</date>">
  46   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
  47        allowed: see man(7), man(1). -->
  48   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  49   <!ENTITY dhemail     "<email>plam@mit.edu</email>">
  50   <!ENTITY dhusername  "Patrick Lam">
  51   <!ENTITY dhucpackage "<refentrytitle>fc-cat</refentrytitle>">
  52   <!ENTITY dhpackage   "fc-cat">
  53
  54   <!ENTITY debian      "<productname>Debian</productname>">
  55   <!ENTITY gnu         "<acronym>GNU</acronym>">
  56   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  57 ]>
  58
  59 <refentry>
  60   <refentryinfo>
  61     <address>
  62       &dhemail;
  63     </address>
  64     <author>
  65       &dhfirstname;
  66       &dhsurname;
  67     </author>
  68     <copyright>
  69       <year>2005</year>
  70       <holder>&dhusername;</holder>
  71     </copyright>
  72     &dhdate;
  73   </refentryinfo>
  74   <refmeta>
  75     &dhucpackage;
  76
  77     &dhsection;
  78   </refmeta>
  79   <refnamediv>
  80     <refname>&dhpackage;</refname>
  81
  82     <refpurpose>read font information cache files</refpurpose>
  83   </refnamediv>
  84   <refsynopsisdiv>
  85     <cmdsynopsis>
  86       <command>&dhpackage;</command>
  87
  88       <arg><option>-rvVh</option></arg>
  89       <arg><option>--recurse</option></arg>
  90       <arg><option>--verbose</option></arg>
  91       <arg><option>--version</option></arg>
  92       <arg><option>--help</option></arg>
  93       <sbr>
  94       <group rep="repeat">
  95           <arg><option><replaceable>fonts-cache-%version%-files</replaceable></option></arg>
  96           <arg><option><replaceable>dirs</replaceable></option></arg>
  97       </group>
  98
  99      </cmdsynopsis>
 100   </refsynopsisdiv>
 101   <refsect1>
 102     <title>DESCRIPTION</title>
 103
 104       <para><command>&dhpackage;</command> reads the font information from
 105         cache files or related to font directories
 106         and emits it in ASCII form.</para>
 107
 108   </refsect1>
 109   <refsect1>
 110     <title>OPTIONS</title>
 111
 112     <para>This program follows the usual &gnu; command line syntax,
 113       with long options starting with two dashes (`-').  A summary of
 114       options is included below.</para>
 115
 116     <variablelist>
 117       <varlistentry>
 118         <term><option>-r</option>
 119           <option>--recurse</option>
 120         </term>
 121         <listitem>
 122           <para>Recurse into subdirectories.</para>
 123         </listitem>
 124       </varlistentry>
 125       <varlistentry>
 126         <term><option>-v</option>
 127           <option>--verbose</option>
 128         </term>
 129         <listitem>
 130           <para>Be verbose.</para>
 131         </listitem>
 132       </varlistentry>
 133       <varlistentry>
 134         <term><option>-h</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     </variablelist>
 150   </refsect1>
 151
 152   <refsect1>
 153     <title>SEE ALSO</title>
 154
 155     <para>
 156       <command>fc-cache</command>(1)
 157       <command>fc-list</command>(1)
 158       <command>fc-match</command>(1)
 159       <command>fc-pattern</command>(1)
 160       <command>fc-query</command>(1)
 161       <command>fc-scan</command>(1)
 162     </para>
 163
 164     <para>The fontconfig user's guide, in HTML format:
 165       <filename>/usr/share/doc/fontconfig/fontconfig-user.html</filename>.</para>
 166
 167  </refsect1>
 168   <refsect1>
 169     <title>AUTHOR</title>
 170
 171     <para>This manual page was written by &dhusername; &dhemail;.</para>
 172
 173   </refsect1>
 174 </refentry>
 175
 176 <!-- Keep this comment at the end of the file
 177 Local variables:
 178 mode: sgml
 179 sgml-omittag:t
 180 sgml-shorttag:t
 181 sgml-minimize-attributes:nil
 182 sgml-always-quote-attributes:t
 183 sgml-indent-step:2
 184 sgml-indent-data:t
 185 sgml-parent-document:nil
 186 sgml-default-dtd-file:nil
 187 sgml-exposed-tags:nil
 188 sgml-local-catalogs:nil
 189 sgml-local-ecat-files:nil
 190 End:
 191 -->