fc-match.sgml revision a6844aab 
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
8manpage.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      <sbr>
77      <arg><option><replaceable>pattern</replaceable></option> <arg rep="repeat"><option><replaceable>element</replaceable></option></arg> </arg>
78      
79     </cmdsynopsis>
80  </refsynopsisdiv>
81  <refsect1>
82    <title>DESCRIPTION</title>
83
84    <para><command>&dhpackage;</command> matches
85    <replaceable>pattern</replaceable> (empty
86pattern by default) using the normal fontconfig matching rules to find
87the best font available.  If <option>--sort</option> is given, the sorted list of best
88matching fonts is displayed.
89The <option>--all</option> option works like
90<option>--sort</option> except that no pruning is done on the list of fonts.</para>
91<para>If any elements are specified, only those are printed.
92Otherwise short file name, family, and style are printed, unless verbose
93output is requested.</para>
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>-a</option>
105          <option>--all</option>
106        </term>
107        <listitem>
108          <para>Displays sorted list of best matching fonts, but do not do any
109		pruning on the list.</para>
110        </listitem>
111      </varlistentry>
112      <varlistentry>
113        <term><option>-s</option>
114          <option>--sort</option>
115        </term>
116        <listitem>
117          <para>Displays sorted list of best matching fonts.</para>
118        </listitem>
119      </varlistentry>
120      <varlistentry>
121        <term><option>-v</option>
122          <option>--verbose</option>
123        </term>
124        <listitem>
125          <para>Print verbose output of the whole font pattern for each match,
126	        or <replaceable>element</replaceable>s if any is
127		provided.</para>
128        </listitem>
129      </varlistentry>
130      <varlistentry>
131        <term><option>-f</option>
132          <option>--format</option>
133	  <option><replaceable>format</replaceable></option>
134        </term>
135        <listitem>
136          <para>Format output according to the format specifier
137	  <replaceable>format</replaceable>.</para>
138        </listitem>
139      </varlistentry>
140      <varlistentry>
141        <term><option>-V</option>
142          <option>--version</option>
143        </term>
144        <listitem>
145          <para>Show version of the program and exit.</para>
146        </listitem>
147      </varlistentry>
148      <varlistentry>
149        <term><option>-h</option>
150          <option>--help</option>
151        </term>
152        <listitem>
153          <para>Show summary of options.</para>
154        </listitem>
155      </varlistentry>
156      <varlistentry>
157        <term><option><replaceable>pattern</replaceable></option>
158        </term>
159        <listitem>
160          <para>Displays fonts matching
161                <replaceable>pattern</replaceable> (uses empty pattern by default).</para>
162        </listitem>
163      </varlistentry>
164      <varlistentry>
165        <term><option><replaceable>element</replaceable></option>
166        </term>
167        <listitem>
168          <para>If set, the <replaceable>element</replaceable> property
169                is displayed for matching fonts.</para>
170        </listitem>
171      </varlistentry>
172    </variablelist>
173  </refsect1>
174
175  <refsect1>
176    <title>SEE ALSO</title>
177
178    <para>
179      <command>fc-list</command>(1)
180      <function>FcFontMatch</function>(3)
181      <function>FcFontSort</function>(3)
182      <function>FcPatternFormat</function>(3)
183      <command>fc-cat</command>(1)
184      <command>fc-cache</command>(1)
185      <command>fc-query</command>(1)
186      <command>fc-scal</command>(1)
187    </para>
188
189    <para>The fontconfig user's guide, in HTML format:
190      <filename>/usr/share/doc/fontconfig/fontconfig-user.html</filename>.</para>
191
192 </refsect1>
193  <refsect1>
194    <title>AUTHOR</title>
195
196    <para>This manual page was updated by &dhusername; &dhemail;.</para>
197
198  </refsect1>
199</refentry>
200
201<!-- Keep this comment at the end of the file
202Local variables:
203mode: sgml
204sgml-omittag:t
205sgml-shorttag:t
206sgml-minimize-attributes:nil
207sgml-always-quote-attributes:t
208sgml-indent-step:2
209sgml-indent-data:t
210sgml-parent-document:nil
211sgml-default-dtd-file:nil
212sgml-exposed-tags:nil
213sgml-local-catalogs:nil
214sgml-local-ecat-files:nil
215End:
216-->
217