fc-cat.sgml 4.63 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Patrick</firstname>">
  <!ENTITY dhsurname   "<surname>Lam</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
Behdad Esfahbod's avatar
Behdad Esfahbod committed
23
  <!ENTITY dhdate      "<date>Aug 13, 2008</date>">
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>plam@mit.edu</email>">
  <!ENTITY dhusername  "Patrick Lam">
  <!ENTITY dhucpackage "<refentrytitle>fc-cat</refentrytitle>">
  <!ENTITY dhpackage   "fc-cat">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2005</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>read font information cache files</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
64
      <command>&dhpackage;</command>
65

66
      <arg><option>-rvVh</option></arg>
67 68
      <arg><option>--recurse</option></arg>
      <arg><option>--verbose</option></arg>
69 70
      <arg><option>--version</option></arg>
      <arg><option>--help</option></arg>
Behdad Esfahbod's avatar
Behdad Esfahbod committed
71 72 73 74 75
      <sbr>
      <group rep="repeat">
          <arg><option><replaceable>fonts-cache-2-files</replaceable></option></arg>
          <arg><option><replaceable>dirs</replaceable></option></arg>
      </group>
76 77 78 79 80 81
      
     </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

82 83
      <para><command>&dhpackage;</command> reads the font information from
        cache files or related to font directories
84 85 86 87 88 89 90 91 92 93 94
        and emits it in ASCII form.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>This program follows the usual &gnu; command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below.</para>

    <variablelist>
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
      <varlistentry>
        <term><option>-r</option>
          <option>--recurse</option>
        </term>
        <listitem>
          <para>Recurse into subdirectories.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option>
          <option>--verbose</option>
        </term>
        <listitem>
          <para>Be verbose.</para>
        </listitem>
      </varlistentry>
111
      <varlistentry>
112
        <term><option>-h</option>
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
          <option>--help</option>
        </term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-V</option>
          <option>--version</option>
        </term>
        <listitem>
          <para>Show version of the program and exit.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>

Behdad Esfahbod's avatar
Behdad Esfahbod committed
133 134 135 136
    <para>
      <command>fc-cache</command>(1)
      <command>fc-list</command>(1)
      <command>fc-match</command>(1)
137
      <command>fc-pattern</command>(1)
Behdad Esfahbod's avatar
Behdad Esfahbod committed
138
      <command>fc-query</command>(1)
139
      <command>fc-scan</command>(1)
Behdad Esfahbod's avatar
Behdad Esfahbod committed
140
    </para>
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169

    <para>The fontconfig user's guide, in HTML format:
      <filename>/usr/share/doc/fontconfig/fontconfig-user.html</filename>.</para>

 </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail;.</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->