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