Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / 60416fa46e3afd3994b6b11da581c30548f0448e / . / doc / xmlcatalog_man.html
blob: 26b55072a35f159fdce5f81adeb837d1c1b6a07e [file] [log] [blame]
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
2<html>
3<head>
4<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
5<title>xmlcatalog</title>
6<meta name="generator" content="DocBook XSL Stylesheets V1.41">
7</head>
8<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
9<h1 class="title">
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]10<a name="id2703858"></a>xmlcatalog</h1>
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]11<div class="refnamediv">
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]12<a name="id2707811"></a><h2>Name</h2>xmlcatalog &#8212; Command line tool to parse and manipulate XML or
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]13 SGML catalog files.</div>
14<div class="refsynopsisdiv">
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]15<a name="id2707831"></a><h2>Synopsis</h2>
16<div class="cmdsynopsis" id="id2707834">
17<a name="id2707834"></a><tt>xmlcatalog</tt> [--shell | --create | --add <i><tt>type</tt></i>
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]18 <i><tt>orig</tt></i> <i><tt>replace</tt></i> | --del <i><tt>values</tt></i> | --noout | --verbose] [<tt><i><tt>catalogfile</tt></i></tt>] [<tt><i><tt>entities</tt></i></tt>]</div>
19</div>
20<div class="refsect1">
21<a name="introduction"></a><h2>
22<a name="introduction"></a>Introduction</h2>
23<p>
24 xmlcatalog is a command line application
25 allowing users to monitor and manipulate XML and
26 SGML catalogs. It is included in
27 libxml2.
28 </p>
29<p>
30 Its functions can be invoked from a single command from the command line,
31 or it can perform multiple functions in interactive mode. It can operate
32 on both XML and SGML files.
33 </p>
34</div>
35<div class="refsect1">
36<a name="cloptions"></a><h2>
37<a name="cloptions"></a>Command Line Options</h2>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]38<div class="variablelist"><dl>
39<dt>
40<a name="id2705356"></a><span class="term"><tt>--shell</tt> <i><tt>filename</tt></i></span>
41</dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]42<dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]43 Run a shell
44 allowing interactive queries on catalog file
45 <i><tt>filename</tt></i>.
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]46 </dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]47<dt>
48<a name="id2705383"></a><span class="term"><tt>--create</tt> <i><tt>filename</tt></i></span>
49</dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]50<dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]51 Create a new
52 XML catalog. Outputs to stdout, ignoring
53 <i><tt>filename</tt></i> unless <tt>--noout</tt> is
54 used, in which case it creates a new catalog file
55 <i><tt>filename</tt></i>.
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]56 </dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]57<dt>
58<a name="id2705423"></a><span class="term"><tt>--add</tt> <i><tt>'type'</tt></i> <i><tt>'orig'</tt></i> <i><tt>'replace'</tt></i> <i><tt>filename</tt></i></span>
59</dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]60<dd>
61<p>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]62 Add an entry to catalog file
63 <tt>filename</tt>. <i><tt>type</tt></i> indicates
64 the type of entry. Possible types are 'public', 'system', 'rewriteSystem',
65 'delegatePublic' and 'delegateSystem'. <i><tt>'orig'</tt></i>
66 is the original reference to
67 be replaced, and <i><tt>'replace'</tt></i> is the
68 URI of the replacement entity to be used. The
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]69 <tt>--add</tt> option will not overwrite
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]70 <i><tt>filename</tt></i>, outputing to stdout, unless
71 <tt>--noout</tt> is used. The <tt>--add</tt> will always
72 take three parameters even if some of the XML catalog
73 constructs will have only a single argument.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]74
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]75 </p>
76<p>
77 If the <tt>--add</tt> option is used following the
78 <tt>--sgml</tt> option, only a single argument, a
79 <i><tt>filename</tt></i>, is used. This is used to add
80 the name of a catalog file to an SGML
81 supercatalog, a file that contains references to other included
82 SGML catalog files.
83 </p>
84</dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]85<dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]86<a name="id2708168"></a><span class="term"><tt>--del</tt> <i><tt>'values'</tt></i> <i><tt>filename</tt></i></span>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]87</dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]88<dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]89 Remove entries from the catalog file
90 <i><tt>filename</tt></i> matching
91 <i><tt>'values'</tt></i>. The <tt>--del</tt> option
92 will not overwrite <i><tt>filename</tt></i>, outputing to
93 stdout, unless <tt>--noout</tt> is used.
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]94 </dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]95<dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]96<a name="id2708217"></a><span class="term"><tt>--noout</tt></span>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]97</dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]98<dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]99 Save output to the named file rather than
100 outputing to stdout.
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]101 </dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]102<dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]103<a name="id2708237"></a><span class="term"><tt>-v</tt> or <tt>--verbose</tt></span>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]104</dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]105<dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]106 output debugging
107 information.
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]108 </dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]109</dl></div>
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]110</div>
111<div class="refsect1">
112<a name="shell"></a><h2>
113<a name="shell"></a>Shell Commands</h2>
114<p>Invoking xmlcatalog with the
115 <tt>--shell</tt> <i><tt>filename</tt></i> option opens
116 a command line shell allowing interactive access to the catalog file
117 identified by <i><tt>filename</tt></i>. Invoking the shell
118 provides a command line prompt after which commands can be entered.
119 </p>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]120<div class="variablelist"><dl>
121<dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]122<a name="id2708304"></a><span class="term"><tt>public</tt> <i><tt>'PublicID'</tt></i></span>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]123</dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]124<dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]125 Execute a
126 public identifier lookup of the catalog entry for
127 <i><tt>'PublicID'</tt></i>. The corresponding entry will be
128 output to the command line.
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]129 </dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]130<dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]131<a name="id2708332"></a><span class="term"><tt>system</tt> <i><tt>'SystemID'</tt></i></span>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]132</dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]133<dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]134 Execute a
135 public identifier lookup of the catalog entry for
136 <i><tt>'SystemID'</tt></i>. The corresponding entry will be
137 output to the command line.
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]138 </dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]139<dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]140<a name="id2708361"></a><span class="term"><tt>add </tt> <i><tt>'type'</tt></i> <i><tt>'orig'</tt></i> <i><tt>'replace'</tt></i></span>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]141</dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]142<dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]143 Add an entry to the catalog
144 file. <i><tt>type</tt></i> indicates the type of
145 entry. Possible types are 'public', 'system', 'rewriteSystem',
146 'delegatePublic' and 'delegateSystem'. <i><tt>'orig'</tt></i>
147 is the original reference to be replaced, and
148 <i><tt>'replace'</tt></i> is the URI of the
149 replacement entity to be used.
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]150 </dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]151<dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]152<a name="id2708681"></a><span class="term"><tt>del</tt> <i><tt>'values'</tt></i></span>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]153</dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]154<dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]155 Remove the
156 catalog entry corresponding to <i><tt>'values'</tt></i>.
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]157 </dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]158<dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]159<a name="id2708708"></a><span class="term"><tt>dump</tt></span>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]160</dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]161<dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]162 Print the current catalog.
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]163 </dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]164<dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]165<a name="id2708728"></a><span class="term"><tt>debug</tt></span>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]166</dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]167<dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]168 Print debugging statements showing the steps
169 xmlcatalog is executing.
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]170 </dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]171<dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]172<a name="id2708755"></a><span class="term"><tt>quiet</tt></span>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]173</dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]174<dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]175 Stop printing debugging statements.
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]176 </dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]177<dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]178<a name="id2708774"></a><span class="term"><tt>exit</tt></span>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]179</dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]180<dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]181 Quit the shell.
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]182 </dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]183</dl></div>
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]184</div>
185<div class="refsect1">
186<a name="references"></a><h2>
187<a name="references"></a>References</h2>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]188<div class="variablelist"><dl>
189<dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]190<a name="id2708813"></a><span class="term">libxml web page:</span>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]191</dt>
192<dd>
193 <a href="http://www.xmlsoft.org/" target="_top">http://www.xmlsoft.org/</a>
194 </dd>
195<dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]196<a name="id2708841"></a><span class="term">libxml catalog support web page:</span>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]197</dt>
198<dd>
199 <a href="http://www.xmlsoft.org/catalog.html" target="_top">http://www.xmlsoft.org/catalog.html</a>
200 </dd>
201<dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]202<a name="id2708875"></a><span class="term">James Clark's SGML catalog page:</span>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]203</dt>
204<dd>
205 <a href="http://www.jclark.com/sp/catalog.htm" target="_top">http://www.jclark.com/sp/catalog.htm</a>
206 </dd>
207<dt>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame^]208<a name="id2708909"></a><span class="term">OASIS XML catalog specification:</span>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]209</dt>
210<dd>
211 <a href="http://www.oasis-open.org/committees/entity/spec.html" target="_top">http://www.oasis-open.org/committees/entity/spec.html</a>
212 </dd>
213</dl></div>
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]214</div>
215</div></body>
216</html>