1
0
mirror of https://gitlab.gnome.org/GNOME/libxml2.git synced 2024-10-26 20:25:14 +03:00

doc/xmlcatalog.1 doc/xmlcatalog_man.html doc/xmlcatalog_man.xml belatedly

Sun Jan 26 17:02:29 MST 2003 John Fleck <jfleck@inkstain.net>

	* doc/xmlcatalog.1
	* doc/xmlcatalog_man.html
	* doc/xmlcatalog_man.xml
	belatedly fixing bug #93622 (adds rewriteURI type to
	"--add" option in xmlcatalog man page
This commit is contained in:
MST 2003 John Fleck 2003-01-27 00:04:32 +00:00 committed by John Fleck
parent 3be27518c9
commit 937362d30c
4 changed files with 133 additions and 109 deletions

View File

@ -1,3 +1,11 @@
Sun Jan 26 17:02:29 MST 2003 John Fleck <jfleck@inkstain.net>
* doc/xmlcatalog.1
* doc/xmlcatalog_man.html
* doc/xmlcatalog_man.xml
belatedly fixing bug #93622 (adds rewriteURI type to
"--add" option in xmlcatalog man page
Sun Jan 26 20:47:26 CET 2003 Daniel Veillard <daniel@veillard.com>
* xmlcatalog.c xmllint.c: applied patch for FreeBSD by

View File

