fc-list/fc-list.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>Josselin</firstname>">
  21   <!ENTITY dhsurname   "<surname>Mouette</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>joss@debian.org</email>">
  28   <!ENTITY dhusername  "Josselin Mouette">
  29   <!ENTITY dhucpackage "<refentrytitle>fc-list</refentrytitle>">
  30   <!ENTITY dhpackage   "fc-list">
  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>list available fonts</refpurpose>
  61   </refnamediv>
  62   <refsynopsisdiv>
  63     <cmdsynopsis>
  64       <command>&dhpackage;</command>
  65
  66       <arg><option>-vVh</option></arg>
  67       <arg><option>--verbose</option></arg>
  68       <group>
  69         <arg><option>-f</option> <option><replaceable>format</replaceable></option></arg>
  70         <arg><option>--format</option> <option><replaceable>format</replaceable></option></arg>
  71       </group>
  72       <arg><option>--version</option></arg>
  73       <arg><option>--help</option></arg>
  74       <sbr>
  75       <arg><option><replaceable>pattern</replaceable></option> <arg rep="repeat"><option><replaceable>element</replaceable></option></arg> </arg>
  76
  77      </cmdsynopsis>
  78   </refsynopsisdiv>
  79   <refsect1>
  80     <title>DESCRIPTION</title>
  81
  82     <para><command>&dhpackage;</command> lists fonts and styles
  83       available on the system for applications using fontconfig.
  84       With <option>--verbose</option>, the whole font pattern
  85       for each font is printed, otherwise only the elements requested
  86       are printed (family and style if none provided).</para>
  87   </refsect1>
  88   <refsect1>
  89     <title>OPTIONS</title>
  90
  91     <para>This program follows the usual &gnu; command line syntax,
  92       with long options starting with two dashes (`-').  A summary of
  93       options is included below.</para>
  94
  95     <variablelist>
  96       <varlistentry>
  97         <term><option>-v</option>
  98           <option>--verbose</option>
  99         </term>
 100         <listitem>
 101           <para>Print whole font pattern for each match.  Provided
 102                 <replaceable>element</replaceable>s are ignored in this
 103                 case.</para>
 104         </listitem>
 105       </varlistentry>
 106       <varlistentry>
 107         <term><option>-f</option>
 108           <option>--format</option>
 109           <option><replaceable>format</replaceable></option>
 110         </term>
 111         <listitem>
 112           <para>Format output according to the format specifier
 113           <replaceable>format</replaceable>.</para>
 114         </listitem>
 115       </varlistentry>
 116       <varlistentry>
 117         <term><option>-V</option>
 118           <option>--version</option>
 119         </term>
 120         <listitem>
 121           <para>Show version of the program and exit.</para>
 122         </listitem>
 123       </varlistentry>
 124       <varlistentry>
 125         <term><option>-h</option>
 126           <option>--help</option>
 127         </term>
 128         <listitem>
 129           <para>Show summary of options.</para>
 130         </listitem>
 131       </varlistentry>
 132       <varlistentry>
 133         <term><option><replaceable>pattern</replaceable></option>
 134         </term>
 135         <listitem>
 136           <para>If this argument is set, only fonts matching
 137                 <replaceable>pattern</replaceable> are displayed.</para>
 138         </listitem>
 139       </varlistentry>
 140       <varlistentry>
 141         <term><option><replaceable>element</replaceable></option>
 142         </term>
 143         <listitem>
 144           <para>If set, the <replaceable>element</replaceable> property
 145                 is displayed for matching fonts.</para>
 146         </listitem>
 147       </varlistentry>
 148     </variablelist>
 149   </refsect1>
 150
 151   <refsect1>
 152     <title>EXAMPLES</title>
 153
 154     <variablelist>
 155       <varlistentry>
 156         <term>fc-list</term>
 157         <listitem><para>Lists all font faces.</para></listitem>
 158       </varlistentry>
 159       <varlistentry>
 160         <term>fc-list :lang=hi</term>
 161         <listitem><para>Lists font faces that cover Hindi.</para></listitem>
 162       </varlistentry>
 163       <varlistentry>
 164         <term>fc-list : family style file spacing </term>
 165         <listitem><para>Lists the filename and spacing value for each font
 166             face.  <quote>:</quote> is an empty pattern that matches all
 167             fonts.</para></listitem>
 168       </varlistentry>
 169     </variablelist>
 170
 171   </refsect1>
 172
 173   <refsect1>
 174     <title>SEE ALSO</title>
 175
 176     <para>
 177       <command>fc-cat</command>(1)
 178       <command>fc-cache</command>(1)
 179       <command>fc-match</command>(1)
 180       <command>fc-query</command>(1)
 181       <function>FcFontList</function>(3)
 182       <function>FcPatternFormat</function>(3)
 183     </para>
 184
 185     <para>The fontconfig user's guide, in HTML format:
 186       <filename>/usr/share/doc/fontconfig/fontconfig-user.html</filename>.</para>
 187
 188  </refsect1>
 189   <refsect1>
 190     <title>AUTHOR</title>
 191
 192     <para>This manual page was written by Keith Packard
 193       <email>keithp@keithp.com</email> and &dhusername; &dhemail;.</para>
 194
 195   </refsect1>
 196 </refentry>
 197
 198 <!-- Keep this comment at the end of the file
 199 Local variables:
 200 mode: sgml
 201 sgml-omittag:t
 202 sgml-shorttag:t
 203 sgml-minimize-attributes:nil
 204 sgml-always-quote-attributes:t
 205 sgml-indent-step:2
 206 sgml-indent-data:t
 207 sgml-parent-document:nil
 208 sgml-default-dtd-file:nil
 209 sgml-exposed-tags:nil
 210 sgml-local-catalogs:nil
 211 sgml-local-ecat-files:nil
 212 End:
 213 -->