Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / 3fc555e520e33464081c31b529cc24aac86d7852 / . / doc / xmlcatalog_man.html
blob: 6918a34406369da937480e5440b945cdd8afed3f [file] [log] [blame]
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]1<html><head><meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type"><title>xmlcatalog</title><meta name="generator" content="DocBook XSL Stylesheets V1.45"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"><h1 class="title">xmlcatalog</h1><div class="refnamediv"><h2>Name</h2><p>xmlcatalog &#8212; Command line tool to parse and manipulate XML or
2 SGML catalog files.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>xmlcatalog</tt> [--shell | --create | --add <i><tt>type</tt></i>
3 <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>]</p></div></div><div class="refsect1"><a name="introduction"></a><h2>Introduction</h2><p>
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]4 xmlcatalog is a command line application
5 allowing users to monitor and manipulate XML and
6 SGML catalogs. It is included in
7 libxml2.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]8 </p><p>
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]9 Its functions can be invoked from a single command from the command line,
10 or it can perform multiple functions in interactive mode. It can operate
11 on both XML and SGML files.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]12 </p></div><div class="refsect1"><a name="cloptions"></a><h2>Command Line Options</h2><div class="variablelist"><dl><dt><span class="term"><tt>--shell</tt> <i><tt>filename</tt></i></span></dt><dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]13 Run a shell
14 allowing interactive queries on catalog file
15 <i><tt>filename</tt></i>.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]16 </dd><dt><span class="term"><tt>--create</tt> <i><tt>filename</tt></i></span></dt><dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]17 Create a new
18 XML catalog. Outputs to stdout, ignoring
19 <i><tt>filename</tt></i> unless <tt>--noout</tt> is
20 used, in which case it creates a new catalog file
21 <i><tt>filename</tt></i>.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]22 </dd><dt><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></dt><dd><p>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]23 Add an entry to catalog file
24 <tt>filename</tt>. <i><tt>type</tt></i> indicates
25 the type of entry. Possible types are 'public', 'system', 'rewriteSystem',
26 'delegatePublic' and 'delegateSystem'. <i><tt>'orig'</tt></i>
27 is the original reference to
28 be replaced, and <i><tt>'replace'</tt></i> is the
29 URI of the replacement entity to be used. The
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame]30 <tt>--add</tt> option will not overwrite
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]31 <i><tt>filename</tt></i>, outputing to stdout, unless
32 <tt>--noout</tt> is used. The <tt>--add</tt> will always
33 take three parameters even if some of the XML catalog
34 constructs will have only a single argument.
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]35
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]36 </p><p>
MDT 2001 John Fleck60416fa2001-10-09 02:41:50 +0000[diff] [blame]37 If the <tt>--add</tt> option is used following the
38 <tt>--sgml</tt> option, only a single argument, a
39 <i><tt>filename</tt></i>, is used. This is used to add
40 the name of a catalog file to an SGML
41 supercatalog, a file that contains references to other included
42 SGML catalog files.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]43 </p></dd><dt><span class="term"><tt>--del</tt> <i><tt>'values'</tt></i> <i><tt>filename</tt></i></span></dt><dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]44 Remove entries from the catalog file
45 <i><tt>filename</tt></i> matching
46 <i><tt>'values'</tt></i>. The <tt>--del</tt> option
47 will not overwrite <i><tt>filename</tt></i>, outputing to
48 stdout, unless <tt>--noout</tt> is used.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]49 </dd><dt><span class="term"><tt>--noout</tt></span></dt><dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]50 Save output to the named file rather than
51 outputing to stdout.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]52 </dd><dt><span class="term"><tt>-v</tt> or <tt>--verbose</tt></span></dt><dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]53 output debugging
54 information.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]55 </dd></dl></div></div><div class="refsect1"><a name="shell"></a><h2>Shell Commands</h2><p>Invoking xmlcatalog with the
MDT 2001 John Fleck5bd39dc2001-09-03 15:14:19 +0000[diff] [blame]56 <tt>--shell</tt> <i><tt>filename</tt></i> option opens
57 a command line shell allowing interactive access to the catalog file
58 identified by <i><tt>filename</tt></i>. Invoking the shell
59 provides a command line prompt after which commands can be entered.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]60 </p><div class="variablelist"><dl><dt><span class="term"><tt>public</tt> <i><tt>'PublicID'</tt></i></span></dt><dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]61 Execute a
62 public identifier lookup of the catalog entry for
63 <i><tt>'PublicID'</tt></i>. The corresponding entry will be
64 output to the command line.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]65 </dd><dt><span class="term"><tt>system</tt> <i><tt>'SystemID'</tt></i></span></dt><dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]66 Execute a
67 public identifier lookup of the catalog entry for
68 <i><tt>'SystemID'</tt></i>. The corresponding entry will be
69 output to the command line.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]70 </dd><dt><span class="term"><tt>add </tt> <i><tt>'type'</tt></i> <i><tt>'orig'</tt></i> <i><tt>'replace'</tt></i></span></dt><dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]71 Add an entry to the catalog
72 file. <i><tt>type</tt></i> indicates the type of
73 entry. Possible types are 'public', 'system', 'rewriteSystem',
74 'delegatePublic' and 'delegateSystem'. <i><tt>'orig'</tt></i>
75 is the original reference to be replaced, and
76 <i><tt>'replace'</tt></i> is the URI of the
77 replacement entity to be used.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]78 </dd><dt><span class="term"><tt>del</tt> <i><tt>'values'</tt></i></span></dt><dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]79 Remove the
80 catalog entry corresponding to <i><tt>'values'</tt></i>.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]81 </dd><dt><span class="term"><tt>dump</tt></span></dt><dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]82 Print the current catalog.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]83 </dd><dt><span class="term"><tt>debug</tt></span></dt><dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]84 Print debugging statements showing the steps
85 xmlcatalog is executing.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]86 </dd><dt><span class="term"><tt>quiet</tt></span></dt><dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]87 Stop printing debugging statements.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]88 </dd><dt><span class="term"><tt>exit</tt></span></dt><dd>
MDT 2001 John Fleckac941e32001-10-06 22:30:16 +0000[diff] [blame]89 Quit the shell.
MST 2001 John Fleck3fc555e2001-12-11 04:41:24 +0000[diff] [blame^]90 </dd></dl></div></div><div class="refsect1"><h2>References</h2><p><a href="http://www.xmlsoft.org/" target="_top">libxml web page</a></p><p><a href="http://www.xmlsoft.org/catalog.html" target="_top">libxml
91 catalog support web page:</a></p><p><a href="http://www.jclark.com/sp/catalog.htm" target="_top">James Clark's
92 SGML catalog page:</a></p><p><a href="http://www.oasis-open.org/committees/entity/spec.html" target="_top">OASIS
93 XML catalog specification: </a></p></div></div></body></html>