fc-validate.sgml revision 1cc69409 
1<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
3<!--
4Copyright © 2012 Red Hat, Inc.
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>Akira</firstname>">
43  <!ENTITY dhsurname   "<surname>TAGOH</surname>">
44  <!-- Please adjust the date whenever revising the manpage. -->
45  <!ENTITY dhdate      "<date>Sep 10, 2012</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>akira@tagoh.org</email>">
50  <!ENTITY dhusername  "Akira TAGOH">
51  <!ENTITY dhucpackage "<refentrytitle>fc-validate</refentrytitle>">
52  <!ENTITY dhpackage   "fc-validate">
53
54  <!ENTITY gnu         "<acronym>GNU</acronym>">
55  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
56]>
57
58<refentry>
59  <refentryinfo>
60    <address>
61      &dhemail;
62    </address>
63    <author>
64      &dhfirstname;
65      &dhsurname;
66    </author>
67    <copyright>
68      <year>2012</year>
69      <holder>&dhusername;</holder>
70    </copyright>
71    &dhdate;
72  </refentryinfo>
73  <refmeta>
74    &dhucpackage;
75
76    &dhsection;
77  </refmeta>
78  <refnamediv>
79    <refname>&dhpackage;</refname>
80
81    <refpurpose>validate font files</refpurpose>
82  </refnamediv>
83  <refsynopsisdiv>
84    <cmdsynopsis>
85      <command>&dhpackage;</command>
86
87      <arg><option>-Vhv</option></arg>
88      <sbr>
89      <group>
90        <arg><option>-i</option> <option><replaceable>index</replaceable></option></arg>
91        <arg><option>--index</option> <option><replaceable>index</replaceable></option></arg>
92      </group>
93      <group>
94        <arg><option>-l</option> <option><replaceable>lang</replaceable></option></arg>
95        <arg><option>--lang</option> <option><replaceable>lang</replaceable></option></arg>
96      </group>
97      <arg><option>--verbose</option></arg>
98      <arg><option>--version</option></arg>
99      <arg><option>--help</option></arg>
100      <arg choice="req" rep="repeat"><option><replaceable>font-file</replaceable></option></arg>
101
102     </cmdsynopsis>
103  </refsynopsisdiv>
104  <refsect1>
105    <title>DESCRIPTION</title>
106
107    <para><command>&dhpackage;</command> validates
108    <replaceable>font-file</replaceable>(s) if each fonts satisfies
109    the language coverage according to the orthography files in fontconfig.
110    If <option>--index</option> is given, only one face of each file is
111    validated, otherwise all faces are validated.</para>
112
113  </refsect1>
114  <refsect1>
115    <title>OPTIONS</title>
116
117    <para>This program follows the usual &gnu; command line syntax,
118      with long options starting with two dashes (`-').  A summary of
119      options is included below.</para>
120
121    <variablelist>
122      <varlistentry>
123        <term><option>-i</option>
124          <option>--index</option>
125          <option><replaceable>index</replaceable></option>
126        </term>
127        <listitem>
128          <para>Only query face indexed <replaceable>index</replaceable> of
129          each file.</para>
130        </listitem>
131      </varlistentry>
132      <varlistentry>
133        <term><option>-l</option>
134          <option>--lang</option>
135          <option><replaceable>lang</replaceable></option>
136        </term>
137        <listitem>
138          <para>Set <replaceable>lang</replaceable> as a language instead of current locale. this is used for <option>-m</option>.</para>
139        </listitem>
140      </varlistentry>
141      <varlistentry>
142        <term><option>-v</option>
143          <option>--verbose</option>
144        </term>
145        <listitem>
146          <para>Show more detailed information.</para>
147        </listitem>
148      </varlistentry>
149      <varlistentry>
150        <term><option>-V</option>
151          <option>--version</option>
152        </term>
153        <listitem>
154          <para>Show version of the program and exit.</para>
155        </listitem>
156      </varlistentry>
157      <varlistentry>
158        <term><option>-h</option>
159          <option>--help</option>
160        </term>
161        <listitem>
162          <para>Show summary of options.</para>
163        </listitem>
164      </varlistentry>
165      <varlistentry>
166        <term><option><replaceable>font-file</replaceable></option>
167        </term>
168        <listitem>
169          <para>Query <replaceable>font-file</replaceable> for font faces.</para>
170        </listitem>
171      </varlistentry>
172    </variablelist>
173  </refsect1>
174
175  <refsect1>
176    <title>RETURN CODES</title>
177    <para><command>fc-validate</command> returns error code 0 for successful parsing,
178    or 1 if any errors occurred or if at least one font face could not be opened.</para>
179  </refsect1>
180
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
190Local variables:
191mode: sgml
192sgml-omittag:t
193sgml-shorttag:t
194sgml-minimize-attributes:nil
195sgml-always-quote-attributes:t
196sgml-indent-step:2
197sgml-indent-data:t
198sgml-parent-document:nil
199sgml-default-dtd-file:nil
200sgml-exposed-tags:nil
201sgml-local-catalogs:nil
202sgml-local-ecat-files:nil
203End:
204-->
205