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).
This commit is contained in:
parent
61895ed16c
commit
e3b65ee068
|
@ -149,10 +149,11 @@ static void
|
||||||
usage (char *program)
|
usage (char *program)
|
||||||
{
|
{
|
||||||
#if HAVE_GETOPT_LONG
|
#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);
|
program, FC_ARCHITECTURE);
|
||||||
|
fprintf (stderr, " %s [-V?] [--version] [--help]\n", program);
|
||||||
#else
|
#else
|
||||||
fprintf (stderr, "usage: %s [-fsvV?] {*-%s.cache-2|directory}...\n",
|
fprintf (stderr, "usage: %s [-rvV?] [*-%s.cache-2|directory]...\n",
|
||||||
program, FC_ARCHITECTURE);
|
program, FC_ARCHITECTURE);
|
||||||
#endif
|
#endif
|
||||||
fprintf (stderr, "Reads font information cache from:\n");
|
fprintf (stderr, "Reads font information cache from:\n");
|
||||||
|
@ -160,9 +161,13 @@ usage (char *program)
|
||||||
fprintf (stderr, " 2) related to a particular font directory\n");
|
fprintf (stderr, " 2) related to a particular font directory\n");
|
||||||
fprintf (stderr, "\n");
|
fprintf (stderr, "\n");
|
||||||
#if HAVE_GETOPT_LONG
|
#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, " -V, --version display font config version and exit\n");
|
||||||
fprintf (stderr, " -?, --help display this help and exit\n");
|
fprintf (stderr, " -?, --help display this help and exit\n");
|
||||||
#else
|
#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, " -V (version) display font config version and exit\n");
|
||||||
fprintf (stderr, " -? (help) display this help and exit\n");
|
fprintf (stderr, " -? (help) display this help and exit\n");
|
||||||
#endif
|
#endif
|
||||||
|
|
|
@ -61,11 +61,14 @@ manpage.1: manpage.sgml
|
||||||
</refnamediv>
|
</refnamediv>
|
||||||
<refsynopsisdiv>
|
<refsynopsisdiv>
|
||||||
<cmdsynopsis>
|
<cmdsynopsis>
|
||||||
<command>&dhpackage; < fonts-cache-2-file ></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>--version</option></arg>
|
||||||
<arg><option>--help</option></arg>
|
<arg><option>--help</option></arg>
|
||||||
|
<arg><option><replaceable>fonts-cache-2-files</replaceable></option></arg>
|
||||||
<arg><option><replaceable>dirs</replaceable></option></arg>
|
<arg><option><replaceable>dirs</replaceable></option></arg>
|
||||||
|
|
||||||
</cmdsynopsis>
|
</cmdsynopsis>
|
||||||
|
@ -73,7 +76,8 @@ manpage.1: manpage.sgml
|
||||||
<refsect1>
|
<refsect1>
|
||||||
<title>DESCRIPTION</title>
|
<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>
|
and emits it in ASCII form.</para>
|
||||||
|
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
@ -85,6 +89,22 @@ manpage.1: manpage.sgml
|
||||||
options is included below.</para>
|
options is included below.</para>
|
||||||
|
|
||||||
<variablelist>
|
<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>
|
<varlistentry>
|
||||||
<term><option>-?</option>
|
<term><option>-?</option>
|
||||||
<option>--help</option>
|
<option>--help</option>
|
||||||
|
|
Loading…
Reference in New Issue