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       <group>
  73         <arg><option>-q</option></arg>
  74         <arg><option>--quiet</option></arg>
  75       </group>
  76       <arg><option>--version</option></arg>
  77       <arg><option>--help</option></arg>
  78       <sbr>
  79       <arg><option><replaceable>pattern</replaceable></option> <arg rep="repeat"><option><replaceable>element</replaceable></option></arg> </arg>
  80
  81      </cmdsynopsis>
  82   </refsynopsisdiv>
  83   <refsect1>
  84     <title>DESCRIPTION</title>
  85
  86     <para><command>&dhpackage;</command> lists fonts and styles
  87       available on the system for applications using fontconfig.
  88       If any elements are specified, only those are printed.
  89       Otherwise family and style are printed, unless verbose
  90       output is requested.</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>-v</option>
 102           <option>--verbose</option>
 103         </term>
 104         <listitem>
 105           <para>Print verbose output of the whole font pattern for each match,
 106                 or <replaceable>element</replaceable>s if any is
 107                 provided.</para>
 108         </listitem>
 109       </varlistentry>
 110       <varlistentry>
 111         <term><option>-f</option>
 112           <option>--format</option>
 113           <option><replaceable>format</replaceable></option>
 114         </term>
 115         <listitem>
 116           <para>Format output according to the format specifier
 117           <replaceable>format</replaceable>.</para>
 118         </listitem>
 119       </varlistentry>
 120       <varlistentry>
 121         <term><option>-q</option>
 122           <option>--quiet</option>
 123         </term>
 124         <listitem>
 125           <para>Suppress all normal output. returns 1 as the error code if no fonts matched.</para>
 126         </listitem>
 127       </varlistentry>
 128       <varlistentry>
 129         <term><option>-V</option>
 130           <option>--version</option>
 131         </term>
 132         <listitem>
 133           <para>Show version of the program and exit.</para>
 134         </listitem>
 135       </varlistentry>
 136       <varlistentry>
 137         <term><option>-h</option>
 138           <option>--help</option>
 139         </term>
 140         <listitem>
 141           <para>Show summary of options.</para>
 142         </listitem>
 143       </varlistentry>
 144       <varlistentry>
 145         <term><option><replaceable>pattern</replaceable></option>
 146         </term>
 147         <listitem>
 148           <para>If this argument is set, only fonts matching
 149                 <replaceable>pattern</replaceable> are displayed.</para>
 150         </listitem>
 151       </varlistentry>
 152       <varlistentry>
 153         <term><option><replaceable>element</replaceable></option>
 154         </term>
 155         <listitem>
 156           <para>If set, the <replaceable>element</replaceable> property
 157                 is displayed for matching fonts.</para>
 158         </listitem>
 159       </varlistentry>
 160     </variablelist>
 161   </refsect1>
 162
 163   <refsect1>
 164     <title>EXAMPLES</title>
 165
 166     <variablelist>
 167       <varlistentry>
 168         <term>fc-list</term>
 169         <listitem><para>Lists all font faces.</para></listitem>
 170       </varlistentry>
 171       <varlistentry>
 172         <term>fc-list :lang=hi</term>
 173         <listitem><para>Lists font faces that cover Hindi.</para></listitem>
 174       </varlistentry>
 175       <varlistentry>
 176         <term>fc-list : family style file spacing </term>
 177         <listitem><para>Lists the filename and spacing value for each font
 178             face.  <quote>:</quote> is an empty pattern that matches all
 179             fonts.</para></listitem>
 180       </varlistentry>
 181     </variablelist>
 182
 183   </refsect1>
 184
 185   <refsect1>
 186     <title>SEE ALSO</title>
 187
 188     <para>
 189       <command>fc-match</command>(1)
 190       <function>FcFontList</function>(3)
 191       <function>FcPatternFormat</function>(3)
 192       <command>fc-cat</command>(1)
 193       <command>fc-cache</command>(1)
 194       <command>fc-pattern</command>(1)
 195       <command>fc-query</command>(1)
 196       <command>fc-scan</command>(1)
 197     </para>
 198
 199     <para>The fontconfig user's guide, in HTML format:
 200       <filename>/usr/share/doc/fontconfig/fontconfig-user.html</filename>.</para>
 201
 202  </refsect1>
 203   <refsect1>
 204     <title>AUTHOR</title>
 205
 206     <para>This manual page was written by Keith Packard
 207       <email>keithp@keithp.com</email> and &dhusername; &dhemail;.</para>
 208
 209   </refsect1>
 210 </refentry>
 211
 212 <!-- Keep this comment at the end of the file
 213 Local variables:
 214 mode: sgml
 215 sgml-omittag:t
 216 sgml-shorttag:t
 217 sgml-minimize-attributes:nil
 218 sgml-always-quote-attributes:t
 219 sgml-indent-step:2
 220 sgml-indent-data:t
 221 sgml-parent-document:nil
 222 sgml-default-dtd-file:nil
 223 sgml-exposed-tags:nil
 224 sgml-local-catalogs:nil
 225 sgml-local-ecat-files:nil
 226 End:
 227 -->