'" t ." Title: xmlcatalog ." Author: John Fleck <jfleck@inkstain.net> ." Generator: DocBook XSL Stylesheets vsnapshot <docbook.sf.net/> ." Date: $Date$ ." Manual: xmlcatalog Manual ." Source: libxml2 ." Language: English ." .TH “XMLCATALOG” “1” “$Date$” “libxml2” “xmlcatalog Manual” ." —————————————————————– ." * Define some portability stuff ." —————————————————————– ." ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ." bugs.debian.org/507673 ." lists.gnu.org/archive/html/groff/2009-02/msg00013.html ." ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie n(.g .ds Aq (aq .el .ds Aq ' ." —————————————————————– ." * set default formatting ." —————————————————————– ." disable hyphenation .nh ." disable justification (adjust text to left margin only) .ad l ." —————————————————————– ." * MAIN CONTENT STARTS HERE * ." —————————————————————– .SH “NAME” xmlcatalog - Command line tool to parse and manipulate XML or SGML catalog files&. .SH “SYNOPSIS” .HP w'fBxmlcatalogfR\ 'u fBxmlcatalogfR [fB--sgmlfR | fB--shellfR | fB--createfR | fB--del\ fRfBfIVALUE(S)fRfR | [\ fB--add\ fRfBfITYPEfRfRfB\ fRfBfIORIGfRfRfB\ fRfBfIREPLACEfRfRfB\ fR\ |\ fB--add\ fRfBfIFILENAMEfRfR] | fB--nooutfR | fB--no-super-updatefR | [fB-vfR\ |\ fB--verbosefR]] {fICATALOGFILEfR} {fIENTITIESfR…} .SH “DESCRIPTION” .PP fBxmlcatalogfR is a command line application allowing users to monitor and manipulate XML and SGML catalogs&. It is included in fBlibxmlfR(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&. .SH “OPTIONS” .PP fBxmlcatalogfR accepts the following options (in alphabetical order): .PP fB--add fRfBfITYPEfRfRfB fRfBfIORIGfRfRfB fRfBfIREPLACEfRfRfB fR .RS 4 Add an entry to CATALOGFILE&. fITYPEfR indicates the type of entry&. Possible types are: fIpublicfR, fIsystemfR, fIurifR, fIrewriteSystemfR, fIrewriteURIfR, fIdelegatePublicfR, fIdelegateSystemfR, fIdelegateURIfR, fInextCatalogfR&. fIORIGfR is the original reference to be replaced, and fIREPLACEfR is the URI of the replacement entity to be used&. The fB--addfR option will not overwrite CATALOGFILE, outputting to stdout, unless fB--nooutfR is used&. The fB--addfR will always take three parameters even if some of the XML catalog constructs will have only a single argument&. .RE .PP fB--add fRfBfIFILENAMEfRfR .RS 4 If the fB--addfR option is used following the fB--sgmlfR option, only a single argument, a fIFILENAMEfR, 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&. .RE .PP fB--createfR .RS 4 Create a new XML catalog&. Outputs to stdout, ignoring fIfilenamefR unless fB--nooutfR is used, in which case it creates a new catalog file fIfilenamefR&. .RE .PP fB--del fRfBfIVALUE(S)fRfR .RS 4 Remove entries from fICATALOGFILEfR matching fIVALUE(S)fR&. The fB--delfR option will not overwrite fICATALOGFILEfR, outputting to stdout, unless fB--nooutfR is used&. .RE .PP fB--nooutfR .RS 4 Save output to the named file rather than outputting to stdout&. .RE .PP fB--no-super-updatefR .RS 4 Do not update the SGML super catalog&. .RE .PP fB--shellfR .RS 4 Run a shell allowing interactive queries on catalog file fICATALOGFILEfR&. For the set of available commands see the section called (lqSHELL COMMANDS(rq&. .RE .PP fB--sgmlfR .RS 4 Uses SGML super catalogs for fB--addfR and fB--delfR options&. .RE .PP fB-vfR, fB--verbosefR .RS 4 Output debugging information&. .RE .PP Invoking fBxmlcatalogfR non-interactively without a designated action (imposed with options like fB--addfR) will result in a lookup of the catalog entry for fIENTITIESfR in the catalog denoted with fICATALOGFILEfR&. The corresponding entries will be output to the command line&. This mode of operation, together with fB--shellfR mode and non-modifying (i&.e&. without fB--nooutfR) direct actions, allows for a special shortcut of the void fICATALOGFILEfR 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&. .SH “SHELL COMMANDS” .PP Invoking fBxmlcatalogfR with the fB--shell fRfBfICATALOGFILEfRfR option opens a command line shell allowing interactive access to the catalog file identified by fICATALOGFILEfR&. Invoking the shell provides a command line prompt after which the following commands (described in alphabetical order) can be entered&. .PP fBadd fRfBfITYPEfRfRfB fRfBfIORIGfRfRfB fRfBfIREPLACEfRfRfB fR .RS 4 Add an entry to the catalog file&. fITYPEfR indicates the type of entry&. Possible types are: fIpublicfR, fIsystemfR, fIurifR, fIrewriteSystemfR, fIrewriteURIfR, fIdelegatePublicfR, fIdelegateSystemfR, fIdelegateURIfR, fInextCatalogfR&. fIORIGfR is the original reference to be replaced, and fIREPLACEfR is the URI of the replacement entity to be used&. The fB--addfR option will not overwrite CATALOGFILE, outputting to stdout, unless fB--nooutfR is used&. The fB--addfR will always take three parameters even if some of the XML catalog constructs will have only a single argument&. .RE .PP fBdebugfR .RS 4 Print debugging statements showing the steps fBxmlcatalogfR is executing&. .RE .PP fBdel fRfBfIVALUE(S)fRfR .RS 4 Remove the catalog entry corresponding to fIVALUE(S)fR&. .RE .PP fBdumpfR .RS 4 Print the current catalog&. .RE .PP fBexitfR .RS 4 Quit the shell&. .RE .PP fBpublic fRfBfIPUBLIC-IDfRfR .RS 4 Execute a Formal Public Identifier lookup of the catalog entry for fIPUBLIC-IDfR&. The corresponding entry will be output to the command line&. .RE .PP fBquietfR .RS 4 Stop printing debugging statements&. .RE .PP fBsystem fRfBfISYSTEM-IDfRfR .RS 4 Execute a Formal Public Identifier lookup of the catalog entry for fISYSTEM-IDfR&. The corresponding entry will be output to the command line&. .RE .SH “ENVIRONMENT” .PP fBXML_CATALOG_FILESfR .RS 4 XML catalog behavior can be changed by redirecting queries to the user*(Aqs own set of catalogs&. This can be done by setting the fBXML_CATALOG_FILESfR environment variable to a list of catalogs&. An empty one should deactivate loading the default /etc/xml/catalog catalog&. .RE .SH “DIAGNOSTICS” .PP fBxmlcatalogfR return codes provide information that can be used when calling it from scripts&. .PP fB0fR .RS 4 No error .RE .PP fB1fR .RS 4 Failed to remove an entry from the catalog .RE .PP fB2fR .RS 4 Failed to save to the catalog, check file permissions .RE .PP fB3fR .RS 4 Failed to add an entry to the catalog .RE .PP fB4fR .RS 4 Failed to look up an entry in the catalog .RE .SH “SEE ALSO” .PP fBlibxmlfR(3) .PP More information can be found at .sp .RS 4 .ie n {\ h'-04'(buh'+03'c .} .el {\ .sp -1 .IP (bu 2.3 .} fBlibxmlfR(3) web page m[blue]fB%www.xmlsoft.org/fRm[] .RE .sp .RS 4 .ie n {\ h'-04'(buh'+03'c .} .el {\ .sp -1 .IP (bu 2.3 .} fBlibxmlfR(3) catalog support web page at m[blue]fB%www.xmlsoft.org/catalog.htmlfRm[] .RE .sp .RS 4 .ie n {\ h'-04'(buh'+03'c .} .el {\ .sp -1 .IP (bu 2.3 .} James Clark*(Aqs SGML catalog page m[blue]fB%www.jclark.com/sp/catalog.htmfRm[] .RE .sp .RS 4 .ie n {\ h'-04'(buh'+03'c .} .el {\ .sp -1 .IP (bu 2.3 .} OASIS XML catalog specification m[blue]fB%www.oasis-open.org/committees/entity/spec.htmlfRm[] .RE .sp .SH “AUTHOR” .PP fBJohn FleckfR <&jfleck@inkstain&.net&> .RS 4 Author. .RE .SH “COPYRIGHT” .br Copyright (co 2001, 2004 .br