doc/xmlcatalog.1

   1 '\" t
   2 .\"     Title: xmlcatalog
   3 .\"    Author: John Fleck <jfleck@inkstain.net>
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: $Date$
   6 .\"    Manual: xmlcatalog Manual
   7 .\"    Source: libxml2
   8 .\"  Language: English
   9 .\"
  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 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 xmlcatalog \- Command line tool to parse and manipulate XML or SGML catalog files\&.
  32 .SH "SYNOPSIS"
  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...}
  35 .SH "DESCRIPTION"
  36 .PP
  37
  38 \fBxmlcatalog\fR
  39 is a command line application allowing users to monitor and manipulate
  40 XML
  41 and
  42 SGML
  43 catalogs\&. It is included in
  44 \fBlibxml\fR(3)\&.
  45 .PP
  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
  47 XML
  48 and
  49 SGML
  50 files\&.
  51 .SH "OPTIONS"
  52 .PP
  53
  54 \fBxmlcatalog\fR
  55 accepts the following options (in alphabetical order):
  56 .PP
  57 \fB\-\-add \fR\fB\fITYPE\fR\fR\fB \fR\fB\fIORIG\fR\fR\fB \fR\fB\fIREPLACE\fR\fR\fB \fR
  58 .RS 4
  59 Add an entry to
  60 CATALOGFILE\&.
  61 \fITYPE\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\&.
  64 \fIORIG\fR
  65 is the original reference to be replaced, and
  66 \fIREPLACE\fR
  67 is the
  68 URI
  69 of the replacement entity to be used\&. The
  70 \fB\-\-add\fR
  71 option will not overwrite
  72 CATALOGFILE, outputting to
  73 stdout, unless
  74 \fB\-\-noout\fR
  75 is used\&. The
  76 \fB\-\-add\fR
  77 will always take three parameters even if some of the
  78 XML
  79 catalog constructs will have only a single argument\&.
  80 .RE
  81 .PP
  82 \fB\-\-add \fR\fB\fIFILENAME\fR\fR
  83 .RS 4
  84 If the
  85 \fB\-\-add\fR
  86 option is used following the
  87 \fB\-\-sgml\fR
  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
  90 SGML
  91 supercatalog, a file that contains references to other included
  92 SGML
  93 catalog files\&.
  94 .RE
  95 .PP
  96 \fB\-\-create\fR
  97 .RS 4
  98 Create a new
  99 XML
 100 catalog\&. Outputs to
 101 stdout, ignoring
 102 \fIfilename\fR
 103 unless
 104 \fB\-\-noout\fR
 105 is used, in which case it creates a new catalog file
 106 \fIfilename\fR\&.
 107 .RE
 108 .PP
 109 \fB\-\-del \fR\fB\fIVALUE(S)\fR\fR
 110 .RS 4
 111 Remove entries from
 112 \fICATALOGFILE\fR
 113 matching
 114 \fIVALUE(S)\fR\&. The
 115 \fB\-\-del\fR
 116 option will not overwrite
 117 \fICATALOGFILE\fR, outputting to
 118 stdout, unless
 119 \fB\-\-noout\fR
 120 is used\&.
 121 .RE
 122 .PP
 123 \fB\-\-noout\fR
 124 .RS 4
 125 Save output to the named file rather than outputting to
 126 stdout\&.
 127 .RE
 128 .PP
 129 \fB\-\-no\-super\-update\fR
 130 .RS 4
 131 Do not update the
 132 SGML
 133 super catalog\&.
 134 .RE
 135 .PP
 136 \fB\-\-shell\fR
 137 .RS 4
 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\&.
 141 .RE
 142 .PP
 143 \fB\-\-sgml\fR
 144 .RS 4
 145 Uses
 146 SGML
 147 super catalogs for
 148 \fB\-\-add\fR
 149 and
 150 \fB\-\-del\fR
 151 options\&.
 152 .RE
 153 .PP
 154 \fB\-v\fR, \fB\-\-verbose\fR
 155 .RS 4
 156 Output debugging information\&.
 157 .RE
 158 .SH "SHELL COMMANDS"
 159 .PP
 160 Invoking
 161 \fBxmlcatalog\fR
 162 with the
 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\&.
 166 .PP
 167 \fBadd \fR\fB\fITYPE\fR\fR\fB \fR\fB\fIORIG\fR\fR\fB \fR\fB\fIREPLACE\fR\fR\fB \fR
 168 .RS 4
 169 Add an entry to the catalog file\&.
 170 \fITYPE\fR
 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\&.
 173 \fIORIG\fR
 174 is the original reference to be replaced, and
 175 \fIREPLACE\fR
 176 is the
 177 URI
 178 of the replacement entity to be used\&. The
 179 \fB\-\-add\fR
 180 option will not overwrite
 181 CATALOGFILE, outputting to
 182 stdout, unless
 183 \fB\-\-noout\fR
 184 is used\&. The
 185 \fB\-\-add\fR
 186 will always take three parameters even if some of the
 187 XML
 188 catalog constructs will have only a single argument\&.
 189 .RE
 190 .PP
 191 \fBdebug\fR
 192 .RS 4
 193 Print debugging statements showing the steps
 194 \fBxmlcatalog\fR
 195 is executing\&.
 196 .RE
 197 .PP
 198 \fBdel \fR\fB\fIVALUE(S)\fR\fR
 199 .RS 4
 200 Remove the catalog entry corresponding to
 201 \fIVALUE(S)\fR\&.
 202 .RE
 203 .PP
 204 \fBdump\fR
 205 .RS 4
 206 Print the current catalog\&.
 207 .RE
 208 .PP
 209 \fBexit\fR
 210 .RS 4
 211 Quit the shell\&.
 212 .RE
 213 .PP
 214 \fBpublic \fR\fB\fIPUBLIC\-ID\fR\fR
 215 .RS 4
 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\&.
 218 .RE
 219 .PP
 220 \fBquiet\fR
 221 .RS 4
 222 Stop printing debugging statements\&.
 223 .RE
 224 .PP
 225 \fBsystem \fR\fB\fISYSTEM\-ID\fR\fR
 226 .RS 4
 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\&.
 229 .RE
 230 .SH "ENVIRONMENT"
 231 .PP
 232 \fBXML_CATALOG_FILES\fR
 233 .RS 4
 234 XML
 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
 238 /etc/xml/catalog
 239 catalog\&.
 240 .RE
 241 .SH "DIAGNOSTICS"
 242 .PP
 243
 244 \fBxmlcatalog\fR
 245 return codes provide information that can be used when calling it from scripts\&.
 246 .PP
 247 \fB0\fR
 248 .RS 4
 249 No error
 250 .RE
 251 .PP
 252 \fB1\fR
 253 .RS 4
 254 Failed to remove an entry from the catalog
 255 .RE
 256 .PP
 257 \fB2\fR
 258 .RS 4
 259 Failed to save to the catalog, check file permissions
 260 .RE
 261 .PP
 262 \fB3\fR
 263 .RS 4
 264 Failed to add an entry to the catalog
 265 .RE
 266 .PP
 267 \fB4\fR
 268 .RS 4
 269 Failed to look up an entry in the catalog
 270 .RE
 271 .SH "SEE ALSO"
 272 .PP
 273 \fBlibxml\fR(3)
 274 .PP
 275 More information can be found at
 276 .sp
 277 .RS 4
 278 .ie n \{\
 279 \h'-04'\(bu\h'+03'\c
 280 .\}
 281 .el \{\
 282 .sp -1
 283 .IP \(bu 2.3
 284 .\}
 285 \fBlibxml\fR(3)
 286 web page
 287 \m[blue]\fB\%http://www.xmlsoft.org/\fR\m[]
 288 .RE
 289 .sp
 290 .RS 4
 291 .ie n \{\
 292 \h'-04'\(bu\h'+03'\c
 293 .\}
 294 .el \{\
 295 .sp -1
 296 .IP \(bu 2.3
 297 .\}
 298 \fBlibxml\fR(3)
 299 catalog support web page at
 300 \m[blue]\fB\%http://www.xmlsoft.org/catalog.html\fR\m[]
 301 .RE
 302 .sp
 303 .RS 4
 304 .ie n \{\
 305 \h'-04'\(bu\h'+03'\c
 306 .\}
 307 .el \{\
 308 .sp -1
 309 .IP \(bu 2.3
 310 .\}
 311 James Clark\*(Aqs
 312 SGML
 313 catalog page
 314 \m[blue]\fB\%http://www.jclark.com/sp/catalog.htm\fR\m[]
 315 .RE
 316 .sp
 317 .RS 4
 318 .ie n \{\
 319 \h'-04'\(bu\h'+03'\c
 320 .\}
 321 .el \{\
 322 .sp -1
 323 .IP \(bu 2.3
 324 .\}
 325 OASIS
 326 XML
 327 catalog specification
 328 \m[blue]\fB\%http://www.oasis-open.org/committees/entity/spec.html\fR\m[]
 329 .RE
 330 .sp
 331 .SH "AUTHOR"
 332 .PP
 333 \fBJohn Fleck\fR <\&jfleck@inkstain\&.net\&>
 334 .RS 4
 335 Author.
 336 .RE
 337 .SH "COPYRIGHT"
 338 .br
 339 Copyright \(co 2001, 2004
 340 .br