applied patch to man pages from Daniel Leidert and regenerated Daniel
* doc/xmlcatalog.1 doc/xmlcatalog_man.xml doc/xmllint.1 doc/xmllint.xml:
applied patch to man pages from Daniel Leidert and regenerated
Daniel
diff --git a/doc/xmllint.xml b/doc/xmllint.xml
index 904e706..9a41b4e 100644
--- a/doc/xmllint.xml
+++ b/doc/xmllint.xml
@@ -46,7 +46,7 @@
</author>
</authorgroup>
<!-- date should be the date of the latest change or the release version -->
- <date>2006-03-05</date>
+ <date>$Date$</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> -->
@@ -130,34 +130,18 @@
<refsect1 id="description">
<title>DESCRIPTION</title>
<para>
- The &xmllint; program parses one or more XML files, specified on the
- command line as <replaceable>XML-FILE</replaceable> (or the standard
- input if the filename provided is <emphasis role="bold">-</emphasis> ).
- It prints various types of output, depending upon the options selected.
- It is useful for detecting errors both
- in <acronym>XML</acronym> code and in the <acronym>XML</acronym> parser
- itself.
+ The &xmllint; program parses one or more <acronym>XML</acronym> files,
+ specified on the command line as <replaceable>XML-FILE</replaceable>
+ (or the standard input if the filename provided
+ is <emphasis role="bold">-</emphasis> ). It prints various types of
+ output, depending upon the options selected. It is useful for detecting
+ errors both in <acronym>XML</acronym> code and in
+ the <acronym>XML</acronym> parser itself.
</para>
<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>
<refsect1 id="options">
@@ -179,8 +163,9 @@
<term><option>--catalogs</option></term>
<listitem>
<para>
- Use the catalogs from <envar>SGML_CATALOG_FILES</envar>.
- Otherwise <filename>/etc/xml/catalog</filename> is used by default.
+ Use the <acronym>SGML</acronym> catalog(s) from <envar>SGML_CATALOG_FILES</envar>.
+ Otherwise <acronym>XML</acronym> catalogs starting
+ from <filename>/etc/xml/catalog</filename> are used by default.
</para>
</listitem>
</varlistentry>
@@ -201,7 +186,10 @@
<term><option>--compress</option></term>
<listitem>
<para>
- Turn on <application>gzip</application> compression of output.
+ Turn on <citerefentry>
+ <refentrytitle>gzip</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry> compression of output.
</para>
</listitem>
</varlistentry>
@@ -217,8 +205,8 @@
<term><option>--c14n</option></term>
<listitem>
<para>
- Use the W3C XML Canonicalisation (<acronym>C14N</acronym>) to serialize
- the result of parsing to <filename class="devicefile">stdout</filename>.
+ Use the W3C <acronym>XML</acronym> Canonicalisation (<acronym>C14N</acronym>) to
+ serialize the result of parsing to <filename class="devicefile">stdout</filename>.
It keeps comments in the result.
</para>
</listitem>
@@ -238,9 +226,9 @@
<term><option>--dtdvalidfpi <replaceable class="option">FPI</replaceable></option></term>
<listitem>
<para>
- Use the <acronym>DTD</acronym> specified by a Public
+ Use the <acronym>DTD</acronym> specified by a Formal Public
Identifier <replaceable>FPI</replaceable> for validation, note that this
- will require a Catalog exporting that Public Identifier to work.
+ will require a catalog exporting that Formal Public Identifier to work.
</para>
</listitem>
</varlistentry>
@@ -291,7 +279,7 @@
<listitem>
<para>
Reformat and reindent the output. The <envar>XMLLINT_INDENT</envar>
- environment variable controls the indentation (default value is two
+ environment variable controls the indentation. The default value is two
spaces " ").
</para>
</listitem>
@@ -333,7 +321,7 @@
<varlistentry>
<term><option>--loaddtd</option></term>
<listitem>
- <para>Fetch external <acronym>DTD</acronym>.</para>
+ <para>Fetch an external <acronym>DTD</acronym>.</para>
</listitem>
</varlistentry>
@@ -484,7 +472,7 @@
<varlistentry>
<term><option>--postvalid</option></term>
<listitem>
- <para>Validate after parsing is completed.</para>
+ <para>Validate after parsing has completed.</para>
</listitem>
</varlistentry>
@@ -523,8 +511,8 @@
<term><option>--schema <replaceable>SCHEMA</replaceable></option></term>
<listitem>
<para>
- Use a W3C XML Schema file named <replaceable>SCHEMA</replaceable>
- for validation.
+ Use a W3C <acronym>XML</acronym> Schema file
+ named <replaceable>SCHEMA</replaceable> for validation.
</para>
</listitem>
</varlistentry>
@@ -543,7 +531,7 @@
<term><option>--stream</option></term>
<listitem>
<para>
- Use streaming API - useful when used in combination
+ Use streaming <acronym>API</acronym> - useful when used in combination
with <option>--relaxng</option> or <option>--valid</option> options
for validation of files that are too large to be held in memory.
</para>
@@ -599,7 +587,7 @@
<para>
Test the walker module, which is a reader interface but for a
document tree, instead of using the reader <acronym>API</acronym> on
- an unparsed document it works on a existing in-memory tree. Used in
+ an unparsed document it works on an existing in-memory tree. Used for
debugging.
</para>
</listitem>
@@ -618,11 +606,10 @@
<para>
Used in conjunction with <option>--html</option>. Usually
when <acronym>HTML</acronym> is parsed the document is saved with
- the <acronym>HTML</acronym> serializer, but with this option the
+ the <acronym>HTML</acronym> serializer. But with this option the
resulting document is saved with the <acronym>XML</acronym>
serializer. This is primarily used to
- generate <acronym>XHTML</acronym>
- from <acronym>HTML</acronym> input.
+ generate <acronym>XHTML</acronym> from <acronym>HTML</acronym> input.
</para>
</listitem>
</varlistentry>
@@ -770,19 +757,23 @@
<varlistentry>
<term><envar>SGML_CATALOG_FILES</envar></term>
<listitem>
- <para>to be written ...</para>
+ <para><acronym>SGML</acronym> catalog behavior can be changed by redirecting
+ queries to the user's own set of catalogs. This can be done by setting
+ the <envar>SGML_CATALOG_FILES</envar> environment variable to a list
+ of catalogs. An empty one should deactivate loading the
+ default <filename>/etc/sgml/catalog</filename> catalog.
+ </para>
</listitem>
</varlistentry>
<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
+ <para><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 <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.
+ default <filename>/etc/xml/catalog</filename> catalog.
</para>
</listitem>
</varlistentry>
@@ -790,10 +781,9 @@
<varlistentry>
<term><envar>XML_DEBUG_CATALOG</envar></term>
<listitem>
- <para>
- Setting the environment variable <envar>XML_DEBUG_CATALOG</envar>
- using the <command>export</command> command outputs debugging information
- related to catalog operations.
+ <para>Setting the environment variable <envar>XML_DEBUG_CATALOG</envar>
+ to <parameter>non-zero</parameter> using the <command>export</command>
+ command outputs debugging information related to catalog operations.
</para>
</listitem>
</varlistentry>
@@ -801,7 +791,9 @@
<varlistentry>
<term><envar>XMLLINT_INDENT</envar></term>
<listitem>
- <para>to be written ...</para>
+ <para>Setting the environment variable <envar>XMLLINT_INDENT</envar>
+ controls the indentation. The default value is two spaces " ".
+ </para>
</listitem>
</varlistentry>
@@ -811,7 +803,8 @@
<refsect1 id="diagnostics">
<title>DIAGNOSTICS</title>
<para>
- On the completion of execution, &xmllint; returns the following error codes:
+ &xmllint; return codes provide information that can be used when
+ calling it from scripts.
</para>
<!-- better use segmentedlist element later,
which is currently only supported in snapshots -->
@@ -897,12 +890,27 @@
<refsect1 id="seealso">
<title>SEE ALSO</title>
- <para>
- <citerefentry>
+ <para><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>
</refentry>