Load /tmp/libxml2-2.6.24 intoupstream/2.6.24.dfsg

libxml2/branches/upstream/current.

1 files changed, 203 insertions, 124 deletions

diff --git a/doc/xmlcatalog.1 b/doc/xmlcatalog.1
index ff31fb7..103d7f0 100644
--- a/doc/xmlcatalog.1
+++ b/doc/xmlcatalog.1
@@ -1,148 +1,227 @@
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.TH "XMLCATALOG" 1 "" "" "xmlcatalog Manual"
-.SH NAME
+.\" ** You probably do not want to edit this file directly **
+.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
+.\" Instead of manually editing it, you probably should edit the DocBook XML
+.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
+.TH "XMLCATALOG" "1" "2006\-03\-05" "libxml2" ""
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
 xmlcatalog \- Command line tool to parse and manipulate XML or SGML catalog files.
 .SH "SYNOPSIS"
-.ad l
-.hy 0
 .HP 11
-\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]
-.ad
-.hy
-
-.SH "INTRODUCTION"
-
-.PP
- 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\&.
-
-.SH "COMMAND LINE OPTIONS"
-
+\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
+and
+SGML
+catalogs. It is included in
+\fBlibxml\fR(3).
+.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.
+.PP
+More information can be found at
+.TP 3
+\(bu
+\fBlibxml\fR(3)
+web page
+\fI\%http://www.xmlsoft.org/\fR
 .TP
-\fB\-\-shell\fR \fIfilename\fR
-Run a shell allowing interactive queries on catalog file \fIfilename\fR\&.
-
+\(bu
+\fBlibxml\fR(3)
+catalog support web page at
+\fI\%http://www.xmlsoft.org/catalog.html\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\&.
-
+\(bu
+James Clark's
+SGML
+catalog page
+\fI\%http://www.jclark.com/sp/catalog.htm\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', 'rewriteURI', 'delegatePublic', 'delegateSystem', and 'nextCatalog'\&. \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, outputting 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\&.
-
+\(bu
+OASISXML
+catalog specification
+\fI\%http://www.oasis\-open.org/committees/entity/spec.html\fR
+.SH "OPTIONS"
+.PP
+\fBxmlcatalog\fR
+accepts the following options (in alphabetical order):
 .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, outputting to stdout, unless \fB\-\-noout\fR is used\&.
-
+\fB\-\-add \fR\fB\fITYPE\fR\fR\fB \fR\fB\fIORIG\fR\fR\fB \fR\fB\fIREPLACE\fR\fR\fB \fR
+Add an entry to
+\fICATALOGFILE\fR.
+\fITYPE\fR
+indicates the type of entry. Possible types are:
+\fIpublic\fR, \fIsystem\fR, \fIrewriteSystem\fR, \fIrewriteURI\fR, \fIdelegatePublic\fR, \fIdelegateSystem\fR, \fInextCatalog\fR.
+\fIORIG\fR
+is the original reference to be replaced, and
+\fIREPLACE\fR
+is the
+URI
+of the replacement entity to be used. The
+\fB\-\-add\fR
+option will not overwrite
+\fICATALOGFILE\fR, outputting to
+\fIstdout\fR, 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.
 .TP
+\fB\-\-add \fR\fB\fIFILENAME\fR\fR
+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\-\-create\fR
+Create a new
+XML
+catalog. Outputs to
+\fIstdout\fR, ignoring
+\fIfilename\fR
+unless
 \fB\-\-noout\fR
-Save output to the named file rather than outputting to stdout\&.
-
+is used, in which case it creates a new catalog file
+\fIfilename\fR.
+.TP
+\fB\-\-del \fR\fB\fIVALUE(S)\fR\fR
+Remove entries from
+\fICATALOGFILE\fR
+matching
+\fIVALUE(S)\fR. The
+\fB\-\-del\fR
+option will not overwrite
+\fICATALOGFILE\fR, outputting to
+\fIstdout\fR, unless
+\fB\-\-noout\fR
+is used.
+.TP
+\fB\-\-noout\fR
+Save output to the named file rather than outputting to
+\fIstdout\fR.
+.TP
+\fB\-\-no\-super\-update\fR
+Do not update the
+SGML
+super catalog.
+.TP
+\fB\-\-shell\fR
+Run a shell allowing interactive queries on catalog file
+\fICATALOGFILE\fR. For the set of available commands see
+the section called \(lqSHELL COMMANDS\(rq.
 .TP
 \fB\-\-sgml\fR
-Uses SGML Super catalogs for \-\-add and \-\-del options
-
+Uses
+SGML
+super catalogs for
+\fB\-\-add\fR
+and
+\fB\-\-del\fR
+options.
 .TP
-\fB\-v\fR or \fB\-\-verbose\fR
-output debugging information\&.
-
+\fB\-v\fR, \fB\-\-verbose\fR
+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
+\fBxmlcatalog\fR
+with the
+\fB\-\-shell \fR\fB\fICATALOGFILE\fR\fR
+option opens a command line shell allowing interactive access to the catalog file identified by
+\fICATALOGFILE\fR. Invoking the shell provides a command line prompt after which the following commands (described in alphabetical order) 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\&.
-
-.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\&.
-
+\fBadd \fR\fB\fITYPE\fR\fR\fB \fR\fB\fIORIG\fR\fR\fB \fR\fB\fIREPLACE\fR\fR\fB \fR
+Add an entry to the catalog file.
+\fITYPE\fR
+indicates the type of entry. Possible types are:
+\fIpublic\fR, \fIsystem\fR, \fIrewriteSystem\fR, \fIrewriteURI\fR, \fIdelegatePublic\fR, \fIdelegateSystem\fR, \fInextCatalog\fR.
+\fIORIG\fR
+is the original reference to be replaced, and
+\fIREPLACE\fR
+is the
+URI
+of the replacement entity to be used. The
+\fB\-\-add\fR
+option will not overwrite
+\fICATALOGFILE\fR, outputting to
+\fIstdout\fR, 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.
 .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', 'rewriteURI', 'delegatePublic', 'delegateSystem', and 'nextCatalog'\&. \fI'orig'\fR is the original reference to be replaced, and \fI'replace'\fR is the URI of the replacement entity to be used\&.
-
+\fBdebug\fR
+Print debugging statements showing the steps
+\fBxmlcatalog\fR
+is executing.
 .TP
-\fBdel\fR \fI'values'\fR
-Remove the catalog entry corresponding to \fI'values'\fR\&.
-
+\fBdel \fR\fB\fIVALUE(S)\fR\fR
+Remove the catalog entry corresponding to
+\fIVALUE(S)\fR.
 .TP
 \fBdump\fR
-Print the current catalog\&.
-
+Print the current catalog.
 .TP
-\fBdebug\fR
-Print debugging statements showing the steps xmlcatalog is executing\&.
-
+\fBexit\fR
+Quit the shell.
+.TP
+\fBpublic \fR\fB\fIPUBLIC\-ID\fR\fR
+Execute a public identifier lookup of the catalog entry for
+\fIPUBLIC\-ID\fR. The corresponding entry will be output to the command line.
 .TP
 \fBquiet\fR
-Stop printing debugging statements\&.
-
+Stop printing debugging statements.
 .TP
-\fBexit\fR
-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 "CATALOGS"
-
-.PP
-Catalog behavior can be changed by redirecting queries to the user's own set of catalogs\&. This can be done by setting the \fIXML_CATALOG_FILES\fR environment variable to a list of catalogs\&. An empty one should deactivate loading the default \fI/etc/xml/catalog\fR default catalog\&.
-
-.SH "REFERENCES"
-
-.PP
-libxml web page: \fIhttp://www.xmlsoft.org/\fR
-
-.PP
-libxml catalog support web page: \fIhttp://www.xmlsoft.org/catalog.html\fR
-
-.PP
-James Clark's SGML catalog page: \fIhttp://www.jclark.com/sp/catalog.htm\fR
-
+\fBsystem \fR\fB\fISYSTEM\-ID\fR\fR
+Execute a public identifier lookup of the catalog entry for
+\fISYSTEM\-ID\fR. The corresponding entry will be output to the command line.
+.SH "ENVIRONMENT"
+.TP
+\fBXML_CATALOG_FILES\fR
+Catalog behavior can be changed by redirecting queries to the user's own set of catalogs. This can be done by setting the
+\fBXML_CATALOG_FILES\fR
+environment variable to a list of catalogs. An empty one should deactivate loading the default
+\fI/etc/xml/catalog\fR
+default catalog.
+.SH "DIAGNOSTICS"
+.PP
+\fBxmlcatalog\fR's return codes provide information that can be used when calling it from scripts.
+.TP
+\fB0\fR
+No error
+.TP
+\fB1\fR
+Failed to remove an entry from the catalog
+.TP
+\fB2\fR
+Failed to save to the catalog, check file permissions
+.TP
+\fB3\fR
+Failed to add an entry to the catalog
+.TP
+\fB4\fR
+Failed to lookup an entry in the catalog
+.SH "SEE ALSO"
 .PP
-OASIS XML catalog specification: \fIhttp://www.oasis-open.org/committees/entity/spec.html\fR
-
-.SH AUTHOR
-John Fleck.
+\fBlibxml\fR(3)
+.SH "AUTHOR"
+John Fleck <jfleck@inkstain.net>.