fc-query/fc-query.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>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>behdad@behdad.org</email>">
  28   <!ENTITY dhusername  "Behdad Esfahbod">
  29   <!ENTITY dhucpackage "<refentrytitle>fc-query</refentrytitle>">
  30   <!ENTITY dhpackage   "fc-query">
  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>query font files</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>-i</option> <option><replaceable>index</replaceable></option></arg>
  69         <arg><option>--index</option> <option><replaceable>index</replaceable></option></arg>
  70       </group>
  71       <group>
  72         <arg><option>-f</option> <option><replaceable>format</replaceable></option></arg>
  73         <arg><option>--format</option> <option><replaceable>format</replaceable></option></arg>
  74       </group>
  75       <arg><option>--version</option></arg>
  76       <arg><option>--help</option></arg>
  77       <arg choice="req" rep="repeat"><option><replaceable>font-file</replaceable></option></arg>
  78
  79      </cmdsynopsis>
  80   </refsynopsisdiv>
  81   <refsect1>
  82     <title>DESCRIPTION</title>
  83
  84     <para><command>&dhpackage;</command> queries
  85     <replaceable>font-file</replaceable>(s) using the normal fontconfig
  86     rules and prints out font pattern for each face found.
  87     If <option>--index</option> is given, only one face of each file is
  88     queried, otherwise all faces are queried.</para>
  89
  90   </refsect1>
  91   <refsect1>
  92     <title>OPTIONS</title>
  93
  94     <para>This program follows the usual &gnu; command line syntax,
  95       with long options starting with two dashes (`-').  A summary of
  96       options is included below.</para>
  97
  98     <variablelist>
  99       <varlistentry>
 100         <term><option>-i</option>
 101           <option>--index</option>
 102           <option><replaceable>index</replaceable></option>
 103         </term>
 104         <listitem>
 105           <para>Only query face indexed <replaceable>index</replaceable> of
 106           each file.</para>
 107         </listitem>
 108       </varlistentry>
 109       <varlistentry>
 110         <term><option>-f</option>
 111           <option>--format</option>
 112           <option><replaceable>format</replaceable></option>
 113         </term>
 114         <listitem>
 115           <para>Format output according to the format specifier
 116           <replaceable>format</replaceable>.</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       <varlistentry>
 128         <term><option>-h</option>
 129           <option>--help</option>
 130         </term>
 131         <listitem>
 132           <para>Show summary of options.</para>
 133         </listitem>
 134       </varlistentry>
 135       <varlistentry>
 136         <term><option><replaceable>font-file</replaceable></option>
 137         </term>
 138         <listitem>
 139           <para>Query <replaceable>font-file</replaceable> for font faces.</para>
 140         </listitem>
 141       </varlistentry>
 142     </variablelist>
 143   </refsect1>
 144
 145   <refsect1>
 146     <title>RETURN CODES</title>
 147     <para><command>fc-query</command> returns error code 0 for successful parsing,
 148     or 1 if any errors occured or if at least one font face could not be opened.</para>
 149   </refsect1>
 150
 151   <refsect1>
 152     <title>SEE ALSO</title>
 153
 154     <para>
 155       <command>fc-scan</command>(1)
 156       <function>FcFreeTypeQuery</function>(3)
 157       <function>FcPatternFormat</function>(3)
 158       <command>fc-cat</command>(1)
 159       <command>fc-cache</command>(1)
 160       <command>fc-list</command>(1)
 161       <command>fc-match</command>(1)
 162       <command>fc-pattern</command>(1)
 163     </para>
 164
 165     <para>The fontconfig user's guide, in HTML format:
 166       <filename>/usr/share/doc/fontconfig/fontconfig-user.html</filename>.</para>
 167
 168  </refsect1>
 169   <refsect1>
 170     <title>AUTHOR</title>
 171
 172     <para>This manual page was updated by &dhusername; &dhemail;.</para>
 173
 174   </refsect1>
 175 </refentry>
 176
 177 <!-- Keep this comment at the end of the file
 178 Local variables:
 179 mode: sgml
 180 sgml-omittag:t
 181 sgml-shorttag:t
 182 sgml-minimize-attributes:nil
 183 sgml-always-quote-attributes:t
 184 sgml-indent-step:2
 185 sgml-indent-data:t
 186 sgml-parent-document:nil
 187 sgml-default-dtd-file:nil
 188 sgml-exposed-tags:nil
 189 sgml-local-catalogs:nil
 190 sgml-local-ecat-files:nil
 191 End:
 192 -->