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