Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / 3fc555e520e33464081c31b529cc24aac86d7852 / . / doc / xmlcatalog.1
blob: a772f9ddec028793f86845e589a3048469bcda1b [file] [log] [blame]
MDT 2001 John Fleck9f82dc62001-10-06 02:40:10 +0000[diff] [blame]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"
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]21.SH NAME
MDT 2001 John Fleck9f82dc62001-10-06 02:40:10 +0000[diff] [blame]22xmlcatalog \- Command line tool to parse and manipulate XML or
23 SGML catalog files.
24.SH "SYNOPSIS"
25\fBxmlcatalog\fR [\fB--shell\fR | \fB--create\fR | \fB--add \fItype\fR
26 \fIorig\fR \fIreplace\fR \fR | \fB--del \fIvalues\fR \fR | \fB--noout\fR | \fB--verbose\fR] [\fB\fIcatalogfile\fR\fR] [\fB\fIentities\fR\fR]
27.SH "INTRODUCTION"
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]28
29.PP
MDT 2001 John Fleck9f82dc62001-10-06 02:40:10 +0000[diff] [blame]30xmlcatalog is a command line application allowing users to monitor and manipulate XML and SGML catalogs. It is included in libxml2.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]31
32.PP
MDT 2001 John Fleck9f82dc62001-10-06 02:40:10 +0000[diff] [blame]33Its 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 Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]34
MDT 2001 John Fleck9f82dc62001-10-06 02:40:10 +0000[diff] [blame]35.SH "COMMAND LINE OPTIONS"
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]36
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]37.TP
38\fB--shell\fR \fIfilename\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]39
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]40Run a shell allowing interactive queries on catalog file \fIfilename\fR.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]41
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]42.TP
43\fB--create\fR \fIfilename\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]44
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]45Create 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 Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]46
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]47.TP
48\fB--add\fR \fI'type'\fR \fI'orig'\fR \fI'replace'\fR \fIfilename\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]49
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame]50Add an entry to catalog file \fIfilename\fR. \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. 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.
51
52
53If 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 Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]54
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]55.TP
56\fB--del\fR \fI'values'\fR \fIfilename\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]57
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]58Remove 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 Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]59
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]60.TP
61\fB--noout\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]62
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]63Save output to the named file rather than outputing to stdout.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]64
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]65.TP
66\fB-v\fR or \fB--verbose\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]67
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]68output debugging information.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]69
MDT 2001 John Fleck9f82dc62001-10-06 02:40:10 +0000[diff] [blame]70.SH "SHELL COMMANDS"
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]71
72.PP
MDT 2001 John Fleck9f82dc62001-10-06 02:40:10 +0000[diff] [blame]73Invoking 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 Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]74
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]75.TP
76\fBpublic\fR \fI'PublicID'\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]77
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]78Execute 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 Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]79
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]80.TP
81\fBsystem\fR \fI'SystemID'\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]82
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]83Execute 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 Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]84
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]85.TP
86\fBadd \fR \fI'type'\fR \fI'orig'\fR \fI'replace'\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]87
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]88Add 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 Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]89
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]90.TP
91\fBdel\fR \fI'values'\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]92
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]93Remove the catalog entry corresponding to \fI'values'\fR.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]94
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]95.TP
96\fBdump\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]97
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]98Print the current catalog.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]99
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]100.TP
101\fBdebug\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]102
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]103Print debugging statements showing the steps xmlcatalog is executing.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]104
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]105.TP
106\fBquiet\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]107
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]108Stop printing debugging statements.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]109
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]110.TP
111\fBexit\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]112
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]113Quit the shell.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]114
MDT 2001 John Fleck9f82dc62001-10-06 02:40:10 +0000[diff] [blame]115.SH "REFERENCES"
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]116
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]117.PP
118libxml web page: \fIhttp://www.xmlsoft.org/\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]119
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]120.PP
121libxml catalog support web page:: \fIhttp://www.xmlsoft.org/catalog.html\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]122
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]123.PP
124James Clark's SGML catalog page:: \fIhttp://www.jclark.com/sp/catalog.htm\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]125
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]126.PP
127OASIS XML catalog specification: : \fIhttp://www.oasis-open.org/committees/entity/spec.html\fR
MDT 2001 John Fleck0e229932001-10-07 22:46:00 +0000[diff] [blame]128
MDT 2001 John Fleck9f82dc62001-10-06 02:40:10 +0000[diff] [blame]129.SH AUTHOR
130Copyright 2001
131.Sp
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]132John Fleck <jfleck@inkstain.net>This is release 0.2 of the xmlcatalog Manual.