@ -1,4 +1,4 @@
."Generated by db2man.xsl. Don't modify this, modify the source.
.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
@ -17,100 +17,113 @@
.el .ne 3
.IP "\\$1" \\$2
..
.TH "xmlcatalog" 1 "" "" "xmlcatalog Manual"
.TH "XMLCATALOG" 1 "" "" "xmlcatalog Manual"
.SH NAME
xmlcatalog \- Command line tool to parse and manipulate XML or
SGML catalog files.
xmlcatalog \- Command line tool to parse and manipulate XML or SGML catalog files.
.SH "SYNOPSIS"
\fBxmlcatalog\fR [\fB--shell\fR | \fB--create\fR | \fB--add \fItype\fR
\fIorig\fR \fIreplace\fR \fR | \fB--del \fIvalues\fR \fR | \fB--noout\fR | \fB--verbose\fR] [\fB\fIcatalogfile\fR\fR] [\fB\fIentities\fR\fR]
.nf
\fBxmlcatalog\fR [\fB--shell\fR | \fB--create\fR | \fB--add \fItype\fR \fIorig\fR \fIreplace\fR\fR
| \fB--del \fIvalues\fR\fR | \fB--noout\fR | \fB--verbose\fR] [\fB\fIcatalogfile\fR\fR]
[\fB\fIentities\fR\fR]
.fi
.SH "INTRODUCTION"
.PP
xmlcatalog is a command line application allowing users to monitor and manipulate XML and SGML catalogs. It is included in libxml2.
xmlcatalog is a command line application allowing users to monitor and manipulate XML and SGML catalogs\&. It is included in libxml2\&.
.PP
Its functions can be invoked from a single command from the command line, or it can perform multiple functions in interactive mode. It can operate on both XML and SGML files.
Its functions can be invoked from a single command from the command line, or it can perform multiple functions in interactive mode\&. It can operate on both XML and SGML files\&.
.SH "COMMAND LINE OPTIONS"
.TP
\fB--shell\fR \fIfilename\fR
Run a shell allowing interactive queries on catalog file \fIfilename\fR.
Run a shell allowing interactive queries on catalog file \fIfilename\fR\&.
.TP
\fB--create\fR \fIfilename\fR
Create a new XML catalog. Outputs to stdout, ignoring \fIfilename\fR unless \fB--noout\fR is used, in which case it creates a new catalog file \fIfilename\fR.
Create a new XML catalog\&. Outputs to stdout, ignoring \fIfilename\fR unless \fB--noout\fR is used, in which case it creates a new catalog file \fIfilename\fR\&.
.TP
\fB--add\fR \fI'type'\fR \fI'orig'\fR \fI'replace'\fR \fIfilename\fR
Add an entry to catalog file \fIfilename\fR\&. \fItype\fR indicates the type of entry\&. Possible types are 'public', 'system', 'rewriteSystem', 'delegatePublic', 'delegateSystem'amd 'rewriteURI'\&. \fI'orig'\fR is the original reference to be replaced, and \fI'replace'\fR is the URI of the replacement entity to be used\&. The \fB--add\fR option will not overwrite \fIfilename\fR, outputing to stdout, unless \fB--noout\fR is used\&. The \fB--add\fR will always take three parameters even if some of the XML catalog constructs will have only a single argument\&.
Add an entry to catalog file \fIfilename\fR. \fItype\fR indicates the type of entry. Possible types are 'public', 'system', 'rewriteSystem', 'delegatePublic' and 'delegateSystem'. \fI'orig'\fR is the original reference to be replaced, and \fI'replace'\fR is the URI of the replacement entity to be used. The \fB--add\fR option will not overwrite \fIfilename\fR, outputing to stdout, unless \fB--noout\fR is used. The \fB--add\fR will always take three parameters even if some of the XML catalog constructs will have only a single argument.
If the \fB--add\fR option is used following the \fB--sgml\fR option, only a single argument, a \fIfilename\fR, is used. This is used to add the name of a catalog file to an SGML supercatalog, a file that contains references to other included SGML catalog files.
If the \fB--add\fR option is used following the \fB--sgml\fR option, only a single argument, a \fIfilename\fR, is used\&. This is used to add the name of a catalog file to an SGML supercatalog, a file that contains references to other included SGML catalog files\&.
.TP
\fB--del\fR \fI'values'\fR \fIfilename\fR
Remove entries from the catalog file \fIfilename\fR matching \fI'values'\fR. The \fB--del\fR option will not overwrite \fIfilename\fR, outputing to stdout, unless \fB--noout\fR is used.
Remove entries from the catalog file \fIfilename\fR matching \fI'values'\fR\&. The \fB--del\fR option will not overwrite \fIfilename\fR, outputing to stdout, unless \fB--noout\fR is used\&.
.TP
\fB--noout\fR
Save output to the named file rather than outputing to stdout\&.
Save output to the named file rather than outputing to stdout.
.TP
\fB--sgml\fR
Uses SGML Super catalogs for --add and --del options
.TP
\fB-v\fR or \fB--verbose\fR
output debugging information.
output debugging information\&.
.SH "SHELL COMMANDS"
.PP
Invoking xmlcatalog with the \fB--shell\fR \fIfilename\fR option opens a command line shell allowing interactive access to the catalog file identified by \fIfilename\fR. Invoking the shell provides a command line prompt after which commands can be entered.
Invoking xmlcatalog with the \fB--shell\fR \fIfilename\fR option opens a command line shell allowing interactive access to the catalog file identified by \fIfilename\fR\&. Invoking the shell provides a command line prompt after which commands can be entered\&.
.TP
\fBpublic\fR \fI'PublicID'\fR
Execute a public identifier lookup of the catalog entry for \fI'PublicID'\fR. The corresponding entry will be output to the command line.
Execute a public identifier lookup of the catalog entry for \fI'PublicID'\fR\&. The corresponding entry will be output to the command line\&.
.TP
\fBsystem\fR \fI'SystemID'\fR
Execute a public identifier lookup of the catalog entry for \fI'SystemID'\fR. The corresponding entry will be output to the command line.
Execute a public identifier lookup of the catalog entry for \fI'SystemID'\fR\&. The corresponding entry will be output to the command line\&.
.TP
\fBadd \fR \fI'type'\fR \fI'orig'\fR \fI'replace'\fR
Add an entry to the catalog file. \fItype\fR indicates the type of entry. Possible types are 'public', 'system', 'rewriteSystem', 'delegatePublic' and 'delegateSystem'. \fI'orig'\fR is the original reference to be replaced, and \fI'replace'\fR is the URI of the replacement entity to be used.
Add an entry to the catalog file\&. \fItype\fR indicates the type of entry\&. Possible types are 'public', 'system', 'rewriteSystem', 'delegatePublic' and 'delegateSystem'\&. \fI'orig'\fR is the original reference to be replaced, and \fI'replace'\fR is the URI of the replacement entity to be used\&.
.TP
\fBdel\fR \fI'values'\fR
Remove the catalog entry corresponding to \fI'values'\fR.
Remove the catalog entry corresponding to \fI'values'\fR\&.
.TP
\fBdump\fR
Print the current catalog.
Print the current catalog\&.
.TP
\fBdebug\fR
Print debugging statements showing the steps xmlcatalog is executing.
Print debugging statements showing the steps xmlcatalog is executing\&.
.TP
\fBquiet\fR
Stop printing debugging statements.
Stop printing debugging statements\&.
.TP
\fBexit\fR
Quit the shell\&.
Quit the shell.
.SH "RETURN VALUES"
.PP
xmlcatalog's return codes provide information that can be used when calling it from scripts\&.
.PP
0: normal
.PP
1: Failed to remove an entry from the catalog
.PP
2: Failed to save to the catalog, check file permissions
.PP
3: Failed to add an entry to the catalog
.PP
4: Failed to lookup and entry in the catalog
.SH "REFERENCES"
@ -127,6 +140,4 @@ James Clark's SGML catalog page:: \fIhttp://www.jclark.com/sp/catalog.htm\fR
OASIS XML catalog specification: : \fIhttp://www.oasis-open.org/committees/entity/spec.html\fR
.SH AUTHOR
Copyright 2001
.Sp
John Fleck <jfleck@inkstain.net>This is release 0.2 of the xmlcatalog Manual.
John Fleck.

