fc-scan/fc-scan.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>Behdad</firstname>">
  21   <!ENTITY dhsurname   "<surname>Esfahbod</surname>">
  22   <!-- Please adjust the date whenever revising the manpage. -->
  23   <!ENTITY dhdate      "<date>Jan 15, 2009</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>behdad@behdad.org</email>">
  28   <!ENTITY dhusername  "Behdad Esfahbod">
  29   <!ENTITY dhucpackage "<refentrytitle>fc-scan</refentrytitle>">
  30   <!ENTITY dhpackage   "fc-scan">
  31
  32   <!ENTITY gnu         "<acronym>GNU</acronym>">
  33   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  34 ]>
  35
  36 <refentry>
  37   <refentryinfo>
  38     <address>
  39       &dhemail;
  40     </address>
  41     <author>
  42       &dhfirstname;
  43       &dhsurname;
  44     </author>
  45     <copyright>
  46       <year>2008</year>
  47       <holder>&dhusername;</holder>
  48     </copyright>
  49     &dhdate;
  50   </refentryinfo>
  51   <refmeta>
  52     &dhucpackage;
  53
  54     &dhsection;
  55   </refmeta>
  56   <refnamediv>
  57     <refname>&dhpackage;</refname>
  58
  59     <refpurpose>scan font files or directories</refpurpose>
  60   </refnamediv>
  61   <refsynopsisdiv>
  62     <cmdsynopsis>
  63       <command>&dhpackage;</command>
  64
  65       <arg><option>-Vh</option></arg>
  66       <sbr>
  67       <group>
  68         <arg><option>-f</option> <option><replaceable>format</replaceable></option></arg>
  69         <arg><option>--format</option> <option><replaceable>format</replaceable></option></arg>
  70       </group>
  71       <arg><option>--version</option></arg>
  72       <arg><option>--help</option></arg>
  73       <arg choice="req" rep="repeat"><option><replaceable>file</replaceable></option></arg>
  74
  75      </cmdsynopsis>
  76   </refsynopsisdiv>
  77   <refsect1>
  78     <title>DESCRIPTION</title>
  79
  80     <para><command>&dhpackage;</command> scans
  81     <replaceable>file</replaceable>(s) recursively
  82     and prints out font pattern for each face found.</para>
  83
  84   </refsect1>
  85   <refsect1>
  86     <title>OPTIONS</title>
  87
  88     <para>This program follows the usual &gnu; command line syntax,
  89       with long options starting with two dashes (`-').  A summary of
  90       options is included below.</para>
  91
  92     <variablelist>
  93       <varlistentry>
  94         <term><option>-f</option>
  95           <option>--format</option>
  96           <option><replaceable>format</replaceable></option>
  97         </term>
  98         <listitem>
  99           <para>Format output according to the format specifier
 100           <replaceable>format</replaceable>.</para>
 101         </listitem>
 102       </varlistentry>
 103       <varlistentry>
 104         <term><option>-V</option>
 105           <option>--version</option>
 106         </term>
 107         <listitem>
 108           <para>Show version of the program and exit.</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><replaceable>file</replaceable></option>
 121         </term>
 122         <listitem>
 123           <para>Scan <replaceable>file</replaceable> recursively for font faces.</para>
 124         </listitem>
 125       </varlistentry>
 126     </variablelist>
 127   </refsect1>
 128
 129   <refsect1>
 130     <title>RETURN CODES</title>
 131     <para><command>fc-scan</command> returns error code 0 if at least one font
 132     was found or 1 otherwise.</para>
 133   </refsect1>
 134
 135   <refsect1>
 136     <title>SEE ALSO</title>
 137
 138     <para>
 139       <command>fc-query</command>(1)
 140       <function>FcFileScan</function>(3)
 141       <function>FcDirScan</function>(3)
 142       <function>FcPatternFormat</function>(3)
 143       <command>fc-cat</command>(1)
 144       <command>fc-cache</command>(1)
 145       <command>fc-list</command>(1)
 146       <command>fc-match</command>(1)
 147       <command>fc-pattern</command>(1)
 148     </para>
 149
 150     <para>The fontconfig user's guide, in HTML format:
 151       <filename>/usr/share/doc/fontconfig/fontconfig-user.html</filename>.</para>
 152
 153  </refsect1>
 154   <refsect1>
 155     <title>AUTHOR</title>
 156
 157     <para>This manual page was updated by &dhusername; &dhemail;.</para>
 158
 159   </refsect1>
 160 </refentry>
 161
 162 <!-- Keep this comment at the end of the file
 163 Local variables:
 164 mode: sgml
 165 sgml-omittag:t
 166 sgml-shorttag:t
 167 sgml-minimize-attributes:nil
 168 sgml-always-quote-attributes:t
 169 sgml-indent-step:2
 170 sgml-indent-data:t
 171 sgml-parent-document:nil
 172 sgml-default-dtd-file:nil
 173 sgml-exposed-tags:nil
 174 sgml-local-catalogs:nil
 175 sgml-local-ecat-files:nil
 176 End:
 177 -->