Skip to content

Commit ca01f81

Browse files
jnpkrnnwellnhof
authored andcommitted
xmlcatalog: refresh man page wrt. quering system catalog easily
Also normalize "lookup" spelling.
1 parent 6b780f6 commit ca01f81

File tree

2 files changed

+33
-8
lines changed

2 files changed

+33
-8
lines changed

doc/xmlcatalog.1

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
'\" t
22
.\" Title: xmlcatalog
33
.\" Author: John Fleck <[email protected]>
4-
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
4+
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
55
.\" Date: $Date$
66
.\" Manual: xmlcatalog Manual
77
.\" Source: libxml2
@@ -34,7 +34,6 @@ xmlcatalog \- Command line tool to parse and manipulate XML or SGML catalog file
3434
\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...}
3535
.SH "DESCRIPTION"
3636
.PP
37-
3837
\fBxmlcatalog\fR
3938
is a command line application allowing users to monitor and manipulate
4039
XML
@@ -50,7 +49,6 @@ SGML
5049
files\&.
5150
.SH "OPTIONS"
5251
.PP
53-
5452
\fBxmlcatalog\fR
5553
accepts the following options (in alphabetical order):
5654
.PP
@@ -155,6 +153,19 @@ options\&.
155153
.RS 4
156154
Output debugging information\&.
157155
.RE
156+
.PP
157+
Invoking
158+
\fBxmlcatalog\fR
159+
non\-interactively without a designated action (imposed with options like
160+
\fB\-\-add\fR) will result in a lookup of the catalog entry for
161+
\fIENTITIES\fR
162+
in the catalog denoted with
163+
\fICATALOGFILE\fR\&. The corresponding entries will be output to the command line\&. This mode of operation, together with
164+
\fB\-\-shell\fR
165+
mode and non\-modifying (i\&.e\&. without
166+
\fB\-\-noout\fR) direct actions, allows for a special shortcut of the void
167+
\fICATALOGFILE\fR
168+
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\&.
158169
.SH "SHELL COMMANDS"
159170
.PP
160171
Invoking
@@ -213,7 +224,7 @@ Quit the shell\&.
213224
.PP
214225
\fBpublic \fR\fB\fIPUBLIC\-ID\fR\fR
215226
.RS 4
216-
Execute a Formal Public Identifier look\-up of the catalog entry for
227+
Execute a Formal Public Identifier lookup of the catalog entry for
217228
\fIPUBLIC\-ID\fR\&. The corresponding entry will be output to the command line\&.
218229
.RE
219230
.PP
@@ -224,7 +235,7 @@ Stop printing debugging statements\&.
224235
.PP
225236
\fBsystem \fR\fB\fISYSTEM\-ID\fR\fR
226237
.RS 4
227-
Execute a Formal Public Identifier look\-up of the catalog entry for
238+
Execute a Formal Public Identifier lookup of the catalog entry for
228239
\fISYSTEM\-ID\fR\&. The corresponding entry will be output to the command line\&.
229240
.RE
230241
.SH "ENVIRONMENT"
@@ -240,7 +251,6 @@ catalog\&.
240251
.RE
241252
.SH "DIAGNOSTICS"
242253
.PP
243-
244254
\fBxmlcatalog\fR
245255
return codes provide information that can be used when calling it from scripts\&.
246256
.PP

doc/xmlcatalog_man.xml

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,21 @@
230230
</varlistentry>
231231

232232
</variablelist>
233+
234+
<para>
235+
Invoking &xmlcatalog; non-interactively without a designated action
236+
(imposed with options like <option>--add</option>) will result in a lookup
237+
of the catalog entry for <replaceable>ENTITIES</replaceable> in the
238+
catalog denoted with <replaceable>CATALOGFILE</replaceable>. The
239+
corresponding entries will be output to the command line. This mode of
240+
operation, together with <option>--shell</option> mode and non-modifying
241+
(i.e. without <option>--noout</option>) direct actions, allows for
242+
a special shortcut of the void <replaceable>CATALOGFILE</replaceable>
243+
specification (possibly expressed as &quot;&quot; in the shell
244+
environment) appointing the default system catalog. That simplifies the
245+
handling when its exact location is irrelevant but the respective built-in
246+
still needs to be consulted.
247+
</para>
233248
</refsect1>
234249

235250
<refsect1 id="shell">
@@ -315,7 +330,7 @@
315330
<term><option>public <replaceable>PUBLIC-ID</replaceable></option></term>
316331
<listitem>
317332
<para>
318-
Execute a Formal Public Identifier look-up of the catalog entry
333+
Execute a Formal Public Identifier lookup of the catalog entry
319334
for <replaceable>PUBLIC-ID</replaceable>. The corresponding entry will be
320335
output to the command line.
321336
</para>
@@ -333,7 +348,7 @@
333348
<term><option>system <replaceable>SYSTEM-ID</replaceable></option></term>
334349
<listitem>
335350
<para>
336-
Execute a Formal Public Identifier look-up of the catalog entry
351+
Execute a Formal Public Identifier lookup of the catalog entry
337352
for <replaceable>SYSTEM-ID</replaceable>. The corresponding entry will be
338353
output to the command line.
339354
</para>

0 commit comments

Comments
 (0)