Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / ac941e32125d5d8a96fe504329c0b17c58ecbd04 / . / doc / xmlcatalog_man.html
blob: 60db2e52a28a92301f1301ebf7aac72f8c39db63 [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 Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]12<a name="id2707811"></a><h2>Name</h2>xmlcatalog &#x2014; 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>
42<dd><p>
43<a name="id2705369"></a>
44 Run a shell
45 allowing interactive queries on catalog file
46 <i><tt>filename</tt></i>.
47 </p></dd>
48<dt>
49<a name="id2705383"></a><span class="term"><tt>--create</tt> <i><tt>filename</tt></i></span>
50</dt>
51<dd><p>
52<a name="id2705396"></a>
53 Create a new
54 XML catalog. Outputs to stdout, ignoring
55 <i><tt>filename</tt></i> unless <tt>--noout</tt> is
56 used, in which case it creates a new catalog file
57 <i><tt>filename</tt></i>.
58 </p></dd>
59<dt>
60<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>
61</dt>
62<dd><p>
63<a name="id2705448"></a>
64 Add an entry to catalog file
65 <tt>filename</tt>. <i><tt>type</tt></i> indicates
66 the type of entry. Possible types are 'public', 'system', 'rewriteSystem',
67 'delegatePublic' and 'delegateSystem'. <i><tt>'orig'</tt></i>
68 is the original reference to
69 be replaced, and <i><tt>'replace'</tt></i> is the
70 URI of the replacement entity to be used. The
71 <tt>-add</tt> option will not overwrite
72 <i><tt>filename</tt></i>, outputing to stdout, unless
73 <tt>--noout</tt> is used. The <tt>--add</tt> will always
74 take three parameters even if some of the XML catalog
75 constructs will have only a single argument.
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 </p></dd>
78<dt>
79<a name="id2708138"></a><span class="term"><tt>--del</tt> <i><tt>'values'</tt></i> <i><tt>filename</tt></i></span>
80</dt>
81<dd><p>
82<a name="id2708155"></a>
83 Remove entries from the catalog file
84 <i><tt>filename</tt></i> matching
85 <i><tt>'values'</tt></i>. The <tt>--del</tt> option
86 will not overwrite <i><tt>filename</tt></i>, outputing to
87 stdout, unless <tt>--noout</tt> is used.
88 </p></dd>
89<dt>
90<a name="id2708187"></a><span class="term"><tt>--noout</tt></span>
91</dt>
92<dd><p>
93<a name="id2708196"></a>
94 Save output to the named file rather than
95 outputing to stdout.
96 </p></dd>
97<dt>
98<a name="id2708207"></a><span class="term"><tt>-v</tt> or <tt>--verbose</tt></span>
99</dt>
100<dd><p>
101<a name="id2708220"></a>
102 output debugging
103 information.
104 </p></dd>
105</dl></div>
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]106</div>
107<div class="refsect1">
108<a name="shell"></a><h2>
109<a name="shell"></a>Shell Commands</h2>
110<p>Invoking xmlcatalog with the
111 <tt>--shell</tt> <i><tt>filename</tt></i> option opens
112 a command line shell allowing interactive access to the catalog file
113 identified by <i><tt>filename</tt></i>. Invoking the shell
114 provides a command line prompt after which commands can be entered.
115 </p>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]116<div class="variablelist"><dl>
117<dt>
118<a name="id2708274"></a><span class="term"><tt>public</tt> <i><tt>'PublicID'</tt></i></span>
119</dt>
120<dd><p>
121<a name="id2708287"></a>
122 Execute a
123 public identifier lookup of the catalog entry for
124 <i><tt>'PublicID'</tt></i>. The corresponding entry will be
125 output to the command line.
126 </p></dd>
127<dt>
128<a name="id2708302"></a><span class="term"><tt>system</tt> <i><tt>'SystemID'</tt></i></span>
129</dt>
130<dd><p>
131<a name="id2708315"></a>
132 Execute a
133 public identifier lookup of the catalog entry for
134 <i><tt>'SystemID'</tt></i>. The corresponding entry will be
135 output to the command line.
136 </p></dd>
137<dt>
138<a name="id2708331"></a><span class="term"><tt>add </tt> <i><tt>'type'</tt></i> <i><tt>'orig'</tt></i> <i><tt>'replace'</tt></i></span>
139</dt>
140<dd><p>
141<a name="id2708352"></a>
142 Add an entry to the catalog
143 file. <i><tt>type</tt></i> indicates the type of
144 entry. Possible types are 'public', 'system', 'rewriteSystem',
145 'delegatePublic' and 'delegateSystem'. <i><tt>'orig'</tt></i>
146 is the original reference to be replaced, and
147 <i><tt>'replace'</tt></i> is the URI of the
148 replacement entity to be used.
149 </p></dd>
150<dt>
151<a name="id2708383"></a><span class="term"><tt>del</tt> <i><tt>'values'</tt></i></span>
152</dt>
153<dd><p>
154<a name="id2708396"></a>
155 Remove the
156 catalog entry corresponding to <i><tt>'values'</tt></i>.
157 </p></dd>
158<dt>
159<a name="id2705468"></a><span class="term"><tt>dump</tt></span>
160</dt>
161<dd><p>
162<a name="id2705478"></a>
163 Print the current catalog.
164 </p></dd>
165<dt>
166<a name="id2708682"></a><span class="term"><tt>debug</tt></span>
167</dt>
168<dd><p>
169<a name="id2708691"></a>
170 Print debugging statements showing the steps
171 xmlcatalog is executing.
172 </p></dd>
173<dt>
174<a name="id2708708"></a><span class="term"><tt>quiet</tt></span>
175</dt>
176<dd><p>
177<a name="id2708717"></a>
178 Stop printing debugging statements.
179 </p></dd>
180<dt>
181<a name="id2708728"></a><span class="term"><tt>exit</tt></span>
182</dt>
183<dd><p>
184<a name="id2708737"></a>
185 Quit the shell.
186 </p></dd>
187</dl></div>
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]188</div>
189<div class="refsect1">
190<a name="references"></a><h2>
191<a name="references"></a>References</h2>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame^]192<div class="variablelist"><dl>
193<dt>
194<a name="id2708766"></a><span class="term">libxml web page:</span>
195</dt>
196<dd>
197 <a href="http://www.xmlsoft.org/" target="_top">http://www.xmlsoft.org/</a>
198 </dd>
199<dt>
200<a name="id2708794"></a><span class="term">libxml catalog support web page:</span>
201</dt>
202<dd>
203 <a href="http://www.xmlsoft.org/catalog.html" target="_top">http://www.xmlsoft.org/catalog.html</a>
204 </dd>
205<dt>
206<a name="id2708828"></a><span class="term">James Clark's SGML catalog page:</span>
207</dt>
208<dd>
209 <a href="http://www.jclark.com/sp/catalog.htm" target="_top">http://www.jclark.com/sp/catalog.htm</a>
210 </dd>
211<dt>
212<a name="id2708861"></a><span class="term">OASIS XML catalog specification:</span>
213</dt>
214<dd>
215 <a href="http://www.oasis-open.org/committees/entity/spec.html" target="_top">http://www.oasis-open.org/committees/entity/spec.html</a>
216 </dd>
217</dl></div>
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]218</div>
219</div></body>
220</html>