fc-conflist/fc-conflist.sgml

   1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   2
   3 <!--
   4 Copyright © 2014 Red Hat, Inc.
   5
   6 Permission to use, copy, modify, distribute, and sell this software and its
   7 documentation for any purpose is hereby granted without fee, provided that
   8 the above copyright notice appear in all copies and that both that
   9 copyright notice and this permission notice appear in supporting
  10 documentation, and that the name of the author(s) not be used in
  11 advertising or publicity pertaining to distribution of the software without
  12 specific, written prior permission.  The authors make no
  13 representations about the suitability of this software for any purpose.  It
  14 is provided "as is" without express or implied warranty.
  15
  16 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  17 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  18 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  19 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  20 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  21 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  22 PERFORMANCE OF THIS SOFTWARE.
  23 -->
  24
  25 <!-- Process this file with docbook-to-man to generate an nroff manual
  26      page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
  27      the manual page with: `docbook-to-man manpage.sgml | nroff -man |
  28      less'.  A typical entry in a Makefile or Makefile.am is:
  29
  30 manpage.1: manpage.sgml
  31         docbook-to-man $< > $@
  32
  33
  34         The docbook-to-man binary is found in the docbook-to-man package.
  35         Please remember that if you create the nroff version in one of the
  36         debian/rules file targets (such as build), you will need to include
  37         docbook-to-man in your Build-Depends control field.
  38
  39   -->
  40
  41   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  42   <!ENTITY dhfirstname "<firstname>Akira</firstname>">
  43   <!ENTITY dhsurname   "<surname>TAGOH</surname>">
  44   <!-- Please adjust the date whenever revising the manpage. -->
  45   <!ENTITY dhdate      "<date>Dec 21, 2021</date>">
  46   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
  47        allowed: see man(7), man(1). -->
  48   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  49   <!ENTITY dhemail     "<email>akira@tagoh.org</email>">
  50   <!ENTITY dhusername  "Akira TAGOH">
  51   <!ENTITY dhucpackage "<refentrytitle>fc-conflist</refentrytitle>">
  52   <!ENTITY dhpackage   "fc-conflist">
  53
  54   <!ENTITY gnu         "<acronym>GNU</acronym>">
  55   <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
  56 ]>
  57
  58 <refentry>
  59   <refentryinfo>
  60     <address>
  61       &dhemail;
  62     </address>
  63     <author>
  64       &dhfirstname;
  65       &dhsurname;
  66     </author>
  67     <copyright>
  68       <year>2014</year>
  69       <holder>&dhusername;</holder>
  70     </copyright>
  71     &dhdate;
  72   </refentryinfo>
  73   <refmeta>
  74     &dhucpackage;
  75
  76     &dhsection;
  77   </refmeta>
  78   <refnamediv>
  79     <refname>&dhpackage;</refname>
  80
  81     <refpurpose>list the configuration files processed by Fontconfig</refpurpose>
  82   </refnamediv>
  83   <refsynopsisdiv>
  84     <cmdsynopsis>
  85       <command>&dhpackage;</command>
  86
  87       <arg><option>-Vh</option></arg>
  88       <sbr>
  89       <arg><option>--version</option></arg>
  90       <arg><option>--help</option></arg>
  91
  92      </cmdsynopsis>
  93   </refsynopsisdiv>
  94   <refsect1>
  95     <title>DESCRIPTION</title>
  96
  97     <para><command>&dhpackage;</command> prints an annotated list of all the configuration files processed by Fontconfig.</para>
  98     <para>The output is a `-' or `+' depending on whether the file is ignored or processed, a space, the file's path, a colon and space, and the description from the file or `No description' if none is present.</para>
  99     <para>The order of files looks like how fontconfig acautlly process them except one contains &lt;include&gt; element.
 100       In that case, it will be shown after processing all the sub directories where is targeted by &lt;include&gt;.</para>
 101
 102   </refsect1>
 103   <refsect1>
 104     <title>OPTIONS</title>
 105
 106     <para>This program follows the usual &gnu; command line syntax,
 107       with long options starting with two dashes (`-').  A summary of
 108       options is included below.</para>
 109
 110     <variablelist>
 111       <varlistentry>
 112         <term><option>-V</option>
 113           <option>--version</option>
 114         </term>
 115         <listitem>
 116           <para>Show version of the program and exit.</para>
 117         </listitem>
 118       </varlistentry>
 119       <varlistentry>
 120         <term><option>-h</option>
 121           <option>--help</option>
 122         </term>
 123         <listitem>
 124           <para>Show summary of options.</para>
 125         </listitem>
 126       </varlistentry>
 127     </variablelist>
 128   </refsect1>
 129
 130   <refsect1>
 131     <title>RETURN CODES</title>
 132     <para><command>fc-conflist</command> returns error code 0 for successful parsing,
 133     or 1 if any errors occurred or if at least one font face could not be opened.</para>
 134   </refsect1>
 135
 136   <refsect1>
 137     <title>AUTHOR</title>
 138
 139     <para>This manual page was updated by &dhusername; &dhemail;.</para>
 140
 141   </refsect1>
 142 </refentry>
 143
 144 <!-- Keep this comment at the end of the file
 145 Local variables:
 146 mode: sgml
 147 sgml-omittag:t
 148 sgml-shorttag:t
 149 sgml-minimize-attributes:nil
 150 sgml-always-quote-attributes:t
 151 sgml-indent-step:2
 152 sgml-indent-data:t
 153 sgml-parent-document:nil
 154 sgml-default-dtd-file:nil
 155 sgml-exposed-tags:nil
 156 sgml-local-catalogs:nil
 157 sgml-local-ecat-files:nil
 158 End:
 159 -->