View File

@ -1,93 +1,97 @@
<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>xmlcatalog</title><meta name="generator" content="DocBook XSL Stylesheets V1.45"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"><h1 class="title">xmlcatalog</h1><div class="refnamediv"><h2>Name</h2><p>xmlcatalog &#8212; Command line tool to parse and manipulate XML or
SGML catalog files.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>xmlcatalog</tt> [--shell | --create | --add <i><tt>type</tt></i>
<i><tt>orig</tt></i> <i><tt>replace</tt></i> | --del <i><tt>values</tt></i> | --noout | --verbose] [<tt><i><tt>catalogfile</tt></i></tt>] [<tt><i><tt>entities</tt></i></tt>]</p></div></div><div class="refsect1"><a name="introduction"></a><h2>Introduction</h2><p>
xmlcatalog is a command line application
allowing users to monitor and manipulate XML and
SGML catalogs. It is included in
libxml2.
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xmlcatalog</title><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="id2590168"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>xmlcatalog &#8212; Command line tool to parse and manipulate <span class="acronym">XML</span> or
<span class="acronym">SGML</span> catalog files.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">xmlcatalog</tt> [[--shell] | [--create] | [--add <i class="replaceable"><tt>type</tt></i>
<i class="replaceable"><tt>orig</tt></i> <i class="replaceable"><tt>replace</tt></i>] | [--del <i class="replaceable"><tt>values</tt></i>] | [--noout] | [--verbose]] [<tt class="option"><i class="replaceable"><tt>catalogfile</tt></i></tt>] [<tt class="option"><i class="replaceable"><tt>entities</tt></i></tt>]</p></div></div><div class="refsect1" lang="en"><a name="introduction"></a><h2>Introduction</h2><p>
<span class="application">xmlcatalog</span> is a command line application
allowing users to monitor and manipulate <span class="acronym">XML</span> and
<span class="acronym">SGML</span> catalogs. It is included in
<span class="application">libxml2</span>.
</p><p>
Its functions can be invoked from a single command from the command line,
or it can perform multiple functions in interactive mode. It can operate
on both XML and SGML files.
</p></div><div class="refsect1"><a name="cloptions"></a><h2>Command Line Options</h2><div class="variablelist"><dl><dt><span class="term"><tt>--shell</tt> <i><tt>filename</tt></i></span></dt><dd>
on both <span class="acronym">XML</span> and <span class="acronym">SGML</span> files.
</p></div><div class="refsect1" lang="en"><a name="cloptions"></a><h2>Command Line Options</h2><div class="variablelist"><dl><dt><span class="term"><tt class="option">--shell</tt> <i class="replaceable"><tt>filename</tt></i></span></dt><dd>
Run a shell
allowing interactive queries on catalog file
<i><tt>filename</tt></i>.
</dd><dt><span class="term"><tt>--create</tt> <i><tt>filename</tt></i></span></dt><dd>
<i class="replaceable"><tt>filename</tt></i>.
</dd><dt><span class="term"><tt class="option">--create</tt> <i class="replaceable"><tt>filename</tt></i></span></dt><dd>
Create a new
XML catalog. Outputs to stdout, ignoring
<i><tt>filename</tt></i> unless <tt>--noout</tt> is
<span class="acronym">XML</span> catalog. Outputs to stdout, ignoring
<i class="replaceable"><tt>filename</tt></i> unless <tt class="option">--noout</tt> is
used, in which case it creates a new catalog file
<i><tt>filename</tt></i>.
</dd><dt><span class="term"><tt>--add</tt> <i><tt>'type'</tt></i> <i><tt>'orig'</tt></i> <i><tt>'replace'</tt></i> <i><tt>filename</tt></i></span></dt><dd><p>
<i class="replaceable"><tt>filename</tt></i>.
</dd><dt><span class="term"><tt class="option">--add</tt> <i class="replaceable"><tt>'type'</tt></i> <i class="replaceable"><tt>'orig'</tt></i> <i class="replaceable"><tt>'replace'</tt></i> <i class="replaceable"><tt>filename</tt></i></span></dt><dd><p>
Add an entry to catalog file
<tt>filename</tt>. <i><tt>type</tt></i> indicates
the type of entry. Possible types are 'public', 'system', 'rewriteSystem',
'delegatePublic' and 'delegateSystem'. <i><tt>'orig'</tt></i>
is the original reference to
be replaced, and <i><tt>'replace'</tt></i> is the
URI of the replacement entity to be used. The
<tt>--add</tt> option will not overwrite
<i><tt>filename</tt></i>, outputing to stdout, unless
<tt>--noout</tt> is used. The <tt>--add</tt> will always
take three parameters even if some of the XML catalog
constructs will have only a single argument.
<tt class="filename">filename</tt>. <i class="replaceable"><tt>type</tt></i>
indicates the type of entry. Possible types are 'public', 'system',
'rewriteSystem', 'delegatePublic', 'delegateSystem'amd
'rewriteURI'. <i class="replaceable"><tt>'orig'</tt></i> is the original
reference to be replaced, and <i class="replaceable"><tt>'replace'</tt></i>
is the <span class="acronym">URI</span> of the replacement entity to be
used. The <tt class="option">--add</tt> option will not overwrite
<i class="replaceable"><tt>filename</tt></i>, outputing to stdout, unless
<tt class="option">--noout</tt> is used. The <tt class="option">--add</tt> will
always take three parameters even if some of the
<span class="acronym">XML</span> catalog constructs will have only a single
argument.
</p><p>
If the <tt>--add</tt> option is used following the
<tt>--sgml</tt> option, only a single argument, a
<i><tt>filename</tt></i>, is used. This is used to add
the name of a catalog file to an SGML
If the <tt class="option">--add</tt> option is used following the
<tt class="option">--sgml</tt> option, only a single argument, a
<i class="replaceable"><tt>filename</tt></i>, is used. This is used to add
the name of a catalog file to an <span class="acronym">SGML</span>
supercatalog, a file that contains references to other included
SGML catalog files.
</p></dd><dt><span class="term"><tt>--del</tt> <i><tt>'values'</tt></i> <i><tt>filename</tt></i></span></dt><dd>
<span class="acronym">SGML</span> catalog files.
</p></dd><dt><span class="term"><tt class="option">--del</tt> <i class="replaceable"><tt>'values'</tt></i> <i class="replaceable"><tt>filename</tt></i></span></dt><dd>
Remove entries from the catalog file
<i><tt>filename</tt></i> matching
<i><tt>'values'</tt></i>. The <tt>--del</tt> option
will not overwrite <i><tt>filename</tt></i>, outputing to
stdout, unless <tt>--noout</tt> is used.
</dd><dt><span class="term"><tt>--noout</tt></span></dt><dd>
<i class="replaceable"><tt>filename</tt></i> matching
<i class="replaceable"><tt>'values'</tt></i>. The <tt class="option">--del</tt> option
will not overwrite <i class="replaceable"><tt>filename</tt></i>, outputing to
stdout, unless <tt class="option">--noout</tt> is used.
</dd><dt><span class="term"><tt class="option">--noout</tt></span></dt><dd>
Save output to the named file rather than
outputing to stdout.
</dd><dt><span class="term"><tt>-v</tt> or <tt>--verbose</tt></span></dt><dd>
</dd><dt><span class="term"><tt class="option">--sgml</tt></span></dt><dd>
Uses SGML Super catalogs for --add and --del options
</dd><dt><span class="term"><tt class="option">-v</tt> or <tt class="option">--verbose</tt></span></dt><dd>
output debugging
information.
</dd></dl></div></div><div class="refsect1"><a name="shell"></a><h2>Shell Commands</h2><p>Invoking xmlcatalog with the
<tt>--shell</tt> <i><tt>filename</tt></i> option opens
</dd></dl></div></div><div class="refsect1" lang="en"><a name="shell"></a><h2>Shell Commands</h2><p>Invoking <span class="application">xmlcatalog</span> with the
<tt class="option">--shell</tt> <i class="replaceable"><tt>filename</tt></i> option opens
a command line shell allowing interactive access to the catalog file
identified by <i><tt>filename</tt></i>. Invoking the shell
identified by <i class="replaceable"><tt>filename</tt></i>. Invoking the shell
provides a command line prompt after which commands can be entered.
</p><div class="variablelist"><dl><dt><span class="term"><tt>public</tt> <i><tt>'PublicID'</tt></i></span></dt><dd>
</p><div class="variablelist"><dl><dt><span class="term"><tt class="option">public</tt> <i class="replaceable"><tt>'PublicID'</tt></i></span></dt><dd>
Execute a
public identifier lookup of the catalog entry for
<i><tt>'PublicID'</tt></i>. The corresponding entry will be
<i class="replaceable"><tt>'PublicID'</tt></i>. The corresponding entry will be
output to the command line.
</dd><dt><span class="term"><tt>system</tt> <i><tt>'SystemID'</tt></i></span></dt><dd>
</dd><dt><span class="term"><tt class="option">system</tt> <i class="replaceable"><tt>'SystemID'</tt></i></span></dt><dd>
Execute a
public identifier lookup of the catalog entry for
<i><tt>'SystemID'</tt></i>. The corresponding entry will be
<i class="replaceable"><tt>'SystemID'</tt></i>. The corresponding entry will be
output to the command line.
</dd><dt><span class="term"><tt>add </tt> <i><tt>'type'</tt></i> <i><tt>'orig'</tt></i> <i><tt>'replace'</tt></i></span></dt><dd>
</dd><dt><span class="term"><tt class="option">add </tt> <i class="replaceable"><tt>'type'</tt></i> <i class="replaceable"><tt>'orig'</tt></i> <i class="replaceable"><tt>'replace'</tt></i></span></dt><dd>
Add an entry to the catalog
file. <i><tt>type</tt></i> indicates the type of
file. <i class="replaceable"><tt>type</tt></i> indicates the type of
entry. Possible types are 'public', 'system', 'rewriteSystem',
'delegatePublic' and 'delegateSystem'. <i><tt>'orig'</tt></i>
'delegatePublic' and 'delegateSystem'. <i class="replaceable"><tt>'orig'</tt></i>
is the original reference to be replaced, and
<i><tt>'replace'</tt></i> is the URI of the
<i class="replaceable"><tt>'replace'</tt></i> is the <span class="acronym">URI</span> of the
replacement entity to be used.
</dd><dt><span class="term"><tt>del</tt> <i><tt>'values'</tt></i></span></dt><dd>
</dd><dt><span class="term"><tt class="option">del</tt> <i class="replaceable"><tt>'values'</tt></i></span></dt><dd>
Remove the
catalog entry corresponding to <i><tt>'values'</tt></i>.
</dd><dt><span class="term"><tt>dump</tt></span></dt><dd>
catalog entry corresponding to <i class="replaceable"><tt>'values'</tt></i>.
</dd><dt><span class="term"><tt class="option">dump</tt></span></dt><dd>
Print the current catalog.
</dd><dt><span class="term"><tt>debug</tt></span></dt><dd>
</dd><dt><span class="term"><tt class="option">debug</tt></span></dt><dd>
Print debugging statements showing the steps
xmlcatalog is executing.
</dd><dt><span class="term"><tt>quiet</tt></span></dt><dd>
<span class="application">xmlcatalog</span> is executing.
</dd><dt><span class="term"><tt class="option">quiet</tt></span></dt><dd>
Stop printing debugging statements.
</dd><dt><span class="term"><tt>exit</tt></span></dt><dd>
</dd><dt><span class="term"><tt class="option">exit</tt></span></dt><dd>
Quit the shell.
</dd></dl></div></div><div class="refsect1"><h2>References</h2><p><a href="http://www.xmlsoft.org/" target="_top">libxml web page</a></p><p><a href="http://www.xmlsoft.org/catalog.html" target="_top">libxml
</dd></dl></div></div><div class="refsect1" lang="en"><a name="return"></a><h2>Return values</h2><p><span class="application">xmlcatalog</span>'s return codes provide
information that can be used when calling it from scripts.</p><p>0: normal</p><p>1: Failed to remove an entry from the catalog</p><p>2: Failed to save to the catalog, check file permissions</p><p>3: Failed to add an entry to the catalog</p><p>4: Failed to lookup and entry in the catalog</p></div><div class="refsect1" lang="en"><h2>References</h2><p><a href="http://www.xmlsoft.org/" target="_top">libxml web page</a></p><p><a href="http://www.xmlsoft.org/catalog.html" target="_top"><span class="application">libxml</span>
catalog support web page:</a></p><p><a href="http://www.jclark.com/sp/catalog.htm" target="_top">James Clark's
SGML catalog page:</a></p><p><a href="http://www.oasis-open.org/committees/entity/spec.html" target="_top">OASIS
XML catalog specification: </a></p></div></div></body></html>
<span class="acronym">SGML</span> catalog page:</a></p><p><a href="http://www.oasis-open.org/committees/entity/spec.html" target="_top"><span class="acronym">OASIS</span>
<span class="acronym">XML</span> catalog specification: </a></p></div></div></body></html>

