MST 2003 John Fleck | 937362d | 2003-01-27 00:04:32 +0000 | [diff] [blame] | 1 | .\"Generated by db2man.xsl. Don't modify this, modify the source. |
MDT 2001 John Fleck | 9f82dc6 | 2001-10-06 02:40:10 +0000 | [diff] [blame] | 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 | .. |
MST 2003 John Fleck | 937362d | 2003-01-27 00:04:32 +0000 | [diff] [blame] | 20 | .TH "XMLCATALOG" 1 "" "" "xmlcatalog Manual" |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 21 | .SH NAME |
MST 2003 John Fleck | 937362d | 2003-01-27 00:04:32 +0000 | [diff] [blame] | 22 | xmlcatalog \- Command line tool to parse and manipulate XML or SGML catalog files. |
MDT 2001 John Fleck | 9f82dc6 | 2001-10-06 02:40:10 +0000 | [diff] [blame] | 23 | .SH "SYNOPSIS" |
MST 2003 John Fleck | 937362d | 2003-01-27 00:04:32 +0000 | [diff] [blame] | 24 | |
| 25 | .nf |
| 26 | \fBxmlcatalog\fR [\fB--shell\fR | \fB--create\fR | \fB--add \fItype\fR \fIorig\fR \fIreplace\fR\fR |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 27 | | \fB--del \fIvalues\fR\fR | \fB--noout\fR | \fB--verbose\fR] [\fBcatalogfile\fR] |
| 28 | [\fBentities\fR] |
MST 2003 John Fleck | 937362d | 2003-01-27 00:04:32 +0000 | [diff] [blame] | 29 | .fi |
| 30 | |
MDT 2001 John Fleck | 9f82dc6 | 2001-10-06 02:40:10 +0000 | [diff] [blame] | 31 | .SH "INTRODUCTION" |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 32 | |
| 33 | .PP |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 34 | xmlcatalog is a command line application allowing users to monitor and manipulate XML and SGML catalogs. It is included in libxml2. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 35 | |
| 36 | .PP |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 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. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 38 | |
MDT 2001 John Fleck | 9f82dc6 | 2001-10-06 02:40:10 +0000 | [diff] [blame] | 39 | .SH "COMMAND LINE OPTIONS" |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 40 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 41 | .TP |
| 42 | \fB--shell\fR \fIfilename\fR |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 43 | Run a shell allowing interactive queries on catalog file \fIfilename\fR. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 44 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 45 | .TP |
| 46 | \fB--create\fR \fIfilename\fR |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 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. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 48 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 49 | .TP |
| 50 | \fB--add\fR \fI'type'\fR \fI'orig'\fR \fI'replace'\fR \fIfilename\fR |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 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. |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 52 | |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 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. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 54 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 55 | .TP |
| 56 | \fB--del\fR \fI'values'\fR \fIfilename\fR |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 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. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 58 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 59 | .TP |
| 60 | \fB--noout\fR |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 61 | Save output to the named file rather than outputing to stdout. |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 62 | |
MST 2003 John Fleck | 937362d | 2003-01-27 00:04:32 +0000 | [diff] [blame] | 63 | .TP |
| 64 | \fB--sgml\fR |
| 65 | Uses SGML Super catalogs for --add and --del options |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 66 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 67 | .TP |
| 68 | \fB-v\fR or \fB--verbose\fR |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 69 | output debugging information. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 70 | |
MDT 2001 John Fleck | 9f82dc6 | 2001-10-06 02:40:10 +0000 | [diff] [blame] | 71 | .SH "SHELL COMMANDS" |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 72 | |
| 73 | .PP |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 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. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 75 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 76 | .TP |
| 77 | \fBpublic\fR \fI'PublicID'\fR |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 78 | Execute a public identifier lookup of the catalog entry for \fI'PublicID'\fR. The corresponding entry will be output to the command line. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 79 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 80 | .TP |
| 81 | \fBsystem\fR \fI'SystemID'\fR |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 82 | Execute a public identifier lookup of the catalog entry for \fI'SystemID'\fR. The corresponding entry will be output to the command line. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 83 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 84 | .TP |
| 85 | \fBadd \fR \fI'type'\fR \fI'orig'\fR \fI'replace'\fR |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 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. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 87 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 88 | .TP |
| 89 | \fBdel\fR \fI'values'\fR |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 90 | Remove the catalog entry corresponding to \fI'values'\fR. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 91 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 92 | .TP |
| 93 | \fBdump\fR |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 94 | Print the current catalog. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 95 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 96 | .TP |
| 97 | \fBdebug\fR |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 98 | Print debugging statements showing the steps xmlcatalog is executing. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 99 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 100 | .TP |
| 101 | \fBquiet\fR |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 102 | Stop printing debugging statements. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 103 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 104 | .TP |
| 105 | \fBexit\fR |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 106 | Quit the shell. |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 107 | |
MST 2003 John Fleck | 937362d | 2003-01-27 00:04:32 +0000 | [diff] [blame] | 108 | .SH "RETURN VALUES" |
| 109 | |
| 110 | .PP |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 111 | xmlcatalog's return codes provide information that can be used when calling it from scripts. |
MST 2003 John Fleck | 937362d | 2003-01-27 00:04:32 +0000 | [diff] [blame] | 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 |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 127 | |
MDT 2001 John Fleck | 9f82dc6 | 2001-10-06 02:40:10 +0000 | [diff] [blame] | 128 | .SH "REFERENCES" |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 129 | |
MST 2001 John Fleck | 3fc555e | 2001-12-11 04:41:24 +0000 | [diff] [blame] | 130 | .PP |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 131 | : libxml web pagehttp://www.xmlsoft.org/ |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 132 | |
MST 2001 John Fleck | 3fc555e | 2001-12-11 04:41:24 +0000 | [diff] [blame] | 133 | .PP |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 134 | : libxml catalog support web page:http://www.xmlsoft.org/catalog.html |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 135 | |
MST 2001 John Fleck | 3fc555e | 2001-12-11 04:41:24 +0000 | [diff] [blame] | 136 | .PP |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 137 | : James Clark's SGML catalog page:http://www.jclark.com/sp/catalog.htm |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 138 | |
MST 2001 John Fleck | 3fc555e | 2001-12-11 04:41:24 +0000 | [diff] [blame] | 139 | .PP |
Daniel Veillard | fd58341 | 2003-04-25 13:22:10 +0000 | [diff] [blame] | 140 | : OASIS XML catalog specification: http://www.oasis-open.org/committees/entity/spec.html |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 141 | |
MDT 2001 John Fleck | 9f82dc6 | 2001-10-06 02:40:10 +0000 | [diff] [blame] | 142 | .SH AUTHOR |
MST 2003 John Fleck | 937362d | 2003-01-27 00:04:32 +0000 | [diff] [blame] | 143 | John Fleck. |