John Fleck <jfleck@inkstain.net> doc/xmllint.xml, xmllint.html, xmllint.1
John Fleck <jfleck@inkstain.net>
* doc/xmllint.xml, xmllint.html, xmllint.1
add pattern, walker, maxmem, output and xmlout to man page
fixes #144675
diff --git a/ChangeLog b/ChangeLog
index 8f18435..324b013 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+Sat Aug 14 18:45:38 MDT 2004 John Fleck <jfleck@inkstain.net>
+
+ * doc/xmllint.xml, xmllint.html, xmllint.1
+ add pattern, walker, maxmem, output and xmlout to man page
+ fixes #144675
+
Sun Aug 15 00:41:12 CEST 2004 Daniel Veillard <daniel@veillard.com>
* xmllint.c: added a --c14n option to canonicalize the output
diff --git a/doc/xmllint.1 b/doc/xmllint.1
index 852d7b7..bfcb1c2 100644
--- a/doc/xmllint.1
+++ b/doc/xmllint.1
@@ -24,7 +24,7 @@
.ad l
.hy 0
.HP 8
-\fBxmllint\fR [\fB\-\-version\fR | \fB\-\-debug\fR | \fB\-\-shell\fR | \fB\-\-debugent\fR | \fB\-\-copy\fR | \fB\-\-recover\fR | \fB\-\-noent\fR | \fB\-\-nocdata\fR | \fB\-\-nsclean\fR | \fB\-\-noout\fR | \fB\-\-htmlout\fR | \fB\-\-nowrap\fR | \fB\-\-valid\fR | \fB\-\-postvalid\fR | \fB\-\-dtdvalid\ \fIURL\fR\fR | \fB\-\-dtdvalidfpi\ \fIFPI\fR\fR | \fB\-\-timing\fR | \fB\-\-repeat\fR | \fB\-\-insert\fR | \fB\-\-compress\fR | \fB\-\-html\fR | \fB\-\-push\fR | \fB\-\-memory\fR | \fB\-\-nowarning\fR | \fB\-\-noblanks\fR | \fB\-\-format\fR | \fB\-\-testIO\fR | \fB\-\-encode\ \fIencoding\fR\fR | \fB\-\-catalogs\fR | \fB\-\-nocatalogs\fR | \fB\-\-auto\fR | \fB\-\-xinclude\fR | \fB\-\-loaddtd\fR | \fB\-\-dtdattr\fR | \fB\-\-dropdtd\fR | \fB\-\-stream\fR | \fB\-\-chkregister\fR | \fB\-\-relaxng\fR | \fB\-\-schema\fR | \fB\-\-nonet\fR] [\fB\fIxmlfile\fR\fR]
+\fBxmllint\fR [\fB\-\-version\fR | \fB\-\-debug\fR | \fB\-\-shell\fR | \fB\-\-debugent\fR | \fB\-\-copy\fR | \fB\-\-recover\fR | \fB\-\-noent\fR | \fB\-\-noout\fR | \fB\-\-nonet\fR | \fB\-\-htmlout\fR | \fB\-\-nowrap\fR | \fB\-\-valid\fR | \fB\-\-postvalid\fR | \fB\-\-dtdvalid\ \fIURL\fR\fR | \fB\-\-dtdvalidfpi\ \fIFPI\fR\fR | \fB\-\-timing\fR | \fB\-\-output\ \fIfile\fR\fR | \fB\-\-repeat\fR | \fB\-\-insert\fR | \fB\-\-compress\fR | \fB\-\-html\fR | \fB\-\-xmlout\fR | \fB\-\-push\fR | \fB\-\-memory\fR | \fB\-\-maxmem\ \fInbbytes\fR\fR | \fB\-\-nowarning\fR | \fB\-\-noblanks\fR | \fB\-\-nocdata\fR | \fB\-\-format\fR | \fB\-\-encode\ \fIencoding\fR\fR | \fB\-\-dropdtd\fR | \fB\-\-nsclean\fR | \fB\-\-testIO\fR | \fB\-\-catalogs\fR | \fB\-\-nocatalogs\fR | \fB\-\-auto\fR | \fB\-\-xinclude\fR | \fB\-\-loaddtd\fR | \fB\-\-dtdattr\fR | \fB\-\-stream\fR | \fB\-\-walker\fR | \fB\-\-pattern\ \fIpatternvalue\fR\fR | \fB\-\-chkregister\fR | \fB\-\-relaxng\fR | \fB\-\-schema\fR] [\fB\fIxmlfile\fR\fR]
.ad
.hy
@@ -107,6 +107,10 @@
Output information about the time it takes xmllint to perform the various steps\&.
.TP
+\fB\-\-output\fR \fIfile\fR
+Define a file path where xmllint will save the result of parsing\&. Usually the programs build a tree and save it on stdout, with this option the result XML instance will be saved onto a file\&.
+
+.TP
\fB\-\-repeat\fR
Repeat 100 times, for timing or profiling\&.
@@ -123,6 +127,10 @@
Use the HTML parser\&.
.TP
+\fB\-\-xmlout\fR
+Used in conjusntion with \fB\-\-html\fR\&. Usually when HTML is parsed the document is saved with the HTML serializer, but with this option the resulting document is saved with the XML serializer\&. This is primarily used to generate XHTML from HTML input\&.
+
+.TP
\fB\-\-push\fR
Use the push mode of the parser\&.
@@ -131,6 +139,10 @@
Parse from memory\&.
.TP
+\fB\-\-maxmem\fR \fInnbytes\fR
+Test the parser memory support\&. \fInnbytes\fR is the maximum number of bytes the library is allowed to allocate\&. This can also be used to make sure batch processing of XML files will not exhaust the virtual memory of the server running them\&.
+
+.TP
\fB\-\-nowarning\fR
Do not emit warnings from the parser and/or validator\&.
@@ -183,10 +195,18 @@
Use streaming API \- useful when used in combination with \-\-relaxng or \-\-valid options for validation of files that are too large to be held in memory\&.
.TP
+\fB\-\-walker\fR
+Test the walker module, which is a reader interface but for a document tree, instead of using the reader API on an unparsed document it works on a existing in\-memory tree\&. Used in debugging\&.
+
+.TP
\fB\-\-chkregister\fR
Turn on node registration\&. Useful for developers testing libxml2 node tracking code\&.
.TP
+\fB\-\-pattern\fR \fIpatternvalue\fR
+Used to exercise the pattern recognition engine, which can be used with the reader interface to the parser\&. It allows to select some nodes in the document based on an XPath (subset) expression\&. Used for debugging\&.
+
+.TP
\fB\-\-relaxng\fR \fIschema\fR
Use RelaxNG file named \fIschema\fR for validation\&.
diff --git a/doc/xmllint.html b/doc/xmllint.html
index d486df3..9fdb1c1 100644
--- a/doc/xmllint.html
+++ b/doc/xmllint.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xmllint</title><meta name="generator" content="DocBook XSL Stylesheets V1.61.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="id2719562"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>xmllint — command line <span class="acronym">XML</span> tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">xmllint</tt> [[--version] | [--debug] | [--shell] | [--debugent] | [--copy] | [--recover] | [--noent] | [--nocdata] | [--nsclean] | [--noout] | [--htmlout] | [--nowrap] | [--valid] | [--postvalid] | [--dtdvalid <i class="replaceable"><tt>URL</tt></i>] | [--dtdvalidfpi <i class="replaceable"><tt>FPI</tt></i>] | [--timing] | [--repeat] | [--insert] | [--compress] | [--html] | [--push] | [--memory] | [--nowarning] | [--noblanks] | [--format] | [--testIO] | [--encode <i class="replaceable"><tt>encoding</tt></i>] | [--catalogs] | [--nocatalogs] | [--auto] | [--xinclude] | [--loaddtd] | [--dtdattr] | [--dropdtd] | [--stream] | [--chkregister] | [--relaxng] | [--schema] | [--nonet]] [<tt class="option"><i class="replaceable"><tt>xmlfile</tt></i></tt>]</p></div></div><div class="refsect1" lang="en"><a name="introduction"></a><h2>Introduction</h2><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xmllint</title><meta name="generator" content="DocBook XSL Stylesheets V1.61.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="id2848995"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>xmllint — command line <span class="acronym">XML</span> tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">xmllint</tt> [[--version] | [--debug] | [--shell] | [--debugent] | [--copy] | [--recover] | [--noent] | [--noout] | [--nonet] | [--htmlout] | [--nowrap] | [--valid] | [--postvalid] | [--dtdvalid <i class="replaceable"><tt>URL</tt></i>] | [--dtdvalidfpi <i class="replaceable"><tt>FPI</tt></i>] | [--timing] | [--output <i class="replaceable"><tt>file</tt></i>] | [--repeat] | [--insert] | [--compress] | [--html] | [--xmlout] | [--push] | [--memory] | [--maxmem <i class="replaceable"><tt>nbbytes</tt></i>] | [--nowarning] | [--noblanks] | [--nocdata] | [--format] | [--encode <i class="replaceable"><tt>encoding</tt></i>] | [--dropdtd] | [--nsclean] | [--testIO] | [--catalogs] | [--nocatalogs] | [--auto] | [--xinclude] | [--loaddtd] | [--dtdattr] | [--stream] | [--walker] | [--pattern <i class="replaceable"><tt>patternvalue</tt></i>] | [--chkregister] | [--relaxng] | [--schema]] [<tt class="option"><i class="replaceable"><tt>xmlfile</tt></i></tt>]</p></div></div><div class="refsect1" lang="en"><a name="introduction"></a><h2>Introduction</h2><p>
The xmllint program parses one or more XML files, specified on the
command line as <i class="replaceable"><tt>xmlfile</tt></i>. It prints various
types of output, depending upon the options selected. It is useful for
@@ -61,7 +61,9 @@
</dd><dt><span class="term"><tt class="option">--timing</tt></span></dt><dd>
Output information about the time it takes
<span class="application">xmllint</span> to perform the various steps.
- </dd><dt><span class="term"><tt class="option">--repeat</tt></span></dt><dd>
+ </dd><dt><span class="term"><tt class="option">--output</tt> <i class="replaceable"><tt>file</tt></i></span></dt><dd>Define a file path where xmllint will save the result of
+ parsing. Usually the programs build a tree and save it on stdout, with
+ this option the result XML instance will be saved onto a file.</dd><dt><span class="term"><tt class="option">--repeat</tt></span></dt><dd>
Repeat 100 times, for timing or profiling.
</dd><dt><span class="term"><tt class="option">--insert</tt></span></dt><dd>
Test for valid insertions.
@@ -69,11 +71,18 @@
Turn on gzip compression of output.
</dd><dt><span class="term"><tt class="option">--html</tt></span></dt><dd>
Use the <span class="acronym">HTML</span> parser.
- </dd><dt><span class="term"><tt class="option">--push</tt></span></dt><dd>
+ </dd><dt><span class="term"><tt class="option">--xmlout</tt></span></dt><dd>Used in conjusntion with <tt class="option">--html</tt>. Usually
+ when HTML is parsed the document is saved with the HTML serializer, but with
+ this option the resulting document is saved with the XML serializer. This is
+ primarily used to generate XHTML from HTML input.</dd><dt><span class="term"><tt class="option">--push</tt></span></dt><dd>
Use the push mode of the parser.
</dd><dt><span class="term"><tt class="option">--memory</tt></span></dt><dd>
Parse from memory.
- </dd><dt><span class="term"><tt class="option">--nowarning</tt></span></dt><dd>
+ </dd><dt><span class="term"><tt class="option">--maxmem</tt> <i class="replaceable"><tt>nnbytes</tt></i></span></dt><dd>Test the parser memory
+ support. <i class="replaceable"><tt>nnbytes</tt></i> is the maximum number of bytes the
+ library is allowed to allocate. This can also be used to make sure batch
+ processing of XML files will not exhaust the virtual memory of the server
+ running them.</dd><dt><span class="term"><tt class="option">--nowarning</tt></span></dt><dd>
Do not emit warnings from the parser and/or validator.
</dd><dt><span class="term"><tt class="option">--noblanks</tt></span></dt><dd>
Drop ignorable blank spaces.
@@ -102,8 +111,13 @@
Remove <span class="acronym">DTD</span> from output.
</dd><dt><span class="term"><tt class="option">--stream</tt></span></dt><dd>Use streaming API - useful when used in combination with
--relaxng or --valid options for validation of files that are
- too large to be held in memory.</dd><dt><span class="term"><tt class="option">--chkregister</tt></span></dt><dd>Turn on node registration. Useful for developeres testing
- libxml2 node tracking code.</dd><dt><span class="term"><tt class="option">--relaxng</tt> <i class="replaceable"><tt>schema</tt></i></span></dt><dd>Use RelaxNG file named <i class="replaceable"><tt>schema</tt></i> for
+ too large to be held in memory.</dd><dt><span class="term"><tt class="option">--walker</tt></span></dt><dd>Test the walker module, which is a reader interface but for a
+ document tree, instead of using the reader API on an unparsed document it
+ works on a existing in-memory tree. Used in debugging.</dd><dt><span class="term"><tt class="option">--chkregister</tt></span></dt><dd>Turn on node registration. Useful for developers testing
+ libxml2 node tracking code.</dd><dt><span class="term"><tt class="option">--pattern</tt> <i class="replaceable"><tt>patternvalue</tt></i></span></dt><dd>Used to exercise the pattern recognition engine, which can be
+ used with the reader interface to the parser. It allows to select some
+ nodes in the document based on an XPath (subset) expression. Used for
+ debugging.</dd><dt><span class="term"><tt class="option">--relaxng</tt> <i class="replaceable"><tt>schema</tt></i></span></dt><dd>Use RelaxNG file named <i class="replaceable"><tt>schema</tt></i> for
validation.</dd><dt><span class="term"><tt class="option">--schema</tt> <i class="replaceable"><tt>schema</tt></i></span></dt><dd>Use a W3C XML Schema file named <i class="replaceable"><tt>schema</tt></i> for validation.</dd><dt><span class="term">
<tt class="option">--nonet</tt></span></dt><dd>Do not use the Internet to fetch DTD's or entities.</dd></dl></div></div><div class="refsect1" lang="en"><a name="shell"></a><h2>Shell</h2><p>
<span class="application">xmllint</span> offers an interactive shell mode
diff --git a/doc/xmllint.xml b/doc/xmllint.xml
index f74cb20..908d786 100644
--- a/doc/xmllint.xml
+++ b/doc/xmllint.xml
@@ -29,7 +29,7 @@
</author>
<address><email>hwr@pilhuhn.de</email></address>
- <releaseinfo>This is release 0.4 of the xmllint Manual.</releaseinfo>
+ <releaseinfo>This is release 0.5 of the xmllint Manual.</releaseinfo>
</refentryinfo>
<refmeta>
@@ -53,9 +53,8 @@
<arg>--copy</arg>
<arg>--recover</arg>
<arg>--noent</arg>
- <arg>--nocdata</arg>
- <arg>--nsclean</arg>
<arg>--noout</arg>
+ <arg>--nonet</arg>
<arg>--htmlout</arg>
<arg>--nowrap</arg>
<arg>--valid</arg>
@@ -63,29 +62,35 @@
<arg>--dtdvalid <replaceable>URL</replaceable></arg>
<arg>--dtdvalidfpi <replaceable>FPI</replaceable></arg>
<arg>--timing</arg>
+ <arg>--output <replaceable>file</replaceable></arg>
<arg>--repeat</arg>
<arg>--insert</arg>
<arg>--compress</arg>
<arg>--html</arg>
+ <arg>--xmlout</arg>
<arg>--push</arg>
<arg>--memory</arg>
+ <arg>--maxmem <replaceable>nbbytes</replaceable></arg>
<arg>--nowarning</arg>
<arg>--noblanks</arg>
+ <arg>--nocdata</arg>
<arg>--format</arg>
- <arg>--testIO</arg>
<arg>--encode <replaceable>encoding</replaceable></arg>
+ <arg>--dropdtd</arg>
+ <arg>--nsclean</arg>
+ <arg>--testIO</arg>
<arg>--catalogs</arg>
<arg>--nocatalogs</arg>
<arg>--auto</arg>
<arg>--xinclude</arg>
<arg>--loaddtd</arg>
<arg>--dtdattr</arg>
- <arg>--dropdtd</arg>
<arg>--stream</arg>
+ <arg>--walker</arg>
+ <arg>--pattern <replaceable>patternvalue</replaceable></arg>
<arg>--chkregister</arg>
<arg>--relaxng</arg>
<arg>--schema</arg>
- <arg>--nonet</arg>
</group>
<arg><option><replaceable>xmlfile</replaceable></option></arg>
</cmdsynopsis>
@@ -282,7 +287,14 @@
</simpara>
</listitem>
</varlistentry>
-
+ <varlistentry>
+ <term><option>--output</option> <replaceable>file</replaceable></term>
+ <listitem>
+ <simpara>Define a file path where xmllint will save the result of
+ parsing. Usually the programs build a tree and save it on stdout, with
+ this option the result XML instance will be saved onto a file.</simpara>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><option>--repeat</option></term>
<listitem>
@@ -318,7 +330,15 @@
</simpara>
</listitem>
</varlistentry>
-
+ <varlistentry>
+ <term><option>--xmlout</option></term>
+ <listitem>
+ <simpara>Used in conjusntion with <option>--html</option>. Usually
+ when HTML is parsed the document is saved with the HTML serializer, but with
+ this option the resulting document is saved with the XML serializer. This is
+ primarily used to generate XHTML from HTML input.</simpara>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><option>--push</option></term>
<listitem>
@@ -337,7 +357,16 @@
</simpara>
</listitem>
</varlistentry>
-
+ <varlistentry>
+ <term><option>--maxmem</option> <replaceable>nnbytes</replaceable></term>
+ <listitem>
+ <simpara>Test the parser memory
+ support. <replaceable>nnbytes</replaceable> is the maximum number of bytes the
+ library is allowed to allocate. This can also be used to make sure batch
+ processing of XML files will not exhaust the virtual memory of the server
+ running them.</simpara>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><option>--nowarning</option></term>
<listitem>
@@ -455,6 +484,14 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>--walker</option></term>
+ <listitem>
+ <simpara>Test the walker module, which is a reader interface but for a
+ document tree, instead of using the reader API on an unparsed document it
+ works on a existing in-memory tree. Used in debugging.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>--chkregister</option></term>
<listitem>
<simpara>Turn on node registration. Useful for developers testing
@@ -462,6 +499,15 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>--pattern</option> <replaceable>patternvalue</replaceable></term>
+ <listitem>
+ <simpara>Used to exercise the pattern recognition engine, which can be
+ used with the reader interface to the parser. It allows to select some
+ nodes in the document based on an XPath (subset) expression. Used for
+ debugging.</simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>--relaxng</option> <replaceable>schema</replaceable></term>
<listitem>
<simpara>Use RelaxNG file named <replaceable>schema</replaceable> for