View File

@ -91,17 +91,18 @@
<listitem>
<simpara>
Add an entry to catalog file
<filename>filename</filename>. <replaceable>type</replaceable> indicates
the type of entry. Possible types are 'public', 'system', 'rewriteSystem',
'delegatePublic' and 'delegateSystem'. <replaceable>'orig'</replaceable>
is the original reference to
be replaced, and <replaceable>'replace'</replaceable> is the
<acronym>URI</acronym> of the replacement entity to be used. The
<option>--add</option> option will not overwrite
<filename>filename</filename>. <replaceable>type</replaceable>
indicates the type of entry. Possible types are 'public', 'system',
'rewriteSystem', 'delegatePublic', 'delegateSystem'amd
'rewriteURI'. <replaceable>'orig'</replaceable> is the original
reference to be replaced, and <replaceable>'replace'</replaceable>
is the <acronym>URI</acronym> of the replacement entity to be
used. The <option>--add</option> option will not overwrite
<replaceable>filename</replaceable>, outputing to stdout, unless
<option>--noout</option> is used. The <option>--add</option> will always
take three parameters even if some of the <acronym>XML</acronym> catalog
constructs will have only a single argument.
<option>--noout</option> is used. The <option>--add</option> will
always take three parameters even if some of the
<acronym>XML</acronym> catalog constructs will have only a single
argument.
<!--
FIXME - Is my list of possible types correct? Are SGML types the same?
-->