fc-list.sgml 6.77 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Josselin</firstname>">
  <!ENTITY dhsurname   "<surname>Mouette</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
Behdad Esfahbod's avatar
Behdad Esfahbod committed
23
  <!ENTITY dhdate      "<date>Aug 13, 2008</date>">
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>joss@debian.org</email>">
  <!ENTITY dhusername  "Josselin Mouette">
  <!ENTITY dhucpackage "<refentrytitle>fc-list</refentrytitle>">
  <!ENTITY dhpackage   "fc-list">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2003</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>list available fonts</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

66
      <arg><option>-vVh</option></arg>
67
      <arg><option>--verbose</option></arg>
68 69 70 71
      <group>
        <arg><option>-f</option> <option><replaceable>format</replaceable></option></arg>
        <arg><option>--format</option> <option><replaceable>format</replaceable></option></arg>
      </group>
72 73 74 75
      <group>
	<arg><option>-q</option></arg>
	<arg><option>--quiet</option></arg>
      </group>
76 77
      <arg><option>--version</option></arg>
      <arg><option>--help</option></arg>
Behdad Esfahbod's avatar
Behdad Esfahbod committed
78 79
      <sbr>
      <arg><option><replaceable>pattern</replaceable></option> <arg rep="repeat"><option><replaceable>element</replaceable></option></arg> </arg>
80 81 82 83 84 85 86
      
     </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para><command>&dhpackage;</command> lists fonts and styles
87
      available on the system for applications using fontconfig.
88 89 90
      If any elements are specified, only those are printed.
      Otherwise family and style are printed, unless verbose
      output is requested.</para>
91 92 93 94 95 96 97 98 99 100 101 102 103 104
  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>This program follows the usual &gnu; command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below.</para>

    <variablelist>
      <varlistentry>
        <term><option>-v</option>
          <option>--verbose</option>
        </term>
        <listitem>
105 106 107
          <para>Print verbose output of the whole font pattern for each match,
	        or <replaceable>element</replaceable>s if any is
		provided.</para>
108 109 110
        </listitem>
      </varlistentry>
      <varlistentry>
111 112 113
        <term><option>-f</option>
          <option>--format</option>
	  <option><replaceable>format</replaceable></option>
114 115
        </term>
        <listitem>
116 117
          <para>Format output according to the format specifier
	  <replaceable>format</replaceable>.</para>
118 119
        </listitem>
      </varlistentry>
120 121 122 123 124 125 126 127
      <varlistentry>
	<term><option>-q</option>
	  <option>--quiet</option>
	</term>
	<listitem>
	  <para>Suppress all normal output. returns 1 as the error code if no fonts matched.</para>
	</listitem>
      </varlistentry>
128 129 130 131 132 133 134 135
      <varlistentry>
        <term><option>-V</option>
          <option>--version</option>
        </term>
        <listitem>
          <para>Show version of the program and exit.</para>
        </listitem>
      </varlistentry>
136 137 138 139 140 141 142 143
      <varlistentry>
        <term><option>-h</option>
          <option>--help</option>
        </term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
      <varlistentry>
        <term><option><replaceable>pattern</replaceable></option>
        </term>
        <listitem>
          <para>If this argument is set, only fonts matching
                <replaceable>pattern</replaceable> are displayed.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option><replaceable>element</replaceable></option>
        </term>
        <listitem>
          <para>If set, the <replaceable>element</replaceable> property
                is displayed for matching fonts.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
Noah Levitt's avatar
Noah Levitt committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184

  <refsect1>
    <title>EXAMPLES</title>

    <variablelist>
      <varlistentry>
        <term>fc-list</term>
        <listitem><para>Lists all font faces.</para></listitem>
      </varlistentry>
      <varlistentry>
        <term>fc-list :lang=hi</term>
        <listitem><para>Lists font faces that cover Hindi.</para></listitem>
      </varlistentry>
      <varlistentry>
        <term>fc-list : family style file spacing </term>
        <listitem><para>Lists the filename and spacing value for each font
            face.  <quote>:</quote> is an empty pattern that matches all
            fonts.</para></listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

185 186 187
  <refsect1>
    <title>SEE ALSO</title>

Behdad Esfahbod's avatar
Behdad Esfahbod committed
188 189
    <para>
      <command>fc-match</command>(1)
190 191
      <function>FcFontList</function>(3)
      <function>FcPatternFormat</function>(3)
192 193
      <command>fc-cat</command>(1)
      <command>fc-cache</command>(1)
194
      <command>fc-pattern</command>(1)
195 196
      <command>fc-query</command>(1)
      <command>fc-scan</command>(1)
Behdad Esfahbod's avatar
Behdad Esfahbod committed
197
    </para>
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227

    <para>The fontconfig user's guide, in HTML format:
      <filename>/usr/share/doc/fontconfig/fontconfig-user.html</filename>.</para>

 </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by Keith Packard
      <email>keithp@keithp.com</email> and &dhusername; &dhemail;.</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->