3 .\" Author: John Fleck <jfleck@inkstain.net>
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
6 .\" Manual: xmlcatalog Manual
10 .TH "XMLCATALOG" "1" "$Date$" "libxml2" "xmlcatalog Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 xmlcatalog \- Command line tool to parse and manipulate XML or SGML catalog files\&.
33 .HP \w'\fBxmlcatalog\fR\ 'u
34 \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...}
39 is a command line application allowing users to monitor and manipulate
43 catalogs\&. It is included in
46 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
55 accepts the following options (in alphabetical order):
57 \fB\-\-add \fR\fB\fITYPE\fR\fR\fB \fR\fB\fIORIG\fR\fR\fB \fR\fB\fIREPLACE\fR\fR\fB \fR
62 indicates the type of entry\&. Possible types are:
63 \fIpublic\fR, \fIsystem\fR, \fIuri\fR, \fIrewriteSystem\fR, \fIrewriteURI\fR, \fIdelegatePublic\fR, \fIdelegateSystem\fR, \fIdelegateURI\fR, \fInextCatalog\fR\&.
65 is the original reference to be replaced, and
69 of the replacement entity to be used\&. The
71 option will not overwrite
72 CATALOGFILE, outputting to
77 will always take three parameters even if some of the
79 catalog constructs will have only a single argument\&.
82 \fB\-\-add \fR\fB\fIFILENAME\fR\fR
86 option is used following the
88 option, only a single argument, a
89 \fIFILENAME\fR, is used\&. This is used to add the name of a catalog file to an
91 supercatalog, a file that contains references to other included
100 catalog\&. Outputs to
105 is used, in which case it creates a new catalog file
109 \fB\-\-del \fR\fB\fIVALUE(S)\fR\fR
114 \fIVALUE(S)\fR\&. The
116 option will not overwrite
117 \fICATALOGFILE\fR, outputting to
125 Save output to the named file rather than outputting to
129 \fB\-\-no\-super\-update\fR
138 Run a shell allowing interactive queries on catalog file
139 \fICATALOGFILE\fR\&. For the set of available commands see
140 the section called \(lqSHELL COMMANDS\(rq\&.
154 \fB\-v\fR, \fB\-\-verbose\fR
156 Output debugging information\&.
163 \fB\-\-shell \fR\fB\fICATALOGFILE\fR\fR
164 option opens a command line shell allowing interactive access to the catalog file identified by
165 \fICATALOGFILE\fR\&. Invoking the shell provides a command line prompt after which the following commands (described in alphabetical order) can be entered\&.
167 \fBadd \fR\fB\fITYPE\fR\fR\fB \fR\fB\fIORIG\fR\fR\fB \fR\fB\fIREPLACE\fR\fR\fB \fR
169 Add an entry to the catalog file\&.
171 indicates the type of entry\&. Possible types are:
172 \fIpublic\fR, \fIsystem\fR, \fIuri\fR, \fIrewriteSystem\fR, \fIrewriteURI\fR, \fIdelegatePublic\fR, \fIdelegateSystem\fR, \fIdelegateURI\fR, \fInextCatalog\fR\&.
174 is the original reference to be replaced, and
178 of the replacement entity to be used\&. The
180 option will not overwrite
181 CATALOGFILE, outputting to
186 will always take three parameters even if some of the
188 catalog constructs will have only a single argument\&.
193 Print debugging statements showing the steps
198 \fBdel \fR\fB\fIVALUE(S)\fR\fR
200 Remove the catalog entry corresponding to
206 Print the current catalog\&.
214 \fBpublic \fR\fB\fIPUBLIC\-ID\fR\fR
216 Execute a Formal Public Identifier look\-up of the catalog entry for
217 \fIPUBLIC\-ID\fR\&. The corresponding entry will be output to the command line\&.
222 Stop printing debugging statements\&.
225 \fBsystem \fR\fB\fISYSTEM\-ID\fR\fR
227 Execute a Formal Public Identifier look\-up of the catalog entry for
228 \fISYSTEM\-ID\fR\&. The corresponding entry will be output to the command line\&.
232 \fBXML_CATALOG_FILES\fR
235 catalog behavior can be changed by redirecting queries to the user\*(Aqs own set of catalogs\&. This can be done by setting the
236 \fBXML_CATALOG_FILES\fR
237 environment variable to a list of catalogs\&. An empty one should deactivate loading the default
245 return codes provide information that can be used when calling it from scripts\&.
254 Failed to remove an entry from the catalog
259 Failed to save to the catalog, check file permissions
264 Failed to add an entry to the catalog
269 Failed to look up an entry in the catalog
275 More information can be found at
287 \m[blue]\fB\%http://www.xmlsoft.org/\fR\m[]
299 catalog support web page at
300 \m[blue]\fB\%http://www.xmlsoft.org/catalog.html\fR\m[]
314 \m[blue]\fB\%http://www.jclark.com/sp/catalog.htm\fR\m[]
327 catalog specification
328 \m[blue]\fB\%http://www.oasis-open.org/committees/entity/spec.html\fR\m[]
333 \fBJohn Fleck\fR <\&jfleck@inkstain\&.net\&>
339 Copyright \(co 2001, 2004