fc-match.sgml revision 1cc69409 
1<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
3<!--
4Copyright © 2008 Patrick Lam
5
6Permission to use, copy, modify, distribute, and sell this software and its
7documentation for any purpose is hereby granted without fee, provided that
8the above copyright notice appear in all copies and that both that
9copyright notice and this permission notice appear in supporting
10documentation, and that the name of the author(s) not be used in
11advertising or publicity pertaining to distribution of the software without
12specific, written prior permission.  The authors make no
13representations about the suitability of this software for any purpose.  It
14is provided "as is" without express or implied warranty.
15
16THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
17INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
18EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
19CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
20DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
21TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
22PERFORMANCE OF THIS SOFTWARE.
23-->
24
25<!-- Process this file with docbook-to-man to generate an nroff manual
26     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
27     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
28     less'.  A typical entry in a Makefile or Makefile.am is:
29
30manpage.1: manpage.sgml
31        docbook-to-man $< > $@
32
33
34        The docbook-to-man binary is found in the docbook-to-man package.
35        Please remember that if you create the nroff version in one of the
36        debian/rules file targets (such as build), you will need to include
37        docbook-to-man in your Build-Depends control field.
38
39  -->
40
41  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
42  <!ENTITY dhfirstname "<firstname>Patrick</firstname>">
43  <!ENTITY dhsurname   "<surname>Lam</surname>">
44  <!-- Please adjust the date whenever revising the manpage. -->
45  <!ENTITY dhdate      "<date>Aug 13, 2008</date>">
46  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
47       allowed: see man(7), man(1). -->
48  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
49  <!ENTITY dhemail     "<email>plam@csail.mit.edu</email>">
50  <!ENTITY dhusername  "Patrick Lam">
51  <!ENTITY dhucpackage "<refentrytitle>fc-match</refentrytitle>">
52  <!ENTITY dhpackage   "fc-match">
53
54  <!ENTITY debian      "<productname>Debian</productname>">
55  <!ENTITY gnu         "<acronym>GNU</acronym>">
56  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
57]>
58
59<refentry>
60  <refentryinfo>
61    <address>
62      &dhemail;
63    </address>
64    <author>
65      &dhfirstname;
66      &dhsurname;
67    </author>
68    <copyright>
69      <year>2003</year>
70      <holder>&dhusername;</holder>
71    </copyright>
72    &dhdate;
73  </refentryinfo>
74  <refmeta>
75    &dhucpackage;
76
77    &dhsection;
78  </refmeta>
79  <refnamediv>
80    <refname>&dhpackage;</refname>
81
82    <refpurpose>match available fonts</refpurpose>
83  </refnamediv>
84  <refsynopsisdiv>
85    <cmdsynopsis>
86      <command>&dhpackage;</command>
87
88      <arg><option>-asvVh</option></arg>
89      <arg><option>--all</option></arg>
90      <arg><option>--sort</option></arg>
91      <arg><option>--verbose</option></arg>
92      <group>
93        <arg><option>-f</option> <option><replaceable>format</replaceable></option></arg>
94        <arg><option>--format</option> <option><replaceable>format</replaceable></option></arg>
95      </group>
96      <arg><option>--version</option></arg>
97      <arg><option>--help</option></arg>
98      <sbr>
99      <arg><option><replaceable>pattern</replaceable></option> <arg rep="repeat"><option><replaceable>element</replaceable></option></arg> </arg>
100
101     </cmdsynopsis>
102  </refsynopsisdiv>
103  <refsect1>
104    <title>DESCRIPTION</title>
105
106    <para><command>&dhpackage;</command> matches
107    <replaceable>pattern</replaceable> (empty
108pattern by default) using the normal fontconfig matching rules to find
109the best font available.  If <option>--sort</option> is given, the sorted list of best
110matching fonts is displayed.
111The <option>--all</option> option works like
112<option>--sort</option> except that no pruning is done on the list of fonts.</para>
113<para>If any elements are specified, only those are printed.
114Otherwise short file name, family, and style are printed, unless verbose
115output is requested.</para>
116  </refsect1>
117  <refsect1>
118    <title>OPTIONS</title>
119
120    <para>This program follows the usual &gnu; command line syntax,
121      with long options starting with two dashes (`-').  A summary of
122      options is included below.</para>
123
124    <variablelist>
125      <varlistentry>
126        <term><option>-a</option>
127          <option>--all</option>
128        </term>
129        <listitem>
130          <para>Displays sorted list of best matching fonts, but do not do any
131                pruning on the list.</para>
132        </listitem>
133      </varlistentry>
134      <varlistentry>
135        <term><option>-s</option>
136          <option>--sort</option>
137        </term>
138        <listitem>
139          <para>Displays sorted list of best matching fonts.</para>
140        </listitem>
141      </varlistentry>
142      <varlistentry>
143        <term><option>-v</option>
144          <option>--verbose</option>
145        </term>
146        <listitem>
147          <para>Print verbose output of the whole font pattern for each match,
148                or <replaceable>element</replaceable>s if any is
149                provided.</para>
150        </listitem>
151      </varlistentry>
152      <varlistentry>
153        <term><option>-f</option>
154          <option>--format</option>
155          <option><replaceable>format</replaceable></option>
156        </term>
157        <listitem>
158          <para>Format output according to the format specifier
159          <replaceable>format</replaceable>.</para>
160        </listitem>
161      </varlistentry>
162      <varlistentry>
163        <term><option>-V</option>
164          <option>--version</option>
165        </term>
166        <listitem>
167          <para>Show version of the program and exit.</para>
168        </listitem>
169      </varlistentry>
170      <varlistentry>
171        <term><option>-h</option>
172          <option>--help</option>
173        </term>
174        <listitem>
175          <para>Show summary of options.</para>
176        </listitem>
177      </varlistentry>
178      <varlistentry>
179        <term><option><replaceable>pattern</replaceable></option>
180        </term>
181        <listitem>
182          <para>Displays fonts matching
183                <replaceable>pattern</replaceable> (uses empty pattern by default).</para>
184        </listitem>
185      </varlistentry>
186      <varlistentry>
187        <term><option><replaceable>element</replaceable></option>
188        </term>
189        <listitem>
190          <para>If set, the <replaceable>element</replaceable> property
191                is displayed for matching fonts.</para>
192        </listitem>
193      </varlistentry>
194    </variablelist>
195  </refsect1>
196
197  <refsect1>
198    <title>EXAMPLES</title>
199
200    <variablelist>
201      <varlistentry>
202        <term>fc-match sans</term>
203        <listitem><para>Display the best matching font categorized into sans-serif generic family, filtered by current locale</para></listitem>
204      </varlistentry>
205    </variablelist>
206
207    <variablelist>
208      <varlistentry>
209        <term>fc-match sans:lang=en</term>
210        <listitem><para>Display the best matching font categorized into sans-serif generic family, filtered by English language</para></listitem>
211      </varlistentry>
212    </variablelist>
213
214    <variablelist>
215      <varlistentry>
216        <term>fc-match sans:lang=en:weight=bold</term>
217        <listitem><para>Display the best matching font categorized into sans-serif generic family, filtered by English language and weight is bold.</para></listitem>
218      </varlistentry>
219    </variablelist>
220
221  </refsect1>
222
223  <refsect1>
224    <title>SEE ALSO</title>
225
226    <para>
227      <command>fc-list</command>(1)
228      <function>FcFontMatch</function>(3)
229      <function>FcFontSort</function>(3)
230      <function>FcPatternFormat</function>(3)
231      <command>fc-cat</command>(1)
232      <command>fc-cache</command>(1)
233      <command>fc-pattern</command>(1)
234      <command>fc-query</command>(1)
235      <command>fc-scan</command>(1)
236    </para>
237
238    <para>The fontconfig user's guide, in HTML format:
239      <filename>/usr/share/doc/fontconfig/fontconfig-user.html</filename>.</para>
240
241 </refsect1>
242  <refsect1>
243    <title>AUTHOR</title>
244
245    <para>This manual page was updated by &dhusername; &dhemail;.</para>
246
247  </refsect1>
248</refentry>
249
250<!-- Keep this comment at the end of the file
251Local variables:
252mode: sgml
253sgml-omittag:t
254sgml-shorttag:t
255sgml-minimize-attributes:nil
256sgml-always-quote-attributes:t
257sgml-indent-step:2
258sgml-indent-data:t
259sgml-parent-document:nil
260sgml-default-dtd-file:nil
261sgml-exposed-tags:nil
262sgml-local-catalogs:nil
263sgml-local-ecat-files:nil
264End:
265-->
266