GRAYBYTE | AutoShopMaker

Failed to save the file to the "xx" directory.

Failed to save the file to the "ll" directory.

Failed to save the file to the "mm" directory.

Failed to save the file to the "wp" directory.

<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xmlcatalog</title><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"><a name="idm1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2>xmlcatalog — Command line tool to parse and manipulate <acronym class="acronym">XML</acronym> or <acronym class="acronym">SGML</acronym> catalog files. </div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><code class="command">xmlcatalog</code> [ <code class="option">--sgml</code> | <code class="option">--shell</code> | <code class="option">--create</code> | <code class="option">--del <code>VALUE(S)</code></code> | [ <code class="option">--add <code>TYPE</code> <code>ORIG</code> <code>REPLACE</code> </code> | <code class="option">--add <code>FILENAME</code></code> ] | <code class="option">--noout</code> | <code class="option">--no-super-update</code> | [ <code class="option">-v</code> | <code class="option">--verbose</code> ] ] {<code>CATALOGFILE</code>} {<code>ENTITIES</code>...}</div></div><div class="refsect1"><a name="description"></a><h2>DESCRIPTION</h2> xmlcatalog is a command line application allowing users to monitor and manipulate <acronym class="acronym">XML</acronym> and <acronym class="acronym">SGML</acronym> catalogs. It is included in libxml(3). Its functions can be invoked from a single command from the command line, or it can perform multiple functions in interactive mode. It can operate on both <acronym class="acronym">XML</acronym> and <acronym class="acronym">SGML</acronym> files. </div><div class="refsect1"><a name="options"></a><h2>OPTIONS</h2> xmlcatalog accepts the following options (in alphabetical order): <div class="variablelist"><dl class="variablelist"><dt> <code class="option">--add <code>TYPE</code> <code>ORIG</code> <code>REPLACE</code> </code> </dt><dd> Add an entry to <code class="filename">CATALOGFILE</code>. <code>TYPE</code> indicates the type of entry. Possible types are: <code>public</code>, <code>system</code>, <code>uri</code>, <code>rewriteSystem</code>, <code>rewriteURI</code>, <code>delegatePublic</code>, <code>delegateSystem</code>, <code>delegateURI</code>, <code>nextCatalog</code>. <code>ORIG</code> is the original reference to be replaced, and <code>REPLACE</code> is the <acronym class="acronym">URI</acronym> of the replacement entity to be used. The <code class="option">--add</code> option will not overwrite <code class="filename">CATALOGFILE</code>, outputting to <code class="filename">stdout</code>, unless <code class="option">--noout</code> is used. The <code class="option">--add</code> will always take three parameters even if some of the <acronym class="acronym">XML</acronym> catalog constructs will have only a single argument. </dd><dt><code class="option">--add <code>FILENAME</code></code></dt><dd> If the <code class="option">--add</code> option is used following the <code class="option">--sgml</code> option, only a single argument, a <code>FILENAME</code>, is used. This is used to add the name of a catalog file to an <acronym class="acronym">SGML</acronym> supercatalog, a file that contains references to other included <acronym class="acronym">SGML</acronym> catalog files. </dd><dt><code class="option">--create</code></dt><dd> Create a new <acronym class="acronym">XML</acronym> catalog. Outputs to <code class="filename">stdout</code>, ignoring <code>filename</code> unless <code class="option">--noout</code> is used, in which case it creates a new catalog file <code>filename</code>. </dd><dt><code class="option">--del <code>VALUE(S)</code></code></dt><dd> Remove entries from <code>CATALOGFILE</code> matching <code>VALUE(S)</code>. The <code class="option">--del</code> option will not overwrite <code>CATALOGFILE</code>, outputting to <code class="filename">stdout</code>, unless <code class="option">--noout</code> is used. </dd><dt><code class="option">--noout</code></dt><dd> Save output to the named file rather than outputting to <code class="filename">stdout</code>. </dd><dt><code class="option">--no-super-update</code></dt><dd> Do not update the <acronym class="acronym">SGML</acronym> super catalog. </dd><dt><code class="option">--shell</code></dt><dd> Run a shell allowing interactive queries on catalog file <code>CATALOGFILE</code>. For the set of available commands see <a class="xref" href="#shell" title="SHELL COMMANDS">the section called “SHELL COMMANDS”</a>. </dd><dt><code class="option">--sgml</code></dt><dd> Uses <acronym class="acronym">SGML</acronym> super catalogs for <code class="option">--add</code> and <code class="option">--del</code> options. </dd><dt><code class="option">-v</code>, <code class="option">--verbose</code></dt><dd>Output debugging information.</dd></dl></div> Invoking xmlcatalog non-interactively without a designated action (imposed with options like <code class="option">--add</code>) will result in a lookup of the catalog entry for <code>ENTITIES</code> in the catalog denoted with <code>CATALOGFILE</code>. The corresponding entries will be output to the command line. This mode of operation, together with <code class="option">--shell</code> mode and non-modifying (i.e. without <code class="option">--noout</code>) direct actions, allows for a special shortcut of the void <code>CATALOGFILE</code> specification (possibly expressed as "" in the shell environment) appointing the default system catalog. That simplifies the handling when its exact location is irrelevant but the respective built-in still needs to be consulted. </div><div class="refsect1"><a name="shell"></a><h2>SHELL COMMANDS</h2> Invoking xmlcatalog with the <code class="option">--shell <code>CATALOGFILE</code></code> option opens a command line shell allowing interactive access to the catalog file identified by <code>CATALOGFILE</code>. Invoking the shell provides a command line prompt after which the following commands (described in alphabetical order) can be entered. <div class="variablelist"><dl class="variablelist"><dt> <code class="option">add <code>TYPE</code> <code>ORIG</code> <code>REPLACE</code> </code> </dt><dd> Add an entry to the catalog file. <code>TYPE</code> indicates the type of entry. Possible types are: <code>public</code>, <code>system</code>, <code>uri</code>, <code>rewriteSystem</code>, <code>rewriteURI</code>, <code>delegatePublic</code>, <code>delegateSystem</code>, <code>delegateURI</code>, <code>nextCatalog</code>. <code>ORIG</code> is the original reference to be replaced, and <code>REPLACE</code> is the <acronym class="acronym">URI</acronym> of the replacement entity to be used. The <code class="option">--add</code> option will not overwrite <code class="filename">CATALOGFILE</code>, outputting to <code class="filename">stdout</code>, unless <code class="option">--noout</code> is used. The <code class="option">--add</code> will always take three parameters even if some of the <acronym class="acronym">XML</acronym> catalog constructs will have only a single argument. </dd><dt><code class="option">debug</code></dt><dd> Print debugging statements showing the steps xmlcatalog is executing. </dd><dt><code class="option">del <code>VALUE(S)</code></code></dt><dd> Remove the catalog entry corresponding to <code>VALUE(S)</code>. </dd><dt><code class="option">dump</code></dt><dd>Print the current catalog.</dd><dt><code class="option">exit</code></dt><dd>Quit the shell.</dd><dt><code class="option">public <code>PUBLIC-ID</code></code></dt><dd> Execute a Formal Public Identifier lookup of the catalog entry for <code>PUBLIC-ID</code>. The corresponding entry will be output to the command line. </dd><dt><code class="option">quiet</code></dt><dd>Stop printing debugging statements.</dd><dt><code class="option">system <code>SYSTEM-ID</code></code></dt><dd> Execute a Formal Public Identifier lookup of the catalog entry for <code>SYSTEM-ID</code>. The corresponding entry will be output to the command line. </dd></dl></div></div><div class="refsect1"><a name="environment"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl class="variablelist"><dt><code class="envar">XML_CATALOG_FILES</code></dt><dd><acronym class="acronym">XML</acronym> catalog behavior can be changed by redirecting queries to the user's own set of catalogs. This can be done by setting the <code class="envar">XML_CATALOG_FILES</code> environment variable to a space-separated list of catalogs. Use percent-encoding to escape spaces or other characters. An empty variable should deactivate loading the default <code class="filename">/etc/xml/catalog</code> catalog. </dd></dl></div></div><div class="refsect1"><a name="diagnostics"></a><h2>DIAGNOSTICS</h2> xmlcatalog return codes provide information that can be used when calling it from scripts. <div class="variablelist"><dl class="variablelist"><dt>0</dt><dd>No error</dd><dt>1</dt><dd>Failed to remove an entry from the catalog</dd><dt>2</dt><dd>Failed to save to the catalog, check file permissions</dd><dt>3</dt><dd>Failed to add an entry to the catalog</dd><dt>4</dt><dd>Failed to look up an entry in the catalog</dd></dl></div></div><div class="refsect1"><a name="seealso"></a><h2>SEE ALSO</h2>libxml(3) More information can be found at <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">libxml(3) web page <a class="ulink" href="https://gitlab.gnome.org/GNOME/libxml2" target="_top">https://gitlab.gnome.org/GNOME/libxml2</a> </li><li class="listitem">libxml(3) catalog support web page at <a class="ulink" href="https://gitlab.gnome.org/GNOME/libxml2/-/wikis/Catalog-support" target="_top">https://gitlab.gnome.org/GNOME/libxml2/-/wikis/Catalog-support</a> </li><li class="listitem">James Clark's <acronym class="acronym">SGML</acronym> catalog page <a class="ulink" href="http://www.jclark.com/sp/catalog.htm" target="_top">http://www.jclark.com/sp/catalog.htm</a> </li><li class="listitem"><acronym class="acronym">OASIS</acronym> <acronym class="acronym">XML</acronym> catalog specification <a class="ulink" href="http://www.oasis-open.org/committees/entity/spec.html" target="_top">http://www.oasis-open.org/committees/entity/spec.html</a> </li></ul></div> </div></div></body></html>