[libxml2] xmlcatalog: refresh man page wrt. quering system catalog easily



commit ca01f8133eff5a5fe4fa542c0161c75bc702f253
Author: Jan Pokorný <jpokorny redhat com>
Date:   Tue Oct 24 13:51:34 2017 +0200

    xmlcatalog: refresh man page wrt. quering system catalog easily
    
    Also normalize "lookup" spelling.

 doc/xmlcatalog.1       |   22 ++++++++++++++++------
 doc/xmlcatalog_man.xml |   19 +++++++++++++++++--
 2 files changed, 33 insertions(+), 8 deletions(-)
---
diff --git a/doc/xmlcatalog.1 b/doc/xmlcatalog.1
index b4a6b22..432a32a 100644
--- a/doc/xmlcatalog.1
+++ b/doc/xmlcatalog.1
@@ -1,7 +1,7 @@
 '\" t
 .\"     Title: xmlcatalog
 .\"    Author: John Fleck <jfleck inkstain net>
-.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
 .\"      Date: $Date$
 .\"    Manual: xmlcatalog Manual
 .\"    Source: libxml2
@@ -34,7 +34,6 @@ xmlcatalog \- Command line tool to parse and manipulate XML or SGML catalog file
 \fBxmlcatalog\fR [\fB\-\-sgml\fR | \fB\-\-shell\fR | \fB\-\-create\fR | \fB\-\-del\ \fR\fB\fIVALUE(S)\fR\fR 
| [\ \fB\-\-add\ \fR\fB\fITYPE\fR\fR\fB\ \fR\fB\fIORIG\fR\fR\fB\ \fR\fB\fIREPLACE\fR\fR\fB\ \fR\ |\ 
\fB\-\-add\ \fR\fB\fIFILENAME\fR\fR] | \fB\-\-noout\fR | \fB\-\-no\-super\-update\fR | [\fB\-v\fR\ |\ 
\fB\-\-verbose\fR]] {\fICATALOGFILE\fR} {\fIENTITIES\fR...}
 .SH "DESCRIPTION"
 .PP
-
 \fBxmlcatalog\fR
 is a command line application allowing users to monitor and manipulate
 XML
@@ -50,7 +49,6 @@ SGML
 files\&.
 .SH "OPTIONS"
 .PP
-
 \fBxmlcatalog\fR
 accepts the following options (in alphabetical order):
 .PP
@@ -155,6 +153,19 @@ options\&.
 .RS 4
 Output debugging information\&.
 .RE
+.PP
+Invoking
+\fBxmlcatalog\fR
+non\-interactively without a designated action (imposed with options like
+\fB\-\-add\fR) will result in a lookup of the catalog entry for
+\fIENTITIES\fR
+in the catalog denoted with
+\fICATALOGFILE\fR\&. The corresponding entries will be output to the command line\&. This mode of operation, 
together with
+\fB\-\-shell\fR
+mode and non\-modifying (i\&.e\&. without
+\fB\-\-noout\fR) direct actions, allows for a special shortcut of the void
+\fICATALOGFILE\fR
+specification (possibly expressed as "" 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\&.
 .SH "SHELL COMMANDS"
 .PP
 Invoking
@@ -213,7 +224,7 @@ Quit the shell\&.
 .PP
 \fBpublic \fR\fB\fIPUBLIC\-ID\fR\fR
 .RS 4
-Execute a Formal Public Identifier look\-up of the catalog entry for
+Execute a Formal Public Identifier lookup of the catalog entry for
 \fIPUBLIC\-ID\fR\&. The corresponding entry will be output to the command line\&.
 .RE
 .PP
@@ -224,7 +235,7 @@ Stop printing debugging statements\&.
 .PP
 \fBsystem \fR\fB\fISYSTEM\-ID\fR\fR
 .RS 4
-Execute a Formal Public Identifier look\-up of the catalog entry for
+Execute a Formal Public Identifier lookup of the catalog entry for
 \fISYSTEM\-ID\fR\&. The corresponding entry will be output to the command line\&.
 .RE
 .SH "ENVIRONMENT"
@@ -240,7 +251,6 @@ catalog\&.
 .RE
 .SH "DIAGNOSTICS"
 .PP
-
 \fBxmlcatalog\fR
 return codes provide information that can be used when calling it from scripts\&.
 .PP
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>


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