libxml2/doc/xmlcatalog.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "XMLCATALOG" 1 "" "" "xmlcatalog Manual"
  21 .SH NAME
  22 xmlcatalog \- Command line tool to parse and manipulate XML or SGML catalog files.
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 \fBxmlcatalog\fR [\fB--shell\fR | \fB--create\fR | \fB--add \fItype\fR \fIorig\fR \fIreplace\fR\fR
  27            | \fB--del \fIvalues\fR\fR | \fB--noout\fR | \fB--verbose\fR] [\fBcatalogfile\fR]
  28            [\fBentities\fR]
  29 .fi
  30
  31 .SH "INTRODUCTION"
  32
  33 .PP
  34  xmlcatalog is a command line application allowing users to monitor and manipulate XML and SGML catalogs. It is included in libxml2.
  35
  36 .PP
  37 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.
  38
  39 .SH "COMMAND LINE OPTIONS"
  40
  41 .TP
  42 \fB--shell\fR \fIfilename\fR
  43 Run a shell allowing interactive queries on catalog file \fIfilename\fR.
  44
  45 .TP
  46 \fB--create\fR \fIfilename\fR
  47 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.
  48
  49 .TP
  50 \fB--add\fR \fI'type'\fR \fI'orig'\fR \fI'replace'\fR \fIfilename\fR
  51 Add an entry to catalog file \fIfilename\fR. \fItype\fR indicates the type of entry. Possible types are 'public', 'system', 'rewriteSystem', 'delegatePublic', 'delegateSystem'amd 'rewriteURI'. \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.
  52
  53 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.
  54
  55 .TP
  56 \fB--del\fR \fI'values'\fR \fIfilename\fR
  57 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.
  58
  59 .TP
  60 \fB--noout\fR
  61 Save output to the named file rather than outputing to stdout.
  62
  63 .TP
  64 \fB--sgml\fR
  65 Uses SGML Super catalogs for --add and --del options
  66
  67 .TP
  68 \fB-v\fR or \fB--verbose\fR
  69 output debugging information.
  70
  71 .SH "SHELL COMMANDS"
  72
  73 .PP
  74 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.
  75
  76 .TP
  77 \fBpublic\fR \fI'PublicID'\fR
  78 Execute a public identifier lookup of the catalog entry for \fI'PublicID'\fR. The corresponding entry will be output to the command line.
  79
  80 .TP
  81 \fBsystem\fR \fI'SystemID'\fR
  82 Execute a public identifier lookup of the catalog entry for \fI'SystemID'\fR. The corresponding entry will be output to the command line.
  83
  84 .TP
  85 \fBadd \fR \fI'type'\fR \fI'orig'\fR \fI'replace'\fR
  86 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.
  87
  88 .TP
  89 \fBdel\fR \fI'values'\fR
  90 Remove the catalog entry corresponding to \fI'values'\fR.
  91
  92 .TP
  93 \fBdump\fR
  94 Print the current catalog.
  95
  96 .TP
  97 \fBdebug\fR
  98 Print debugging statements showing the steps xmlcatalog is executing.
  99
 100 .TP
 101 \fBquiet\fR
 102 Stop printing debugging statements.
 103
 104 .TP
 105 \fBexit\fR
 106 Quit the shell.
 107
 108 .SH "RETURN VALUES"
 109
 110 .PP
 111 xmlcatalog's return codes provide information that can be used when calling it from scripts.
 112
 113 .PP
 114 0: normal
 115
 116 .PP
 117 1: Failed to remove an entry from the catalog
 118
 119 .PP
 120 2: Failed to save to the catalog, check file permissions
 121
 122 .PP
 123 3: Failed to add an entry to the catalog
 124
 125 .PP
 126 4: Failed to lookup and entry in the catalog
 127
 128 .SH "REFERENCES"
 129
 130 .PP
 131 : libxml web pagehttp://www.xmlsoft.org/
 132
 133 .PP
 134 : libxml catalog support web page:http://www.xmlsoft.org/catalog.html
 135
 136 .PP
 137 : James Clark's SGML catalog page:http://www.jclark.com/sp/catalog.htm
 138
 139 .PP
 140 : OASIS XML catalog specification: http://www.oasis-open.org/committees/entity/spec.html
 141
 142 .SH AUTHOR
 143 John Fleck.