components/libxml2/xmlcatalog.1
author Norm Jacobs <Norm.Jacobs@Oracle.COM>
Thu, 24 Mar 2011 12:44:50 -0700
changeset 148 33ca3897ae25
child 181 87e11e685b1f
permissions -rw-r--r--
7029701 libxml2 should move to userland 7029702 libxslt should move to userland
.TH xmlcatalog 1 "Nov 26 2001"
.SH NAME
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]
.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"

.TP
\fB--shell\fR \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.
.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' 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.
.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.
.TP
\fB--noout\fR
Save output to the named file rather than outputing to stdout.
.TP
\fB-v\fR or \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.
.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.
.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.
.TP
\fBdel\fR \fI'values'\fR
Remove the catalog entry corresponding to \fI'values'\fR.
.TP
\fBdump\fR
Print the current catalog.
.TP
\fBdebug\fR
Print debugging statements showing the steps xmlcatalog is executing.
.TP
\fBquiet\fR
Stop printing debugging statements.
.TP
\fBexit\fR
Quit the shell.
.SH "REFERENCES"

.TP
libxml web page:
http://www.xmlsoft.org/
.TP
libxml catalog support web page:
http://www.xmlsoft.org/catalog.html
.TP
James Clark's SGML catalog page:
http://www.jclark.com/sp/catalog.htm
.TP
OASIS XML catalog specification:
http://www.oasis-open.org/committees/entity/spec.html

.SH AUTHOR
John Fleck  <[email protected]>
This is release 0.2 of the xmlcatalog Manual.

.SH NOTES
Source for libxml is available on http://opensolaris.org.
Documentation for libxml is available on-line at http://www.xmlsoft.org/