MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 1 | <?xml version="1.0"?> |
| 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" |
| 3 | "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ |
| 4 | ]> |
| 5 | <refentry> |
| 6 | <refentryinfo> |
| 7 | <title>xmlcatalog Manual</title> |
| 8 | <copyright> |
| 9 | <year>2001</year> |
| 10 | </copyright> |
| 11 | <author> |
| 12 | <firstname>John</firstname> |
| 13 | <surname>Fleck</surname> |
| 14 | </author> |
| 15 | <address><email>jfleck@inkstain.net</email></address> |
| 16 | <legalnotice id="legalnotice"> |
| 17 | <para>Permission is granted to copy, distribute and/or modify this document |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 18 | under the terms of the GNU Free Documentation |
| 19 | License, Version 1.1 or any later version |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 20 | published by the Free Software Foundation with no Invariant Sections, |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 21 | no Front-Cover Texts, and no Back-Cover Texts. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 22 | </para> |
| 23 | <para>Many of the names used by companies to distinguish their products and |
| 24 | services are claimed as trademarks. Where those names appear in any |
| 25 | GNOME documentation, and those trademarks are made aware to the members |
| 26 | of the GNOME Documentation Project, the names have been printed in caps |
| 27 | or initial caps. |
| 28 | </para> |
| 29 | </legalnotice> |
| 30 | <releaseinfo>This is release 0.1 of the xmlcatalog Manual.</releaseinfo> |
| 31 | </refentryinfo> |
| 32 | |
| 33 | <refmeta> |
| 34 | <refentrytitle>xmlcatalog</refentrytitle> |
| 35 | <manvolnum>1</manvolnum> |
| 36 | </refmeta> |
| 37 | <refnamediv> |
| 38 | <refname>xmlcatalog</refname> |
| 39 | <refpurpose>Command line tool to parse and manipulate <acronym>XML</acronym> or |
| 40 | <acronym>SGML</acronym> catalog files.</refpurpose> |
| 41 | </refnamediv> |
| 42 | |
| 43 | <refsynopsisdiv> |
| 44 | <cmdsynopsis> |
| 45 | <command>xmlcatalog</command> |
| 46 | <group> |
| 47 | <arg>--shell</arg> |
| 48 | <arg>--create</arg> |
| 49 | <arg>--add <replaceable>type</replaceable> |
| 50 | <replaceable>orig</replaceable> <replaceable>replace</replaceable></arg> |
| 51 | <arg>--del <replaceable>values</replaceable></arg> |
| 52 | <arg>--noout</arg> |
| 53 | <arg>--verbose</arg> |
| 54 | </group> |
| 55 | <arg><option><replaceable>catalogfile</replaceable></option></arg> |
| 56 | <arg><option><replaceable>entities</replaceable></option></arg> |
| 57 | </cmdsynopsis> |
| 58 | </refsynopsisdiv> |
| 59 | |
| 60 | <refsect1 id="introduction"> |
| 61 | <title>Introduction</title> |
| 62 | <para> |
| 63 | <application>xmlcatalog</application> is a command line application |
| 64 | allowing users to monitor and manipulate <acronym>XML</acronym> and |
| 65 | <acronym>SGML</acronym> catalogs. It is included in |
| 66 | <application>libxml2</application>. |
| 67 | </para> |
| 68 | |
| 69 | <para> |
| 70 | Its functions can be invoked from a single command from the command line, |
| 71 | or it can perform multiple functions in interactive mode. It can operate |
| 72 | on both <acronym>XML</acronym> and <acronym>SGML</acronym> files. |
| 73 | </para> |
| 74 | </refsect1> |
| 75 | |
| 76 | <refsect1 id="cloptions"> |
| 77 | <title>Command Line Options</title> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 78 | <variablelist> |
| 79 | <varlistentry> |
| 80 | <term><option>--shell</option> <replaceable>filename</replaceable></term> |
| 81 | <listitem> |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 82 | <simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 83 | Run a shell |
| 84 | allowing interactive queries on catalog file |
| 85 | <replaceable>filename</replaceable>. |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 86 | </simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 87 | </listitem> |
| 88 | </varlistentry> |
| 89 | <varlistentry> |
| 90 | <term><option>--create</option> <replaceable>filename</replaceable></term> |
| 91 | <listitem> |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 92 | <simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 93 | Create a new |
| 94 | <acronym>XML</acronym> catalog. Outputs to stdout, ignoring |
| 95 | <replaceable>filename</replaceable> unless <option>--noout</option> is |
| 96 | used, in which case it creates a new catalog file |
| 97 | <replaceable>filename</replaceable>. |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 98 | </simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 99 | </listitem> |
| 100 | </varlistentry> |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 101 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 102 | <varlistentry> |
| 103 | <term><option>--add</option> <replaceable>'type'</replaceable> <replaceable>'orig'</replaceable> <replaceable>'replace'</replaceable> <replaceable>filename</replaceable></term> |
| 104 | <listitem> |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 105 | <simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 106 | Add an entry to catalog file |
| 107 | <filename>filename</filename>. <replaceable>type</replaceable> indicates |
| 108 | the type of entry. Possible types are 'public', 'system', 'rewriteSystem', |
| 109 | 'delegatePublic' and 'delegateSystem'. <replaceable>'orig'</replaceable> |
| 110 | is the original reference to |
| 111 | be replaced, and <replaceable>'replace'</replaceable> is the |
| 112 | <acronym>URI</acronym> of the replacement entity to be used. The |
MDT 2001 John Fleck | 60416fa | 2001-10-09 02:41:50 +0000 | [diff] [blame^] | 113 | <option>--add</option> option will not overwrite |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 114 | <replaceable>filename</replaceable>, outputing to stdout, unless |
| 115 | <option>--noout</option> is used. The <option>--add</option> will always |
| 116 | take three parameters even if some of the <acronym>XML</acronym> catalog |
| 117 | constructs will have only a single argument. |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 118 | <!-- |
| 119 | FIXME - Is my list of possible types correct? Are SGML types the same? |
| 120 | --> |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 121 | </simpara> |
MDT 2001 John Fleck | 60416fa | 2001-10-09 02:41:50 +0000 | [diff] [blame^] | 122 | <simpara> |
| 123 | If the <option>--add</option> option is used following the |
| 124 | <option>--sgml</option> option, only a single argument, a |
| 125 | <replaceable>filename</replaceable>, is used. This is used to add |
| 126 | the name of a catalog file to an <acronym>SGML</acronym> |
| 127 | supercatalog, a file that contains references to other included |
| 128 | <acronym>SGML</acronym> catalog files. |
| 129 | </simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 130 | </listitem> |
| 131 | </varlistentry> |
| 132 | <varlistentry> |
| 133 | <term><option>--del</option> <replaceable>'values'</replaceable> <replaceable>filename</replaceable></term> |
| 134 | <listitem> |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 135 | <simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 136 | Remove entries from the catalog file |
| 137 | <replaceable>filename</replaceable> matching |
| 138 | <replaceable>'values'</replaceable>. The <option>--del</option> option |
| 139 | will not overwrite <replaceable>filename</replaceable>, outputing to |
| 140 | stdout, unless <option>--noout</option> is used. |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 141 | </simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 142 | </listitem> |
| 143 | </varlistentry> |
| 144 | <varlistentry> |
| 145 | <term><option>--noout</option></term> |
| 146 | <listitem> |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 147 | <simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 148 | Save output to the named file rather than |
| 149 | outputing to stdout. |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 150 | </simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 151 | </listitem> |
| 152 | </varlistentry> |
| 153 | <varlistentry> |
| 154 | <term><option>-v</option> or <option>--verbose</option></term> |
| 155 | <listitem> |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 156 | <simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 157 | output debugging |
| 158 | information. |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 159 | </simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 160 | </listitem> |
| 161 | </varlistentry> |
| 162 | </variablelist> |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 163 | </refsect1> |
| 164 | |
| 165 | <refsect1 id="shell"> |
| 166 | <title>Shell Commands</title> |
| 167 | <para>Invoking <application>xmlcatalog</application> with the |
| 168 | <option>--shell</option> <replaceable>filename</replaceable> option opens |
| 169 | a command line shell allowing interactive access to the catalog file |
| 170 | identified by <replaceable>filename</replaceable>. Invoking the shell |
| 171 | provides a command line prompt after which commands can be entered. |
| 172 | </para> |
| 173 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 174 | <variablelist> |
| 175 | <varlistentry> |
| 176 | <term><option>public</option> <replaceable>'PublicID'</replaceable></term> |
| 177 | <listitem> |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 178 | <simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 179 | Execute a |
| 180 | public identifier lookup of the catalog entry for |
| 181 | <replaceable>'PublicID'</replaceable>. The corresponding entry will be |
| 182 | output to the command line. |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 183 | </simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 184 | </listitem> |
| 185 | </varlistentry> |
| 186 | |
| 187 | <varlistentry> |
| 188 | <term><option>system</option> <replaceable>'SystemID'</replaceable></term> |
| 189 | <listitem> |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 190 | <simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 191 | Execute a |
| 192 | public identifier lookup of the catalog entry for |
| 193 | <replaceable>'SystemID'</replaceable>. The corresponding entry will be |
| 194 | output to the command line. |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 195 | </simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 196 | </listitem> |
| 197 | </varlistentry> |
| 198 | <varlistentry> |
| 199 | <term><option>add </option> <replaceable>'type'</replaceable> <replaceable>'orig'</replaceable> <replaceable>'replace'</replaceable></term> |
| 200 | <listitem> |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 201 | <simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 202 | Add an entry to the catalog |
| 203 | file. <replaceable>type</replaceable> indicates the type of |
| 204 | entry. Possible types are 'public', 'system', 'rewriteSystem', |
| 205 | 'delegatePublic' and 'delegateSystem'. <replaceable>'orig'</replaceable> |
| 206 | is the original reference to be replaced, and |
| 207 | <replaceable>'replace'</replaceable> is the <acronym>URI</acronym> of the |
| 208 | replacement entity to be used. |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 209 | </simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 210 | </listitem> |
| 211 | </varlistentry> |
| 212 | <varlistentry> |
| 213 | <term><option>del</option> <replaceable>'values'</replaceable></term> |
| 214 | <listitem> |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 215 | <simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 216 | Remove the |
| 217 | catalog entry corresponding to <replaceable>'values'</replaceable>. |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 218 | </simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 219 | </listitem> |
| 220 | </varlistentry> |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 221 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 222 | <varlistentry> |
| 223 | <term><option>dump</option></term> |
| 224 | <listitem> |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 225 | <simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 226 | Print the current catalog. |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 227 | </simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 228 | </listitem> |
| 229 | </varlistentry> |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 230 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 231 | <varlistentry> |
| 232 | <term><option>debug</option></term> |
| 233 | <listitem> |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 234 | <simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 235 | Print debugging statements showing the steps |
| 236 | <application>xmlcatalog</application> is executing. |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 237 | </simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 238 | </listitem> |
| 239 | </varlistentry> |
| 240 | |
| 241 | <varlistentry> |
| 242 | <term><option>quiet</option></term> |
| 243 | <listitem> |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 244 | <simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 245 | Stop printing debugging statements. |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 246 | </simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 247 | </listitem> |
| 248 | </varlistentry> |
| 249 | |
| 250 | <varlistentry> |
| 251 | <term><option>exit</option></term> |
| 252 | <listitem> |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 253 | <simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 254 | Quit the shell. |
MDT 2001 John Fleck | 0e22993 | 2001-10-07 22:46:00 +0000 | [diff] [blame] | 255 | </simpara> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 256 | </listitem> |
| 257 | </varlistentry> |
| 258 | </variablelist> |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 259 | |
| 260 | </refsect1> |
| 261 | |
| 262 | |
| 263 | <refsect1 id="references"> |
| 264 | <title>References</title> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 265 | <variablelist> |
| 266 | |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 267 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 268 | <varlistentry> |
| 269 | <term>libxml web page:</term> |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 270 | <listitem> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 271 | <simpara> |
| 272 | <ulink |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 273 | url="http://www.xmlsoft.org/">http://www.xmlsoft.org/</ulink> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 274 | </simpara> |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 275 | </listitem> |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 276 | </varlistentry> |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 277 | |
MDT 2001 John Fleck | ac941e3 | 2001-10-06 22:30:16 +0000 | [diff] [blame] | 278 | <varlistentry> |
| 279 | <term><application>libxml</application> catalog support web page:</term> |
| 280 | <listitem> |
| 281 | <simpara> |
| 282 | <ulink url="http://www.xmlsoft.org/catalog.html">http://www.xmlsoft.org/catalog.html</ulink> |
| 283 | </simpara> |
| 284 | </listitem> |
| 285 | </varlistentry> |
| 286 | |
| 287 | |
| 288 | <varlistentry> |
| 289 | <term>James Clark's <acronym>SGML</acronym> catalog page:</term> |
| 290 | <listitem> |
| 291 | <simpara> |
| 292 | <ulink |
| 293 | url="http://www.jclark.com/sp/catalog.htm">http://www.jclark.com/sp/catalog.htm</ulink> |
| 294 | </simpara> |
| 295 | </listitem> |
| 296 | </varlistentry> |
| 297 | |
| 298 | <varlistentry> |
| 299 | <term><acronym>OASIS</acronym> <acronym>XML</acronym> catalog specification:</term> |
| 300 | <listitem> |
| 301 | <simpara> |
| 302 | <ulink |
| 303 | url="http://www.oasis-open.org/committees/entity/spec.html">http://www.oasis-open.org/committees/entity/spec.html</ulink> |
| 304 | </simpara> |
| 305 | </listitem> |
| 306 | </varlistentry> |
| 307 | </variablelist> |
| 308 | |
MDT 2001 John Fleck | 5bd39dc | 2001-09-03 15:14:19 +0000 | [diff] [blame] | 309 | </refsect1> |
| 310 | |
| 311 | </refentry> |