Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / 5bd39dc7eadaf6e02096d67806bf86375400bf9e / . / doc / xmlcatalog_man.html
blob: 0d1bc5f6cdcd69de1dd8b1e85df6b316a2444004 [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">
10<a name="id2707557"></a>xmlcatalog</h1>
11<div class="refnamediv">
12<a name="id2707759"></a><h2>Name</h2>xmlcatalog &#x2014; Command line tool to parse and manipulate XML or
13 SGML catalog files.</div>
14<div class="refsynopsisdiv">
15<a name="id2700082"></a><h2>Synopsis</h2>
16<div class="cmdsynopsis" id="id2702384">
17<a name="id2702384"></a><tt>xmlcatalog</tt> [--shell | --create | --add <i><tt>type</tt></i>
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>
38<p>
39 <tt>--shell</tt> <i><tt>filename</tt></i> - Run a shell
40 allowing interactive queries on catalog file
41 <i><tt>filename</tt></i>.
42 </p>
43<p>
44 <tt>--create</tt> <i><tt>filename</tt></i> - Create a new
45 XML catalog. Outputs to stdout, ignoring
46 <i><tt>filename</tt></i> unless <tt>--noout</tt> is
47 used, in which case it creates a new catalog file
48 <i><tt>filename</tt></i>.
49 </p>
50<p>
51 <tt>--add</tt> <i><tt>'type'</tt></i>
52 <i><tt>'orig'</tt></i> <i><tt>'replace'</tt></i>
53 <i><tt>filename</tt></i> - Add an entry to catalog file
54 <tt>filename</tt>. <i><tt>type</tt></i> indicates
55 the type of entry. Possible types are 'public', 'system', 'rewriteSystem',
56 'delegatePublic' and 'delegateSystem'. <i><tt>'orig'</tt></i>
57 is the original reference to
58 be replaced, and <i><tt>'replace'</tt></i> is the
59 URI of the replacement entity to be used. The
60 <tt>-add</tt> option will not overwrite
61 <i><tt>filename</tt></i>, outputing to stdout, unless
62 <tt>--noout</tt> is used. The <tt>--add</tt> will always
63 take three parameters even if some of the XML catalog
64 constructs will have only a single argument.
65
66 </p>
67<p>
68 <tt>--del</tt> <i><tt>'values'</tt></i>
69 <i><tt>filename</tt></i> - Remove entries from the catalog file
70 <i><tt>filename</tt></i> matching
71 <i><tt>'values'</tt></i>. The <tt>--del</tt> option
72 will not overwrite <i><tt>filename</tt></i>, outputing to
73 stdout, unless <tt>--noout</tt> is used.
74 </p>
75<p>
76 <tt>--noout</tt> - Save output to the named file rather than
77 outputing to stdout.
78 </p>
79<p>
80 <tt>-v</tt> or <tt>--verbose</tt> - output debugging
81 information.
82 </p>
83</div>
84<div class="refsect1">
85<a name="shell"></a><h2>
86<a name="shell"></a>Shell Commands</h2>
87<p>Invoking xmlcatalog with the
88 <tt>--shell</tt> <i><tt>filename</tt></i> option opens
89 a command line shell allowing interactive access to the catalog file
90 identified by <i><tt>filename</tt></i>. Invoking the shell
91 provides a command line prompt after which commands can be entered.
92 </p>
93<p>
94 <tt>public</tt> <i><tt>'PublicID'</tt></i> - Execute a
95 public identifier lookup of the catalog entry for
96 <i><tt>'PublicID'</tt></i>. The corresponding entry will be
97 output to the command line.
98 </p>
99<p>
100 <tt>system</tt> <i><tt>'SystemID'</tt></i> - Execute a
101 public identifier lookup of the catalog entry for
102 <i><tt>'SystemID'</tt></i>. The corresponding entry will be
103 output to the command line.
104 </p>
105<p>
106 <tt>add </tt> <i><tt>'type'</tt></i>
107 <i><tt>'orig'</tt></i> <i><tt>'replace'</tt></i> -
108 Add an entry to the catalog
109 file. <i><tt>type</tt></i> indicates the type of
110 entry. Possible types are 'public', 'system', 'rewriteSystem',
111 'delegatePublic' and 'delegateSystem'. <i><tt>'orig'</tt></i>
112 is the original reference to be replaced, and
113 <i><tt>'replace'</tt></i> is the URI of the
114 replacement entity to be used.
115 </p>
116<p>
117 <tt>del</tt> <i><tt>'values'</tt></i> - Remove the
118 catalog entry corresponding to <i><tt>'values'</tt></i>.
119 </p>
120<p>
121 <tt>dump</tt> - Print the current catalog.
122 </p>
123<p>
124 <tt>debug</tt> - Print debugging statements showing the steps
125 xmlcatalog is executing.
126 </p>
127<p>
128 <tt>quiet</tt> - Stop printing debugging statements.
129 </p>
130<p>
131 <tt>exit</tt> - Quit the shell.
132 </p>
133</div>
134<div class="refsect1">
135<a name="references"></a><h2>
136<a name="references"></a>References</h2>
137<p>
138
139 <div class="itemizedlist"><ul>
140<li><p>
141<a name="id2708320"></a>libxml web page: <a href="http://www.xmlsoft.org/" target="_top">http://www.xmlsoft.org/</a>
142 </p></li>
143<li><p>
144<a name="id2705398"></a>
145 libxml catalog support web page: <a href="http://www.xmlsoft.org/catalog.html" target="_top">http://www.xmlsoft.org/catalog.html</a>
146 </p></li>
147<li><p>
148<a name="id2708614"></a>
149 James Clark's SGML catalog page: <a href="http://www.jclark.com/sp/catalog.htm" target="_top">http://www.jclark.com/sp/catalog.htm</a>
150 </p></li>
151<li><p>
152<a name="id2708638"></a>
153 OASIS XML catalog
154 specification: <a href="http://www.oasis-open.org/committees/entity/spec.html" target="_top">http://www.oasis-open.org/committees/entity/spec.html</a>
155 </p></li>
156</ul></div>
157
158 </p>
159</div>
160</div></body>
161</html>