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       <arg><option>--version</option></arg>
  71       <arg><option>--help</option></arg>
  72       <arg><option><replaceable>font-pattern</replaceable></option></arg>
  73
  74      </cmdsynopsis>
  75   </refsynopsisdiv>
  76   <refsect1>
  77     <title>DESCRIPTION</title>
  78
  79     <para><command>&dhpackage;</command> matches
  80     <replaceable>font-pattern</replaceable> (empty
  81 pattern by default) using the normal fontconfig matching rules to find
  82 the best font available.  If <option>--sort</option> is given, the sorted list of best
  83 matching fonts is displayed.  With <option>--verbose</option>, the whole font pattern
  84 for each match is printed, otherwise only the file, family and style
  85 are printed.  The <option>--all</option> option works like
  86 <option>--sort</option> except that no pruning is done on the list of fonts.</para>
  87
  88   </refsect1>
  89   <refsect1>
  90     <title>OPTIONS</title>
  91
  92     <para>This program follows the usual &gnu; command line syntax,
  93       with long options starting with two dashes (`-').  A summary of
  94       options is included below.</para>
  95
  96     <variablelist>
  97       <varlistentry>
  98         <term><option>-v</option>
  99           <option>--verbose</option>
 100         </term>
 101         <listitem>
 102           <para>Print whole font pattern for each match.</para>
 103         </listitem>
 104       </varlistentry>
 105       <varlistentry>
 106         <term><option>-h</option>
 107           <option>--help</option>
 108         </term>
 109         <listitem>
 110           <para>Show summary of options.</para>
 111         </listitem>
 112       </varlistentry>
 113       <varlistentry>
 114         <term><option>-V</option>
 115           <option>--version</option>
 116         </term>
 117         <listitem>
 118           <para>Show version of the program and exit.</para>
 119         </listitem>
 120       </varlistentry>
 121       <varlistentry>
 122         <term><option>-a</option>
 123           <option>--all</option>
 124         </term>
 125         <listitem>
 126           <para>Displays sorted list of best matching fonts, but do not do any
 127                 pruning on the list.</para>
 128         </listitem>
 129       </varlistentry>
 130       <varlistentry>
 131         <term><option>-s</option>
 132           <option>--sort</option>
 133         </term>
 134         <listitem>
 135           <para>Displays sorted list of best matching fonts.</para>
 136         </listitem>
 137       </varlistentry>
 138       <varlistentry>
 139         <term><option><replaceable>font-pattern</replaceable></option>
 140         </term>
 141         <listitem>
 142           <para>Displays fonts matching
 143                 <replaceable>font-pattern</replaceable> (uses empty pattern by default).</para>
 144         </listitem>
 145       </varlistentry>
 146     </variablelist>
 147   </refsect1>
 148
 149   <refsect1>
 150     <title>SEE ALSO</title>
 151
 152     <para>
 153       <command>fc-cat</command>(1)
 154       <command>fc-cache</command>(1)
 155       <command>fc-list</command>(1)
 156       <command>fc-query</command>(1)
 157     </para>
 158
 159     <para>The fontconfig user's guide, in HTML format:
 160       <filename>/usr/share/doc/fontconfig/fontconfig-user.html</filename>.</para>
 161
 162  </refsect1>
 163   <refsect1>
 164     <title>AUTHOR</title>
 165
 166     <para>This manual page was updated by &dhusername; &dhemail;.</para>
 167
 168   </refsect1>
 169 </refentry>
 170
 171 <!-- Keep this comment at the end of the file
 172 Local variables:
 173 mode: sgml
 174 sgml-omittag:t
 175 sgml-shorttag:t
 176 sgml-minimize-attributes:nil
 177 sgml-always-quote-attributes:t
 178 sgml-indent-step:2
 179 sgml-indent-data:t
 180 sgml-parent-document:nil
 181 sgml-default-dtd-file:nil
 182 sgml-exposed-tags:nil
 183 sgml-local-catalogs:nil
 184 sgml-local-ecat-files:nil
 185 End:
 186 -->