commit e3b65ee06808cda296215b88111a259a200cc37c
author Peter Breitenlohner <peb@mppmu.mpg.de> Sat Dec 02 15:09:57 2006 -0800
committer Keith Packard <keithp@neko.keithp.com> Sat Dec 02 15:09:57 2006 -0800
tree a5e01ee65541b0cf13cadb388777bbcb496826eb
parent 61895ed16c0c06e4d6b2abeb8ff292d53b4ea499

Fix fc-cat documentation (bug 8935).

Adapt documentation to reality.

(1) The fc-cat usage message should reflect the
options accepted by the program.

(2) The fc-cat.1 manpage was fairly broken (unreadable).

fc-cat/fc-cat.c

diff --git a/fc-cat/fc-cat.c b/fc-cat/fc-cat.c
index 476798e..a2c238c 100644
--- a/fc-cat/fc-cat.c
+++ b/fc-cat/fc-cat.c
@@ -149,10 +149,11 @@
 usage (char *program)
 {
 #if HAVE_GETOPT_LONG
-    fprintf (stderr, "usage: %s [-V?] [--version] [--help] {*-%s.cache-2|directory}...\n",
+    fprintf (stderr, "usage: %s [-rv] [--recurse] [--verbose] [*-%s.cache-2|directory]...\n",
 	     program, FC_ARCHITECTURE);
+    fprintf (stderr, "       %s [-V?] [--version] [--help]\n", program);
 #else
-    fprintf (stderr, "usage: %s [-fsvV?] {*-%s.cache-2|directory}...\n",
+    fprintf (stderr, "usage: %s [-rvV?] [*-%s.cache-2|directory]...\n",
 	     program, FC_ARCHITECTURE);
 #endif
     fprintf (stderr, "Reads font information cache from:\n"); 
@@ -160,9 +161,13 @@
     fprintf (stderr, " 2) related to a particular font directory\n");
     fprintf (stderr, "\n");
 #if HAVE_GETOPT_LONG
+    fprintf (stderr, "  -r, --recurse        recurse into subdirectories\n");
+    fprintf (stderr, "  -v, --verbose        be verbose\n");
     fprintf (stderr, "  -V, --version        display font config version and exit\n");
     fprintf (stderr, "  -?, --help           display this help and exit\n");
 #else
+    fprintf (stderr, "  -r         (recurse) recurse into subdirectories\n");
+    fprintf (stderr, "  -v         (verbose) be verbose\n");
     fprintf (stderr, "  -V         (version) display font config version and exit\n");
     fprintf (stderr, "  -?         (help)    display this help and exit\n");
 #endif

fc-cat/fc-cat.sgml

diff --git a/fc-cat/fc-cat.sgml b/fc-cat/fc-cat.sgml
index 812b0fa..cc06a75 100644
--- a/fc-cat/fc-cat.sgml
+++ b/fc-cat/fc-cat.sgml
@@ -61,11 +61,14 @@
   </refnamediv>
   <refsynopsisdiv>
     <cmdsynopsis>
-      <command>&dhpackage; &lt; fonts-cache-2-file &gt;</command>
+      <command>&dhpackage;</command>
 
-      <arg><option>-V?</option></arg>
+      <arg><option>-rvV?</option></arg>
+      <arg><option>--recurse</option></arg>
+      <arg><option>--verbose</option></arg>
       <arg><option>--version</option></arg>
       <arg><option>--help</option></arg>
+      <arg><option><replaceable>fonts-cache-2-files</replaceable></option></arg>
       <arg><option><replaceable>dirs</replaceable></option></arg>
       
      </cmdsynopsis>
@@ -73,7 +76,8 @@
   <refsect1>
     <title>DESCRIPTION</title>
 
-      <para><command>&dhpackage;</command> reads a font information cache file
+      <para><command>&dhpackage;</command> reads the font information from
+        cache files or related to font directories
         and emits it in ASCII form.</para>
 
   </refsect1>
@@ -86,6 +90,22 @@
 
     <variablelist>
       <varlistentry>
+        <term><option>-r</option>
+          <option>--recurse</option>
+        </term>
+        <listitem>
+          <para>Recurse into subdirectories.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>-v</option>
+          <option>--verbose</option>
+        </term>
+        <listitem>
+          <para>Be verbose.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
         <term><option>-?</option>
           <option>--help</option>
         </term>