[xml] [PATCH (follow-up)] xmlcatalog: refresh man page wrt. quering system catalog easily



Also normalize "lookup" spelling.

Signed-off-by: Jan Pokorný <jpokorny redhat com>
---
 doc/xmlcatalog_man.xml | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

Thanks, Nick.

Please accept also this follow-up, then.  Note two things:

1. xmlcatalog.1 will be generated automatically from xmlcatalog_man.xml
   upon "make -C doc docs" once libxml2 is configured with
   --enable-rebuild-docs (hence I expect I don't need to care about that)

2. I don't see any hook to refresh xmlcatalog_man.html in the build system,
   and indeed, that file seems to be quite stale -- I suggest either
   adding a hook to have that file (and possibly more like that) refreshed
   (leveraging html/docbook.xsl from DocBook distribution) or drop that
   (and possibly more) altogether

diff --git a/doc/xmlcatalog_man.xml b/doc/xmlcatalog_man.xml
index 049ed8f..b3ce8b2 100644
--- a/doc/xmlcatalog_man.xml
+++ b/doc/xmlcatalog_man.xml
@@ -230,6 +230,21 @@
                </varlistentry>
        
        </variablelist>
+
+       <para>
+               Invoking &xmlcatalog; non-interactively without a designated action
+               (imposed with options like <option>--add</option>) will result in a lookup
+               of the catalog entry for <replaceable>ENTITIES</replaceable> in the
+               catalog denoted with <replaceable>CATALOGFILE</replaceable>. The
+               corresponding entries will be output to the command line. This mode of
+               operation, together with <option>--shell</option> mode and non-modifying
+               (i.e. without <option>--noout</option>) direct actions, allows for
+               a special shortcut of the void <replaceable>CATALOGFILE</replaceable>
+               specification (possibly expressed as &quot;&quot; in the shell
+               environment) appointing the default system catalog. That simplifies the
+               handling when its exact location is irrelevant but the respective built-in
+               still needs to be consulted.
+       </para>
 </refsect1>
 
 <refsect1 id="shell">
@@ -315,7 +330,7 @@
        <term><option>public <replaceable>PUBLIC-ID</replaceable></option></term>
        <listitem>
                <para>
-                       Execute a Formal Public Identifier look-up of the catalog entry
+                       Execute a Formal Public Identifier lookup of the catalog entry
                        for <replaceable>PUBLIC-ID</replaceable>. The corresponding entry will be
                        output to the command line.
                </para>
@@ -333,7 +348,7 @@
        <term><option>system <replaceable>SYSTEM-ID</replaceable></option></term>
        <listitem>
                <para>
-                       Execute a Formal Public Identifier look-up of the catalog entry
+                       Execute a Formal Public Identifier lookup of the catalog entry
                        for <replaceable>SYSTEM-ID</replaceable>. The corresponding entry will be
                        output to the command line.
                </para>
-- 
2.4.11


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]