fc-pattern/fc-pattern.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>Behdad</firstname>">
  21   <!ENTITY dhsurname   "<surname>Esfahbod</surname>">
  22   <!-- Please adjust the date whenever revising the manpage. -->
  23   <!ENTITY dhdate      "<date>Apr 20, 2010</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>behdad@behdad.org</email>">
  28   <!ENTITY dhusername  "Behdad Esfahbod">
  29   <!ENTITY dhucpackage "<refentrytitle>fc-pattern</refentrytitle>">
  30   <!ENTITY dhpackage   "fc-pattern">
  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>2010</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>parse and show pattern</refpurpose>
  61   </refnamediv>
  62   <refsynopsisdiv>
  63     <cmdsynopsis>
  64       <command>&dhpackage;</command>
  65
  66       <arg><option>-cdVh</option></arg>
  67       <arg><option>--config</option></arg>
  68       <arg><option>--default</option></arg>
  69       <group>
  70         <arg><option>-f</option> <option><replaceable>format</replaceable></option></arg>
  71         <arg><option>--format</option> <option><replaceable>format</replaceable></option></arg>
  72       </group>
  73       <arg><option>--version</option></arg>
  74       <arg><option>--help</option></arg>
  75       <sbr>
  76       <arg><option><replaceable>pattern</replaceable></option> <arg rep="repeat"><option><replaceable>element</replaceable></option></arg> </arg>
  77
  78      </cmdsynopsis>
  79   </refsynopsisdiv>
  80   <refsect1>
  81     <title>DESCRIPTION</title>
  82
  83     <para><command>&dhpackage;</command> parses
  84     <replaceable>pattern</replaceable> (empty
  85 pattern by default) and shows the parsed result.
  86 If <option>--config</option> is given, config substitution is performed on the
  87 pattern before being displayed.
  88 If <option>--default</option> is given, default substitution is performed on the
  89 pattern before being displayed.
  90 <para>If any elements are specified, only those are printed.</para>
  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>-c</option>
 102           <option>--config</option>
 103         </term>
 104         <listitem>
 105           <para>Perform config substitution on pattern.</para>
 106         </listitem>
 107       </varlistentry>
 108       <varlistentry>
 109         <term><option>-d</option>
 110           <option>--default</option>
 111         </term>
 112         <listitem>
 113           <para>Perform default substitution on pattern.</para>
 114         </listitem>
 115       </varlistentry>
 116       <varlistentry>
 117         <term><option>-f</option>
 118           <option>--format</option>
 119           <option><replaceable>format</replaceable></option>
 120         </term>
 121         <listitem>
 122           <para>Format output according to the format specifier
 123           <replaceable>format</replaceable>.</para>
 124         </listitem>
 125       </varlistentry>
 126       <varlistentry>
 127         <term><option>-V</option>
 128           <option>--version</option>
 129         </term>
 130         <listitem>
 131           <para>Show version of the program and exit.</para>
 132         </listitem>
 133       </varlistentry>
 134       <varlistentry>
 135         <term><option>-h</option>
 136           <option>--help</option>
 137         </term>
 138         <listitem>
 139           <para>Show summary of options.</para>
 140         </listitem>
 141       </varlistentry>
 142       <varlistentry>
 143         <term><option><replaceable>pattern</replaceable></option>
 144         </term>
 145         <listitem>
 146           <para>Parses and displays <replaceable>pattern</replaceable> (uses empty pattern by default).</para>
 147         </listitem>
 148       </varlistentry>
 149       <varlistentry>
 150         <term><option><replaceable>element</replaceable></option>
 151         </term>
 152         <listitem>
 153           <para>If set, the <replaceable>element</replaceable> property
 154                 is displayed for parsed pattern.</para>
 155         </listitem>
 156       </varlistentry>
 157     </variablelist>
 158   </refsect1>
 159
 160   <refsect1>
 161     <title>SEE ALSO</title>
 162
 163     <para>
 164       <function>FcNameParse</function>(3)
 165       <function>FcConfigSubstitute</function>(3)
 166       <function>FcDefaultSubstitute</function>(3)
 167       <function>FcPatternPrint</function>(3)
 168       <function>FcPatternFormat</function>(3)
 169       <command>fc-cat</command>(1)
 170       <command>fc-cache</command>(1)
 171       <command>fc-list</command>(1)
 172       <command>fc-match</command>(1)
 173       <command>fc-query</command>(1)
 174       <command>fc-scan</command>(1)
 175     </para>
 176
 177     <para>The fontconfig user's guide, in HTML format:
 178       <filename>/usr/share/doc/fontconfig/fontconfig-user.html</filename>.</para>
 179
 180  </refsect1>
 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
 190 Local variables:
 191 mode: sgml
 192 sgml-omittag:t
 193 sgml-shorttag:t
 194 sgml-minimize-attributes:nil
 195 sgml-always-quote-attributes:t
 196 sgml-indent-step:2
 197 sgml-indent-data:t
 198 sgml-parent-document:nil
 199 sgml-default-dtd-file:nil
 200 sgml-exposed-tags:nil
 201 sgml-local-catalogs:nil
 202 sgml-local-ecat-files:nil
 203 End:
 204 -->