[Date Prev][Date Next] [Thread Prev][Thread Next]
[Thread Index]
[Date Index]
[Author Index]
[xml] Manpage update (xmllint.1, xmlcatalog.1)
- From: Daniel Leidert <daniel leidert spam gmx net>
- To: ml_gnome-xml <xml gnome org>
- Subject: [xml] Manpage update (xmllint.1, xmlcatalog.1)
- Date: Thu, 06 Apr 2006 01:12:55 +0200
Hello,
As I already told Daniel Veillard via PM, I again have an update ready
for the xmllint and the xmlcatalog manpage.
The changes:
- refer to libxml/libxslt manpages when mentioning these libraries
- small fix so anchors fit title
- use the current XSL snapshots, because they fix a lot of bugs with the
manpage stylesheets and they support some more elements, so the manpages
are a bit more handy
- fixes a few markups issues I used as workaround for docbook-xsl <=
1.69.1 (which are solved in the snapshots)
The patches against the current CVS are attached. Critics or
suggestions?
Regards, Daniel
Index: doc/xmlcatalog_man.xml
===================================================================
RCS file: /cvs/gnome/libxml2/doc/xmlcatalog_man.xml,v
retrieving revision 1.11
diff -u -r1.11 xmlcatalog_man.xml
--- doc/xmlcatalog_man.xml 24 Jun 2004 02:21:27 -0000 1.11
+++ doc/xmlcatalog_man.xml 5 Apr 2006 22:56:28 -0000
@@ -1,299 +1,434 @@
<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl"
- href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl";?>
+ href="http://docbook.sourceforge.net/snapshots/xsl/manpages/docbook.xsl";?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
+
+ <!ENTITY xmlcatalog "<command>xmlcatalog</command>">
]>
+
<refentry>
- <refentryinfo>
- <title>xmlcatalog Manual</title>
- <copyright>
- <year>2001</year>
- </copyright>
- <copyright>
- <year>2004</year>
- </copyright>
- <author>
- <firstname>John</firstname>
- <surname>Fleck</surname>
- </author>
- <address><email>jfleck inkstain net</email></address>
-
- <releaseinfo>This is release 0.3 of the xmlcatalog Manual.</releaseinfo>
- </refentryinfo>
-
- <refmeta>
- <refentrytitle>xmlcatalog</refentrytitle>
- <manvolnum>1</manvolnum>
- </refmeta>
- <refnamediv>
- <refname>xmlcatalog</refname>
- <refpurpose>Command line tool to parse and manipulate <acronym>XML</acronym> or
- <acronym>SGML</acronym> catalog files.</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>xmlcatalog</command>
- <group>
- <arg>--shell</arg>
- <arg>--create</arg>
- <arg>--add <replaceable>type</replaceable>
- <replaceable>orig</replaceable> <replaceable>replace</replaceable></arg>
- <arg>--del <replaceable>values</replaceable></arg>
- <arg>--noout</arg>
- <arg>--verbose</arg>
- </group>
- <arg><option><replaceable>catalogfile</replaceable></option></arg>
- <arg><option><replaceable>entities</replaceable></option></arg>
- </cmdsynopsis>
- </refsynopsisdiv>
-
- <refsect1 id="introduction">
- <title>Introduction</title>
- <para>
- <application>xmlcatalog</application> is a command line application
- allowing users to monitor and manipulate <acronym>XML</acronym> and
- <acronym>SGML</acronym> catalogs. It is included in
- <application>libxml2</application>.
- </para>
-
- <para>
- 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>XML</acronym> and <acronym>SGML</acronym> files.
- </para>
- </refsect1>
-
- <refsect1 id="cloptions">
- <title>Command Line Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--shell</option> <replaceable>filename</replaceable></term>
- <listitem>
- <simpara>
- Run a shell
- allowing interactive queries on catalog file
- <replaceable>filename</replaceable>.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--create</option> <replaceable>filename</replaceable></term>
- <listitem>
- <simpara>
- Create a new
- <acronym>XML</acronym> catalog. Outputs to stdout, ignoring
- <replaceable>filename</replaceable> unless <option>--noout</option> is
- used, in which case it creates a new catalog file
- <replaceable>filename</replaceable>.
- </simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--add</option> <replaceable>'type'</replaceable> <replaceable>'orig'</replaceable> <replaceable>'replace'</replaceable> <replaceable>filename</replaceable></term>
- <listitem>
- <simpara>
- Add an entry to catalog file
- <filename>filename</filename>. <replaceable>type</replaceable>
- indicates the type of entry. Possible types are 'public', 'system',
- 'rewriteSystem', 'rewriteURI', 'delegatePublic', 'delegateSystem',
- and 'nextCatalog'. <replaceable>'orig'</replaceable> is the original
- reference to be replaced, and <replaceable>'replace'</replaceable>
- is the <acronym>URI</acronym> of the replacement entity to be
- used. The <option>--add</option> option will not overwrite
- <replaceable>filename</replaceable>, outputting to stdout, unless
- <option>--noout</option> is used. The <option>--add</option> will
- always take three parameters even if some of the
- <acronym>XML</acronym> catalog constructs will have only a single
- argument.
-<!--
-FIXME - Is my list of possible types correct? Are SGML types the same?
--->
- </simpara>
- <simpara>
- If the <option>--add</option> option is used following the
- <option>--sgml</option> option, only a single argument, a
- <replaceable>filename</replaceable>, is used. This is used to add
- the name of a catalog file to an <acronym>SGML</acronym>
- supercatalog, a file that contains references to other included
- <acronym>SGML</acronym> catalog files.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--del</option> <replaceable>'values'</replaceable> <replaceable>filename</replaceable></term>
- <listitem>
- <simpara>
- Remove entries from the catalog file
- <replaceable>filename</replaceable> matching
- <replaceable>'values'</replaceable>. The <option>--del</option> option
- will not overwrite <replaceable>filename</replaceable>, outputting to
- stdout, unless <option>--noout</option> is used.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
+
+<refentryinfo>
+ <title>xmlcatalog Manual</title>
+ <productname>libxml2</productname>
+ <copyright>
+ <year>2001</year>
+ <year>2004</year>
+ </copyright>
+ <author>
+ <firstname>John</firstname>
+ <surname>Fleck</surname>
+ <affiliation>
+ <address>
+ <email>jfleck inkstain net</email>
+ </address>
+ </affiliation>
+ </author>
+ <!-- date should be the date of the latest change or the release version -->
+ <date>2006-03-05</date>
+ <!-- still a bit buggy output, will talk to docbook-xsl upstream to fix this -->
+ <!-- <releaseinfo>This is release 0.3 of the xmlcatalog Manual.</releaseinfo> -->
+ <!-- <edition>0.3</edition> -->
+</refentryinfo>
+
+<refmeta>
+ <refentrytitle>xmlcatalog</refentrytitle>
+ <manvolnum>1</manvolnum>
+</refmeta>
+
+<refnamediv>
+ <refname>xmlcatalog</refname>
+ <refpurpose>
+ Command line tool to parse and manipulate <acronym>XML</acronym>
+ or <acronym>SGML</acronym> catalog files.
+ </refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+ <cmdsynopsis>
+ <command>xmlcatalog</command>
+ <group choice="opt">
+ <arg choice="plain"><option>--sgml</option></arg>
+ <arg choice="plain"><option>--shell</option></arg>
+ <arg choice="plain"><option>--create</option></arg>
+ <arg choice="plain"><option>--del <replaceable>VALUE(S)</replaceable></option></arg>
+ <arg choice="plain">
+ <group choice="opt">
+ <arg choice="plain">
+ <option>--add
+ <replaceable>TYPE</replaceable>
+ <replaceable>ORIG</replaceable>
+ <replaceable>REPLACE</replaceable>
+ </option>
+ </arg>
+ <arg choice="plain"><option>--add <replaceable>FILENAME</replaceable></option></arg>
+ </group>
+ </arg>
+ <arg choice="plain"><option>--noout</option></arg>
+ <arg choice="plain"><option>--no-super-update</option></arg>
+ <arg choice="plain">
+ <group choice="opt">
+ <arg choice="plain"><option>-v</option></arg>
+ <arg choice="plain"><option>--verbose</option></arg>
+ </group>
+ </arg>
+ </group>
+ <arg choice="req" rep="norepeat"><replaceable>CATALOGFILE</replaceable></arg>
+ <arg choice="req" rep="repeat"><replaceable>ENTITIES</replaceable></arg>
+ </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1 id="description">
+ <title>DESCRIPTION</title>
+ <para>
+ &xmlcatalog; is a command line application allowing users to monitor and
+ manipulate <acronym>XML</acronym> and <acronym>SGML</acronym> catalogs. It
+ is included in <citerefentry>
+ <refentrytitle>libxml</refentrytitle>
+ <manvolnum>3</manvolnum>
+ </citerefentry>.
+ </para>
+ <para>
+ 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>XML</acronym> and <acronym>SGML</acronym> files.
+ </para>
+ <para>More information can be found at
+ <itemizedlist>
+ <listitem>
+ <para><citerefentry>
+ <refentrytitle>libxml</refentrytitle>
+ <manvolnum>3</manvolnum>
+ </citerefentry> web page <ulink url="http://www.xmlsoft.org/"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para><citerefentry>
+ <refentrytitle>libxml</refentrytitle>
+ <manvolnum>3</manvolnum>
+ </citerefentry> catalog support web page
+ at <ulink url="http://www.xmlsoft.org/catalog.html"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>James Clark's <acronym>SGML</acronym> catalog
+ page <ulink url="http://www.jclark.com/sp/catalog.htm"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para><acronym>OASIS</acronym> <acronym>XML</acronym> catalog specification
+ <ulink url="http://www.oasis-open.org/committees/entity/spec.html"/>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+</refsect1>
+
+<refsect1 id="options">
+ <title>OPTIONS</title>
+ <para>
+ &xmlcatalog; accepts the following options (in alphabetical order):
+ </para>
+
+ <variablelist>
+
+ <varlistentry>
+ <term>
+ <option>--add
+ <replaceable>TYPE</replaceable>
+ <replaceable>ORIG</replaceable>
+ <replaceable>REPLACE</replaceable>
+ </option>
+ </term>
+ <listitem>
+ <para>
+ Add an entry to <filename>CATALOGFILE</filename>. <replaceable>TYPE</replaceable>
+ indicates the type of entry. Possible types are: <simplelist type="inline">
+ <member><parameter>public</parameter></member>
+ <member><parameter>system</parameter></member>
+ <member><parameter>rewriteSystem</parameter></member>
+ <member><parameter>rewriteURI</parameter></member>
+ <member><parameter>delegatePublic</parameter></member>
+ <member><parameter>delegateSystem</parameter></member>
+ <member><parameter>nextCatalog</parameter></member>
+ </simplelist>. <replaceable>ORIG</replaceable> is the original
+ reference to be replaced, and <replaceable>REPLACE</replaceable>
+ is the <acronym>URI</acronym> of the replacement entity to be
+ used. The <option>--add</option> option will not overwrite
+ <filename>CATALOGFILE</filename>, outputting
+ to <filename class="devicefile">stdout</filename>, unless
+ <option>--noout</option> is used. The <option>--add</option> will
+ always take three parameters even if some of the <acronym>XML</acronym>
+ catalog constructs will have only a single argument.
+ </para>
+ <!--
+ FIXME - Is my list of possible types correct? Are SGML types the same?
+ -->
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--add <replaceable>FILENAME</replaceable></option></term>
+ <listitem>
+ <para>
+ If the <option>--add</option> option is used following
+ the <option>--sgml</option> option, only a single argument,
+ a <replaceable>FILENAME</replaceable>, is used. This is used to add
+ the name of a catalog file to an <acronym>SGML</acronym> supercatalog,
+ a file that contains references to other included <acronym>SGML</acronym>
+ catalog files.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--create</option></term>
+ <listitem>
+ <para>
+ Create a new <acronym>XML</acronym> catalog. Outputs
+ to <filename class="devicefile">stdout</filename>,
+ ignoring <replaceable>filename</replaceable> unless <option>--noout</option> is
+ used, in which case it creates a new catalog
+ file <replaceable>filename</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--del <replaceable>VALUE(S)</replaceable></option></term>
+ <listitem>
+ <para>
+ Remove entries from <replaceable>CATALOGFILE</replaceable>
+ matching <replaceable>VALUE(S)</replaceable>. The <option>--del</option>
+ option will not overwrite <replaceable>CATALOGFILE</replaceable>,
+ outputting to <filename class="devicefile">stdout</filename>,
+ unless <option>--noout</option> is used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>--noout</option></term>
<listitem>
- <simpara>
- Save output to the named file rather than
- outputting to stdout.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
+ <para>
+ Save output to the named file rather than outputting
+ to <filename class="devicefile">stdout</filename>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--no-super-update</option></term>
+ <listitem>
+ <para>
+ Do not update the <acronym>SGML</acronym> super catalog.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--shell</option></term>
+ <listitem>
+ <para>
+ Run a shell allowing interactive queries on catalog
+ file <replaceable>CATALOGFILE</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>--sgml</option></term>
<listitem>
- <simpara>
- Uses SGML Super catalogs for --add and --del options
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v</option> or <option>--verbose</option></term>
- <listitem>
- <simpara>
- output debugging
- information.
- </simpara>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
-
- <refsect1 id="shell">
- <title>Shell Commands</title>
- <para>Invoking <application>xmlcatalog</application> with the
- <option>--shell</option> <replaceable>filename</replaceable> option opens
- a command line shell allowing interactive access to the catalog file
- identified by <replaceable>filename</replaceable>. Invoking the shell
- provides a command line prompt after which commands can be entered.
- </para>
-
- <variablelist>
- <varlistentry>
- <term><option>public</option> <replaceable>'PublicID'</replaceable></term>
- <listitem>
- <simpara>
- Execute a
- public identifier lookup of the catalog entry for
- <replaceable>'PublicID'</replaceable>. The corresponding entry will be
- output to the command line.
- </simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>system</option> <replaceable>'SystemID'</replaceable></term>
- <listitem>
- <simpara>
- Execute a
- public identifier lookup of the catalog entry for
- <replaceable>'SystemID'</replaceable>. The corresponding entry will be
- output to the command line.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>add </option> <replaceable>'type'</replaceable> <replaceable>'orig'</replaceable> <replaceable>'replace'</replaceable></term>
- <listitem>
- <simpara>
- Add an entry to the catalog
- file. <replaceable>type</replaceable> indicates the type of
- entry. Possible types are 'public', 'system', 'rewriteSystem',
- 'rewriteURI', 'delegatePublic', 'delegateSystem', and
- 'nextCatalog'. <replaceable>'orig'</replaceable>
- is the original reference to be replaced, and
- <replaceable>'replace'</replaceable> is the <acronym>URI</acronym> of the
- replacement entity to be used.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>del</option> <replaceable>'values'</replaceable></term>
- <listitem>
- <simpara>
- Remove the
- catalog entry corresponding to <replaceable>'values'</replaceable>.
- </simpara>
+ <para>
+ Uses <acronym>SGML</acronym> super catalogs for <option>--add</option>
+ and <option>--del</option> options.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-v</option></term>
+ <term><option>--verbose</option></term>
+ <listitem>
+ <para>Output debugging information.</para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+</refsect1>
+
+<refsect1 id="shell">
+ <title>SHELL COMMANDS</title>
+ <para>
+ Invoking &xmlcatalog; with
+ the <option>--shell <replaceable>CATALOGFILE</replaceable></option> option opens
+ a command line shell allowing interactive access to the catalog file
+ identified by <replaceable>CATALOGFILE</replaceable>. Invoking the shell
+ provides a command line prompt after which the following commands (described in
+ alphabetical order) can be entered.
+ </para>
+
+ <variablelist>
+
+ <varlistentry>
+ <term>
+ <option>add
+ <replaceable>TYPE</replaceable>
+ <replaceable>ORIG</replaceable>
+ <replaceable>REPLACE</replaceable>
+ </option>
+ </term>
+ <listitem>
+ <para>
+ Add an entry to the catalog file. <replaceable>TYPE</replaceable>
+ indicates the type of entry. Possible types are: <simplelist type="inline">
+ <member><parameter>public</parameter></member>
+ <member><parameter>system</parameter></member>
+ <member><parameter>rewriteSystem</parameter></member>
+ <member><parameter>rewriteURI</parameter></member>
+ <member><parameter>delegatePublic</parameter></member>
+ <member><parameter>delegateSystem</parameter></member>
+ <member><parameter>nextCatalog</parameter></member>
+ </simplelist>. <replaceable>ORIG</replaceable> is the original
+ reference to be replaced, and <replaceable>REPLACE</replaceable>
+ is the <acronym>URI</acronym> of the replacement entity to be
+ used. The <option>--add</option> option will not overwrite
+ <filename>CATALOGFILE</filename>, outputting
+ to <filename class="devicefile">stdout</filename>, unless
+ <option>--noout</option> is used. The <option>--add</option> will
+ always take three parameters even if some of the <acronym>XML</acronym>
+ catalog constructs will have only a single argument.
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry>
- <term><option>dump</option></term>
+ <varlistentry>
+ <term><option>debug</option></term>
<listitem>
- <simpara>
- Print the current catalog.
- </simpara>
+ <para>
+ Print debugging statements showing the steps &xmlcatalog; is executing.
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry>
- <term><option>debug</option></term>
+ <varlistentry>
+ <term><option>del <replaceable>VALUE(S)</replaceable></option></term>
<listitem>
- <simpara>
- Print debugging statements showing the steps
- <application>xmlcatalog</application> is executing.
- </simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>quiet</option></term>
+ <para>
+ Remove the catalog entry corresponding to <replaceable>VALUE(S)</replaceable>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>dump</option></term>
<listitem>
- <simpara>
- Stop printing debugging statements.
- </simpara>
- </listitem>
- </varlistentry>
-
- <varlistentry>
+ <para>Print the current catalog.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>exit</option></term>
<listitem>
- <simpara>
- Quit the shell.
- </simpara>
- </listitem>
- </varlistentry>
- </variablelist>
-
- </refsect1>
-
- <refsect1 id="return">
- <title>Return values</title>
- <para><application>xmlcatalog</application>'s return codes provide
- information that can be used when calling it from scripts.</para>
-
- <para>0: normal</para>
- <para>1: Failed to remove an entry from the catalog</para>
- <para>2: Failed to save to the catalog, check file permissions</para>
- <para>3: Failed to add an entry to the catalog</para>
- <para>4: Failed to lookup and entry in the catalog</para>
- </refsect1>
- <refsect1>
- <title>Catalogs</title>
- <para>Catalog behavior can be changed by redirecting
- queries to the user's own set of catalogs. This can be done by setting the
- <varname>XML_CATALOG_FILES</varname> environment variable to a list of
- catalogs. An empty one should deactivate loading the default
- <filename>/etc/xml/catalog</filename> default catalog.</para>
- </refsect1>
- <refsect1>
- <title>References</title>
- <para><ulink url="http://www.xmlsoft.org/";>libxml web page</ulink></para>
-
- <para><ulink url="http://www.xmlsoft.org/catalog.html";><application>libxml</application>
- catalog support web page</ulink></para>
-
- <para><ulink url="http://www.jclark.com/sp/catalog.htm";>James Clark's
- <acronym>SGML</acronym> catalog page</ulink></para>
-
- <para><ulink
- url="http://www.oasis-open.org/committees/entity/spec.html";><acronym>OASIS</acronym>
- <acronym>XML</acronym> catalog specification</ulink></para>
+ <para>Quit the shell.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>public <replaceable>PUBLIC-ID</replaceable></option></term>
+ <listitem>
+ <para>
+ Execute a public identifier lookup of the catalog entry
+ for <replaceable>PUBLIC-ID</replaceable>. The corresponding entry will be
+ output to the command line.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>quiet</option></term>
+ <listitem>
+ <para>Stop printing debugging statements.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>system <replaceable>SYSTEM-ID</replaceable></option></term>
+ <listitem>
+ <para>
+ Execute a public identifier lookup of the catalog entry
+ for <replaceable>SYSTEM-ID</replaceable>. The corresponding entry will be
+ output to the command line.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+</refsect1>
+
+<refsect1 id="environment">
+ <title>ENVIRONMENT</title>
+ <variablelist>
+
+ <varlistentry>
+ <term><envar>XML_CATALOG_FILES</envar></term>
+ <listitem>
+ <para>
+ Catalog behavior can be changed by redirecting queries to the user's
+ own set of catalogs. This can be done by setting
+ the <envar>XML_CATALOG_FILES</envar> environment variable to a list
+ of catalogs. An empty one should deactivate loading the
+ default <filename>/etc/xml/catalog</filename> default catalog.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+</refsect1>
+
+<refsect1 id="diagnostics">
+ <title>DIAGNOSTICS</title>
+ <para>
+ &xmlcatalog;'s return codes provide information that can be used when
+ calling it from scripts.
+ </para>
+ <segmentedlist>
+ <!-- <title>Error codes</title> -->
+ <?dbhtml list-presentation="table"?>
+ <segtitle>Errorcode</segtitle>
+ <segtitle>Error</segtitle>
+ <seglistitem>
+ <seg><errorcode>0</errorcode></seg>
+ <seg>No error</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><errorcode>1</errorcode></seg>
+ <seg>Failed to remove an entry from the catalog</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><errorcode>2</errorcode></seg>
+ <seg>Failed to save to the catalog, check file permissions</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><errorcode>3</errorcode></seg>
+ <seg>Failed to add an entry to the catalog</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><errorcode>4</errorcode></seg>
+ <seg>Failed to lookup and entry in the catalog</seg>
+ </seglistitem>
+ </segmentedlist>
</refsect1>
+<refsect1 id="seealso">
+ <title>SEE ALSO</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>libxml</refentrytitle>
+ <manvolnum>3</manvolnum>
+ </citerefentry>
+ </para>
+</refsect1>
</refentry>
Index: doc/xmllint.xml
===================================================================
RCS file: /cvs/gnome/libxml2/doc/xmllint.xml,v
retrieving revision 1.31
diff -u -r1.31 xmllint.xml
--- doc/xmllint.xml 21 Feb 2006 19:24:04 -0000 1.31
+++ doc/xmllint.xml 5 Apr 2006 22:56:24 -0000
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl"
- href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl";?>
+ href="http://docbook.sourceforge.net/snapshots/xsl/manpages/docbook.xsl";?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
@@ -45,9 +45,11 @@
</affiliation>
</author>
</authorgroup>
- <releaseinfo>This is release 0.5 of the xmllint Manual.</releaseinfo>
<!-- date should be the date of the latest change or the release version -->
- <date>2006-02-20</date>
+ <date>2006-03-05</date>
+ <!-- still a bit buggy output, will talk to docbook-xsl upstream to fix this -->
+ <!-- <releaseinfo>This is release 0.5 of the xmllint Manual.</releaseinfo> -->
+ <!-- <edition>0.5</edition> -->
</refentryinfo>
<refmeta>
@@ -73,7 +75,7 @@
<arg choice="plain"><option>--noent</option></arg>
<arg choice="plain"><option>--noout</option></arg>
<arg choice="plain"><option>--nonet</option></arg>
- <arg choice="plain"><option>--path <replaceable class="option">"PATHS"</replaceable></option></arg>
+ <arg choice="plain"><option>--path "<replaceable class="option">PATH(S)</replaceable>"</option></arg>
<arg choice="plain"><option>--load-trace</option></arg>
<arg choice="plain"><option>--htmlout</option></arg>
<arg choice="plain"><option>--nowrap</option></arg>
@@ -125,7 +127,7 @@
</cmdsynopsis>
</refsynopsisdiv>
-<refsect1 id="introduction">
+<refsect1 id="description">
<title>DESCRIPTION</title>
<para>
The &xmllint; program parses one or more XML files, specified on the
@@ -136,11 +138,25 @@
in <acronym>XML</acronym> code and in the <acronym>XML</acronym> parser
itself.
</para>
- <para>&xmllint; is included in <application>libxml2</application>.</para>
- <para>
- More information can be found at the <application>libxml</application> web pages
- at <ulink url="http://www.xmlsoft.org/"/> and the W3C <acronym>XSLT</acronym>
- pages at <ulink url="http://www.w3.org/TR/xslt"/>.
+ <para>&xmllint; is included in <citerefentry>
+ <refentrytitle>libxml</refentrytitle>
+ <manvolnum>3</manvolnum>
+ </citerefentry>.</para>
+ <para>More information can be found at
+ <itemizedlist>
+ <listitem>
+ <para><citerefentry>
+ <refentrytitle>libxml</refentrytitle>
+ <manvolnum>3</manvolnum>
+ </citerefentry> web page <ulink url="http://www.xmlsoft.org/"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ W3C <acronym>XSLT</acronym> page <ulink url="http://www.w3.org/TR/xslt"/>
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
</refsect1>
@@ -173,8 +189,10 @@
<term><option>--chkregister</option></term>
<listitem>
<para>
- Turn on node registration. Useful for developers
- testing <application>libxml2</application> node tracking code.
+ Turn on node registration. Useful for developers testing <citerefentry>
+ <refentrytitle>libxml</refentrytitle>
+ <manvolnum>3</manvolnum>
+ </citerefentry> node tracking code.
</para>
</listitem>
</varlistentry>
@@ -441,7 +459,7 @@
</varlistentry>
<varlistentry>
- <term><option>--path <replaceable class="option">"PATHS"</replaceable></option></term>
+ <term><option>--path "<replaceable class="option">PATH(S)</replaceable>"</option></term>
<listitem>
<para>
Use the (space- or colon-separated) list of filesystem paths specified
@@ -516,7 +534,7 @@
<listitem>
<para>
Run a navigating shell. Details on available commands in shell mode
- are below (see section <emphasis role="bold">SHELL COMMANDS</emphasis>).
+ are below (see <xref linkend="shell"/>).
</para>
</listitem>
</varlistentry>
@@ -567,7 +585,10 @@
<term><option>--version</option></term>
<listitem>
<para>
- Display the version of <application>libxml2</application> used.
+ Display the version of <citerefentry>
+ <refentrytitle>libxml</refentrytitle>
+ <manvolnum>3</manvolnum>
+ </citerefentry> used.
</para>
</listitem>
</varlistentry>
@@ -742,14 +763,14 @@
</variablelist>
</refsect1>
-<refsect1>
+<refsect1 id="environment">
<title>ENVIRONMENT</title>
<variablelist>
<varlistentry>
<term><envar>SGML_CATALOG_FILES</envar></term>
<listitem>
- <para>...</para>
+ <para>to be written ...</para>
</listitem>
</varlistentry>
@@ -780,96 +801,74 @@
<varlistentry>
<term><envar>XMLLINT_INDENT</envar></term>
<listitem>
- <para>...</para>
+ <para>to be written ...</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
-<refsect1>
+<refsect1 id="diagnostics">
<title>DIAGNOSTICS</title>
<para>
On the completion of execution, &xmllint; returns the following error codes:
</para>
- <variablelist>
-
- <varlistentry>
- <term><errorcode>0</errorcode></term>
- <listitem>
- <para>No error</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><errorcode>1</errorcode></term>
- <listitem>
- <para>Unclassified</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><errorcode>2</errorcode></term>
- <listitem>
- <para>Error in <acronym>DTD</acronym></para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><errorcode>3</errorcode></term>
- <listitem>
- <para>Validation error</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><errorcode>4</errorcode></term>
- <listitem>
- <para>Validation error</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><errorcode>5</errorcode></term>
- <listitem>
- <para>Error in schema compilation</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><errorcode>6</errorcode></term>
- <listitem>
- <para>Error writing output</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><errorcode>7</errorcode></term>
- <listitem>
- <para>
- Error in pattern (generated when <option>--pattern</option> option is used)
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><errorcode>8</errorcode></term>
- <listitem>
- <para>
- Error in Reader registration (generated
- when <option>--chkregister</option> option is used)
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><errorcode>9</errorcode></term>
- <listitem>
- <para>Out of memory error</para>
- </listitem>
- </varlistentry>
+ <segmentedlist>
+ <!-- <title>Error codes</title> -->
+ <?dbhtml list-presentation="table"?>
+ <segtitle>Errorcode</segtitle>
+ <segtitle>Error</segtitle>
+ <seglistitem>
+ <seg><errorcode>0</errorcode></seg>
+ <seg>No error</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><errorcode>1</errorcode></seg>
+ <seg>Unclassified</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><errorcode>2</errorcode></seg>
+ <seg>Error in DTD</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><errorcode>3</errorcode></seg>
+ <seg>Validation error</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><errorcode>4</errorcode></seg>
+ <seg>Validation error</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><errorcode>5</errorcode></seg>
+ <seg>Error in schema compilation</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><errorcode>6</errorcode></seg>
+ <seg>Error writing output</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><errorcode>7</errorcode></seg>
+ <seg>Error in pattern (generated when <option>--pattern</option> option is used)</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><errorcode>8</errorcode></seg>
+ <seg>Error in reader registration (generated when <option>--chkregister</option> option is used)</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><errorcode>9</errorcode></seg>
+ <seg>Out of memory</seg>
+ </seglistitem>
+ </segmentedlist>
+</refsect1>
- </variablelist>
+<refsect1 id="seealso">
+ <title>SEE ALSO</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>libxml</refentrytitle>
+ <manvolnum>3</manvolnum>
+ </citerefentry>
+ </para>
</refsect1>
</refentry>
[Date Prev][Date Next] [Thread Prev][Thread Next]
[Thread Index]
[Date Index]
[Author Index]