Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / ac941e32125d5d8a96fe504329c0b17c58ecbd04 / . / doc / xmlcatalog.1
blob: 9e76b1dcc4178e0da22e965a1169912d5d52dbf0 [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 Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]39.PP
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 Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]44.PP
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 Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]49.PP
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +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.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]51
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]52.TP
53\fB--del\fR \fI'values'\fR \fIfilename\fR
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]54.PP
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]55Remove 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]56
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]57.TP
58\fB--noout\fR
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]59.PP
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]60Save output to the named file rather than outputing to stdout.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]61
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]62.TP
63\fB-v\fR or \fB--verbose\fR
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]64.PP
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]65output debugging information.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]66
MDT 2001 John Fleck9f82dc62001-10-06 02:40:10 +0000[diff] [blame]67.SH "SHELL COMMANDS"
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]68
69.PP
MDT 2001 John Fleck9f82dc62001-10-06 02:40:10 +0000[diff] [blame]70Invoking 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]71
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]72.TP
73\fBpublic\fR \fI'PublicID'\fR
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]74.PP
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]75Execute 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]76
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]77.TP
78\fBsystem\fR \fI'SystemID'\fR
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]79.PP
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]80Execute 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]81
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]82.TP
83\fBadd \fR \fI'type'\fR \fI'orig'\fR \fI'replace'\fR
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]84.PP
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]85Add 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]86
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]87.TP
88\fBdel\fR \fI'values'\fR
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]89.PP
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]90Remove the catalog entry corresponding to \fI'values'\fR.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]91
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]92.TP
93\fBdump\fR
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]94.PP
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]95Print the current catalog.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]96
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]97.TP
98\fBdebug\fR
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]99.PP
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]100Print debugging statements showing the steps xmlcatalog is executing.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]101
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]102.TP
103\fBquiet\fR
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]104.PP
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]105Stop printing debugging statements.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]106
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]107.TP
108\fBexit\fR
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]109.PP
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]110Quit the shell.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]111
MDT 2001 John Fleck9f82dc62001-10-06 02:40:10 +0000[diff] [blame]112.SH "REFERENCES"
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]113
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]114.TP
115libxml web page:
116 http://www.xmlsoft.org/: \fIhttp://www.xmlsoft.org/\fR
117
118.TP
119libxml catalog support web page:
120 http://www.xmlsoft.org/catalog.html: \fIhttp://www.xmlsoft.org/catalog.html\fR
121
122.TP
123James Clark's SGML catalog page:
124 http://www.jclark.com/sp/catalog.htm: \fIhttp://www.jclark.com/sp/catalog.htm\fR
125
126.TP
127OASIS XML catalog specification:
128 http://www.oasis-open.org/committees/entity/spec.html: \fIhttp://www.oasis-open.org/committees/entity/spec.html\fR
129
MDT 2001 John Fleck9f82dc62001-10-06 02:40:10 +0000[diff] [blame]130.SH AUTHOR
131Copyright 2001
132.Sp
133John Fleck <jfleck@inkstain.net>
134.PP
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]135Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]136
MDT 2001 John Fleck9f82dc62001-10-06 02:40:10 +0000[diff] [blame]137.PP
138Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any GNOME documentation, and those trademarks are made aware to the members of the GNOME Documentation Project, the names have been printed in caps or initial caps.
139This is release 0.1 of the xmlcatalog Manual.