fc-match/fc-match.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>Patrick</firstname>">
  21   <!ENTITY dhsurname   "<surname>Lam</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>plam@csail.mit.edu</email>">
  28   <!ENTITY dhusername  "Patrick Lam">
  29   <!ENTITY dhucpackage "<refentrytitle>fc-match</refentrytitle>">
  30   <!ENTITY dhpackage   "fc-match">
  31
  32   <!ENTITY debian      "<productname>Debian</productname>">
  33   <!ENTITY gnu         "<acronym>GNU</acronym>">
  34   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  35 ]>
  36
  37 <refentry>
  38   <refentryinfo>
  39     <address>
  40       &dhemail;
  41     </address>
  42     <author>
  43       &dhfirstname;
  44       &dhsurname;
  45     </author>
  46     <copyright>
  47       <year>2003</year>
  48       <holder>&dhusername;</holder>
  49     </copyright>
  50     &dhdate;
  51   </refentryinfo>
  52   <refmeta>
  53     &dhucpackage;
  54
  55     &dhsection;
  56   </refmeta>
  57   <refnamediv>
  58     <refname>&dhpackage;</refname>
  59
  60     <refpurpose>match available fonts</refpurpose>
  61   </refnamediv>
  62   <refsynopsisdiv>
  63     <cmdsynopsis>
  64       <command>&dhpackage;</command>
  65
  66       <arg><option>-asvVh</option></arg>
  67       <arg><option>--all</option></arg>
  68       <arg><option>--sort</option></arg>
  69       <arg><option>--verbose</option></arg>
  70       <group>
  71         <arg><option>-f</option> <option><replaceable>format</replaceable></option></arg>
  72         <arg><option>--format</option> <option><replaceable>format</replaceable></option></arg>
  73       </group>
  74       <arg><option>--version</option></arg>
  75       <arg><option>--help</option></arg>
  76       <arg><option><replaceable>font-pattern</replaceable></option></arg>
  77
  78      </cmdsynopsis>
  79   </refsynopsisdiv>
  80   <refsect1>
  81     <title>DESCRIPTION</title>
  82
  83     <para><command>&dhpackage;</command> matches
  84     <replaceable>font-pattern</replaceable> (empty
  85 pattern by default) using the normal fontconfig matching rules to find
  86 the best font available.  If <option>--sort</option> is given, the sorted list of best
  87 matching fonts is displayed.  With <option>--verbose</option>, the whole font pattern
  88 for each match is printed, otherwise only the file, family and style
  89 are printed.  The <option>--all</option> option works like
  90 <option>--sort</option> except that no pruning is done on the list of fonts.</para>
  91
  92   </refsect1>
  93   <refsect1>
  94     <title>OPTIONS</title>
  95
  96     <para>This program follows the usual &gnu; command line syntax,
  97       with long options starting with two dashes (`-').  A summary of
  98       options is included below.</para>
  99
 100     <variablelist>
 101       <varlistentry>
 102         <term><option>-a</option>
 103           <option>--all</option>
 104         </term>
 105         <listitem>
 106           <para>Displays sorted list of best matching fonts, but do not do any
 107                 pruning on the list.</para>
 108         </listitem>
 109       </varlistentry>
 110       <varlistentry>
 111         <term><option>-s</option>
 112           <option>--sort</option>
 113         </term>
 114         <listitem>
 115           <para>Displays sorted list of best matching fonts.</para>
 116         </listitem>
 117       </varlistentry>
 118       <varlistentry>
 119         <term><option>-v</option>
 120           <option>--verbose</option>
 121         </term>
 122         <listitem>
 123           <para>Print whole font pattern for each match.</para>
 124         </listitem>
 125       </varlistentry>
 126       <varlistentry>
 127         <term><option>-f</option>
 128           <option>--format</option>
 129           <option><replaceable>format</replaceable></option>
 130         </term>
 131         <listitem>
 132           <para>Format output according to the format specifier
 133           <replaceable>format</replaceable>.</para>
 134         </listitem>
 135       </varlistentry>
 136       <varlistentry>
 137         <term><option>-V</option>
 138           <option>--version</option>
 139         </term>
 140         <listitem>
 141           <para>Show version of the program and exit.</para>
 142         </listitem>
 143       </varlistentry>
 144       <varlistentry>
 145         <term><option>-h</option>
 146           <option>--help</option>
 147         </term>
 148         <listitem>
 149           <para>Show summary of options.</para>
 150         </listitem>
 151       </varlistentry>
 152       <varlistentry>
 153         <term><option><replaceable>font-pattern</replaceable></option>
 154         </term>
 155         <listitem>
 156           <para>Displays fonts matching
 157                 <replaceable>font-pattern</replaceable> (uses empty pattern by default).</para>
 158         </listitem>
 159       </varlistentry>
 160     </variablelist>
 161   </refsect1>
 162
 163   <refsect1>
 164     <title>SEE ALSO</title>
 165
 166     <para>
 167       <command>fc-list</command>(1)
 168       <function>FcFontMatch</function>(3)
 169       <function>FcFontSort</function>(3)
 170       <function>FcPatternFormat</function>(3)
 171       <command>fc-cat</command>(1)
 172       <command>fc-cache</command>(1)
 173       <command>fc-query</command>(1)
 174       <command>fc-scal</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 -->