summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Veillard <veillard@src.gnome.org>2006-04-06 08:22:51 +0000
committerDaniel Veillard <veillard@src.gnome.org>2006-04-06 08:22:51 +0000
commitbf95fd2390eaee24fdf9661343d2551c97237ef4 (patch)
tree1c2805152fd0ca15f36846bc7ce10f0f2de8dd1a
parent9110ed633b4b9a2f07930354a20b8c2b52f765cd (diff)
downloadlibxml2-bf95fd2390eaee24fdf9661343d2551c97237ef4.tar.gz
applied man page improvements from Daniel Leidert Daniel
* doc/xmlcatalog.1 doc/xmlcatalog_man.xml doc/xmllint.1 doc/xmllint.xml: applied man page improvements from Daniel Leidert Daniel
-rw-r--r--ChangeLog5
-rw-r--r--doc/xmlcatalog.1313
-rw-r--r--doc/xmlcatalog_man.xml618
-rw-r--r--doc/xmllint.1483
-rw-r--r--doc/xmllint.xml188
5 files changed, 896 insertions, 711 deletions
diff --git a/ChangeLog b/ChangeLog
index af926524..97b14f9b 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Thu Apr 6 10:22:17 CEST 2006 Daniel Veillard <daniel@veillard.com>
+
+ * doc/xmlcatalog.1 doc/xmlcatalog_man.xml doc/xmllint.1 doc/xmllint.xml:
+ applied man page improvements from Daniel Leidert
+
Mon Mar 27 11:44:07 CEST 2006 Daniel Veillard <daniel@veillard.com>
* xmlschemas.c: removed unused code or variables, from Stefan Kost
diff --git a/doc/xmlcatalog.1 b/doc/xmlcatalog.1
index ff31fb70..cd91ec03 100644
--- a/doc/xmlcatalog.1
+++ b/doc/xmlcatalog.1
@@ -1,148 +1,211 @@
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.TH "XMLCATALOG" 1 "" "" "xmlcatalog Manual"
-.SH NAME
+.\" ** You probably do not want to edit this file directly **
+.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
+.\" Instead of manually editing it, you probably should edit the DocBook XML
+.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
+.TH "XMLCATALOG" "1" "2006\-03\-05" "libxml2" ""
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
xmlcatalog \- Command line tool to parse and manipulate XML or SGML catalog files.
.SH "SYNOPSIS"
-.ad l
-.hy 0
.HP 11
-\fBxmlcatalog\fR [\fB\-\-shell\fR | \fB\-\-create\fR | \fB\-\-add\ \fItype\fR\ \fIorig\fR\ \fIreplace\fR\fR | \fB\-\-del\ \fIvalues\fR\fR | \fB\-\-noout\fR | \fB\-\-verbose\fR] [\fB\fIcatalogfile\fR\fR] [\fB\fIentities\fR\fR]
-.ad
-.hy
-
-.SH "INTRODUCTION"
-
-.PP
- xmlcatalog is a command line application allowing users to monitor and manipulate XML and SGML catalogs\&. It is included in libxml2\&.
-
-.PP
-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 XML and SGML files\&.
-
-.SH "COMMAND LINE OPTIONS"
-
+\fBxmlcatalog\fR [\fB\-\-sgml\fR \fB\-\-shell\fR \fB\-\-create\fR \fB\-\-del\ \fR\fB\fIVALUE(S)\fR\fR [\ \fB\-\-add\ \fR\fB\fITYPE\fR\fR\fB\ \fR\fB\fIORIG\fR\fR\fB\ \fR\fB\fIREPLACE\fR\fR\fB\ \fR\ \fB\-\-add\ \fR\fB\fIFILENAME\fR\fR] \fB\-\-noout\fR \fB\-\-no\-super\-update\fR [\fB\-v\fR\ \fB\-\-verbose\fR]] {\fICATALOGFILE\fR} {\fIENTITIES\fR...}
+.SH "DESCRIPTION"
+.PP
+\fBxmlcatalog\fR
+is a command line application allowing users to monitor and manipulate
+XML
+and
+SGML
+catalogs. It is included in
+\fBlibxml\fR(3).
+.PP
+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
+XML
+and
+SGML
+files.
+.PP
+More information can be found at
+.TP 3
+\(bu
+\fBlibxml\fR(3)
+web page
+\fI\%http://www.xmlsoft.org/\fR
+.TP
+\(bu
+\fBlibxml\fR(3)
+catalog support web page at
+\fI\%http://www.xmlsoft.org/catalog.html\fR
.TP
-\fB\-\-shell\fR \fIfilename\fR
-Run a shell allowing interactive queries on catalog file \fIfilename\fR\&.
-
+\(bu
+James Clark's
+SGML
+catalog page
+\fI\%http://www.jclark.com/sp/catalog.htm\fR
.TP
-\fB\-\-create\fR \fIfilename\fR
-Create a new XML catalog\&. Outputs to stdout, ignoring \fIfilename\fR unless \fB\-\-noout\fR is used, in which case it creates a new catalog file \fIfilename\fR\&.
-
+\(bu
+OASISXML
+catalog specification
+\fI\%http://www.oasis\-open.org/committees/entity/spec.html\fR
+.SH "OPTIONS"
+.PP
+\fBxmlcatalog\fR
+accepts the following options (in alphabetical order):
.TP
-\fB\-\-add\fR \fI'type'\fR \fI'orig'\fR \fI'replace'\fR \fIfilename\fR
-Add an entry to catalog file \fIfilename\fR\&. \fItype\fR indicates the type of entry\&. Possible types are 'public', 'system', 'rewriteSystem', 'rewriteURI', 'delegatePublic', 'delegateSystem', and 'nextCatalog'\&. \fI'orig'\fR is the original reference to be replaced, and \fI'replace'\fR is the URI of the replacement entity to be used\&. The \fB\-\-add\fR option will not overwrite \fIfilename\fR, outputting to stdout, unless \fB\-\-noout\fR is used\&. The \fB\-\-add\fR will always take three parameters even if some of the XML catalog constructs will have only a single argument\&.
-
-If the \fB\-\-add\fR option is used following the \fB\-\-sgml\fR option, only a single argument, a \fIfilename\fR, is used\&. This is used to add the name of a catalog file to an SGML supercatalog, a file that contains references to other included SGML catalog files\&.
-
+\fB\-\-add \fR\fB\fITYPE\fR\fR\fB \fR\fB\fIORIG\fR\fR\fB \fR\fB\fIREPLACE\fR\fR\fB \fR
+Add an entry to
+\fICATALOGFILE\fR.
+\fITYPE\fR
+indicates the type of entry. Possible types are:
+\fIpublic\fR, \fIsystem\fR, \fIrewriteSystem\fR, \fIrewriteURI\fR, \fIdelegatePublic\fR, \fIdelegateSystem\fR, \fInextCatalog\fR.
+\fIORIG\fR
+is the original reference to be replaced, and
+\fIREPLACE\fR
+is the
+URI
+of the replacement entity to be used. The
+\fB\-\-add\fR
+option will not overwrite
+\fICATALOGFILE\fR, outputting to
+\fIstdout\fR, unless
+\fB\-\-noout\fR
+is used. The
+\fB\-\-add\fR
+will always take three parameters even if some of the
+XML
+catalog constructs will have only a single argument.
.TP
-\fB\-\-del\fR \fI'values'\fR \fIfilename\fR
-Remove entries from the catalog file \fIfilename\fR matching \fI'values'\fR\&. The \fB\-\-del\fR option will not overwrite \fIfilename\fR, outputting to stdout, unless \fB\-\-noout\fR is used\&.
-
+\fB\-\-add \fR\fB\fIFILENAME\fR\fR
+If the
+\fB\-\-add\fR
+option is used following the
+\fB\-\-sgml\fR
+option, only a single argument, a
+\fIFILENAME\fR, is used. This is used to add the name of a catalog file to an
+SGML
+supercatalog, a file that contains references to other included
+SGML
+catalog files.
.TP
+\fB\-\-create\fR
+Create a new
+XML
+catalog. Outputs to
+\fIstdout\fR, ignoring
+\fIfilename\fR
+unless
\fB\-\-noout\fR
-Save output to the named file rather than outputting to stdout\&.
-
+is used, in which case it creates a new catalog file
+\fIfilename\fR.
+.TP
+\fB\-\-del \fR\fB\fIVALUE(S)\fR\fR
+Remove entries from
+\fICATALOGFILE\fR
+matching
+\fIVALUE(S)\fR. The
+\fB\-\-del\fR
+option will not overwrite
+\fICATALOGFILE\fR, outputting to
+\fIstdout\fR, unless
+\fB\-\-noout\fR
+is used.
+.TP
+\fB\-\-noout\fR
+Save output to the named file rather than outputting to
+\fIstdout\fR.
+.TP
+\fB\-\-no\-super\-update\fR
+Do not update the
+SGML
+super catalog.
+.TP
+\fB\-\-shell\fR
+Run a shell allowing interactive queries on catalog file
+\fICATALOGFILE\fR.
.TP
\fB\-\-sgml\fR
-Uses SGML Super catalogs for \-\-add and \-\-del options
-
+Uses
+SGML
+super catalogs for
+\fB\-\-add\fR
+and
+\fB\-\-del\fR
+options.
.TP
-\fB\-v\fR or \fB\-\-verbose\fR
-output debugging information\&.
-
+\fB\-v\fR, \fB\-\-verbose\fR
+Output debugging information.
.SH "SHELL COMMANDS"
-
.PP
-Invoking xmlcatalog with the \fB\-\-shell\fR \fIfilename\fR option opens a command line shell allowing interactive access to the catalog file identified by \fIfilename\fR\&. Invoking the shell provides a command line prompt after which commands can be entered\&.
-
+Invoking
+\fBxmlcatalog\fR
+with the
+\fB\-\-shell \fR\fB\fICATALOGFILE\fR\fR
+option opens a command line shell allowing interactive access to the catalog file identified by
+\fICATALOGFILE\fR. Invoking the shell provides a command line prompt after which the following commands (described in alphabetical order) can be entered.
.TP
-\fBpublic\fR \fI'PublicID'\fR
-Execute a public identifier lookup of the catalog entry for \fI'PublicID'\fR\&. The corresponding entry will be output to the command line\&.
-
-.TP
-\fBsystem\fR \fI'SystemID'\fR
-Execute a public identifier lookup of the catalog entry for \fI'SystemID'\fR\&. The corresponding entry will be output to the command line\&.
-
+\fBadd \fR\fB\fITYPE\fR\fR\fB \fR\fB\fIORIG\fR\fR\fB \fR\fB\fIREPLACE\fR\fR\fB \fR
+Add an entry to the catalog file.
+\fITYPE\fR
+indicates the type of entry. Possible types are:
+\fIpublic\fR, \fIsystem\fR, \fIrewriteSystem\fR, \fIrewriteURI\fR, \fIdelegatePublic\fR, \fIdelegateSystem\fR, \fInextCatalog\fR.
+\fIORIG\fR
+is the original reference to be replaced, and
+\fIREPLACE\fR
+is the
+URI
+of the replacement entity to be used. The
+\fB\-\-add\fR
+option will not overwrite
+\fICATALOGFILE\fR, outputting to
+\fIstdout\fR, unless
+\fB\-\-noout\fR
+is used. The
+\fB\-\-add\fR
+will always take three parameters even if some of the
+XML
+catalog constructs will have only a single argument.
.TP
-\fBadd \fR \fI'type'\fR \fI'orig'\fR \fI'replace'\fR
-Add an entry to the catalog file\&. \fItype\fR indicates the type of entry\&. Possible types are 'public', 'system', 'rewriteSystem', 'rewriteURI', 'delegatePublic', 'delegateSystem', and 'nextCatalog'\&. \fI'orig'\fR is the original reference to be replaced, and \fI'replace'\fR is the URI of the replacement entity to be used\&.
-
+\fBdebug\fR
+Print debugging statements showing the steps
+\fBxmlcatalog\fR
+is executing.
.TP
-\fBdel\fR \fI'values'\fR
-Remove the catalog entry corresponding to \fI'values'\fR\&.
-
+\fBdel \fR\fB\fIVALUE(S)\fR\fR
+Remove the catalog entry corresponding to
+\fIVALUE(S)\fR.
.TP
\fBdump\fR
-Print the current catalog\&.
-
+Print the current catalog.
.TP
-\fBdebug\fR
-Print debugging statements showing the steps xmlcatalog is executing\&.
-
+\fBexit\fR
+Quit the shell.
+.TP
+\fBpublic \fR\fB\fIPUBLIC\-ID\fR\fR
+Execute a public identifier lookup of the catalog entry for
+\fIPUBLIC\-ID\fR. The corresponding entry will be output to the command line.
.TP
\fBquiet\fR
-Stop printing debugging statements\&.
-
+Stop printing debugging statements.
.TP
-\fBexit\fR
-Quit the shell\&.
-
-.SH "RETURN VALUES"
-
-.PP
-xmlcatalog's return codes provide information that can be used when calling it from scripts\&.
-
-.PP
-0: normal
-
-.PP
-1: Failed to remove an entry from the catalog
-
-.PP
-2: Failed to save to the catalog, check file permissions
-
-.PP
-3: Failed to add an entry to the catalog
-
-.PP
-4: Failed to lookup and entry in the catalog
-
-.SH "CATALOGS"
-
-.PP
-Catalog behavior can be changed by redirecting queries to the user's own set of catalogs\&. This can be done by setting the \fIXML_CATALOG_FILES\fR environment variable to a list of catalogs\&. An empty one should deactivate loading the default \fI/etc/xml/catalog\fR default catalog\&.
-
-.SH "REFERENCES"
-
-.PP
-libxml web page: \fIhttp://www.xmlsoft.org/\fR
-
-.PP
-libxml catalog support web page: \fIhttp://www.xmlsoft.org/catalog.html\fR
-
-.PP
-James Clark's SGML catalog page: \fIhttp://www.jclark.com/sp/catalog.htm\fR
-
-.PP
-OASIS XML catalog specification: \fIhttp://www.oasis-open.org/committees/entity/spec.html\fR
-
-.SH AUTHOR
-John Fleck.
+\fBsystem \fR\fB\fISYSTEM\-ID\fR\fR
+Execute a public identifier lookup of the catalog entry for
+\fISYSTEM\-ID\fR. The corresponding entry will be output to the command line.
+.SH "ENVIRONMENT"
+.TP
+\fBXML_CATALOG_FILES\fR
+Catalog behavior can be changed by redirecting queries to the user's own set of catalogs. This can be done by setting the
+\fBXML_CATALOG_FILES\fR
+environment variable to a list of catalogs. An empty one should deactivate loading the default
+\fI/etc/xml/catalog\fR
+default catalog.
+.SH "DIAGNOSTICS"
+.PP
+\fBxmlcatalog\fR's return codes provide information that can be used when calling it from scripts.
+Errorcode: \fB0\fRError: No errorErrorcode: \fB1\fRError: Failed to remove an entry from the catalogErrorcode: \fB2\fRError: Failed to save to the catalog, check file permissionsErrorcode: \fB3\fRError: Failed to add an entry to the catalogErrorcode: \fB4\fRError: Failed to lookup and entry in the catalog.SH "SEE ALSO"
+.PP
+\fBlibxml\fR(3)
+.SH "AUTHOR"
+John Fleck <jfleck@inkstain.net>.
diff --git a/doc/xmlcatalog_man.xml b/doc/xmlcatalog_man.xml
index b35002f9..ce9c2330 100644
--- a/doc/xmlcatalog_man.xml
+++ b/doc/xmlcatalog_man.xml
@@ -3,297 +3,431 @@
href="http://docbook.sourceforge.net/release/xsl/current/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>
+<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>
- <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>
+<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="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>
+<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>
- <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>
+ <varlistentry>
+ <term>
+ <option>--add
+ <replaceable>TYPE</replaceable>
+ <replaceable>ORIG</replaceable>
+ <replaceable>REPLACE</replaceable>
+ </option>
+ </term>
<listitem>
- <simpara>
- Run a shell
- allowing interactive queries on catalog file
- <replaceable>filename</replaceable>.
- </simpara>
+ <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>--create</option> <replaceable>filename</replaceable></term>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--add <replaceable>FILENAME</replaceable></option></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>
+ <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>
- <varlistentry>
- <term><option>--add</option> <replaceable>'type'</replaceable> <replaceable>'orig'</replaceable> <replaceable>'replace'</replaceable> <replaceable>filename</replaceable></term>
+ <varlistentry>
+ <term><option>--create</option></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>
+ <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</option> <replaceable>'values'</replaceable> <replaceable>filename</replaceable></term>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--del <replaceable>VALUE(S)</replaceable></option></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>
+ <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>
+ </varlistentry>
+
+ <varlistentry>
<term><option>--noout</option></term>
<listitem>
- <simpara>
- Save output to the named file rather than
- outputting to stdout.
- </simpara>
+ <para>
+ Save output to the named file rather than outputting
+ to <filename class="devicefile">stdout</filename>.
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
+ </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>
+ <para>
+ Uses <acronym>SGML</acronym> super catalogs for <option>--add</option>
+ and <option>--del</option> options.
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v</option> or <option>--verbose</option></term>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-v</option></term>
+ <term><option>--verbose</option></term>
<listitem>
- <simpara>
- output debugging
- information.
- </simpara>
+ <para>Output debugging information.</para>
</listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
+ </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>
+<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>
- <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>
+ <varlistentry>
+ <term>
+ <option>add
+ <replaceable>TYPE</replaceable>
+ <replaceable>ORIG</replaceable>
+ <replaceable>REPLACE</replaceable>
+ </option>
+ </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>
+ <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>
- <term><option>add </option> <replaceable>'type'</replaceable> <replaceable>'orig'</replaceable> <replaceable>'replace'</replaceable></term>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>debug</option></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>
+ <para>
+ Print debugging statements showing the steps &xmlcatalog; is executing.
+ </para>
</listitem>
- </varlistentry>
- <varlistentry>
- <term><option>del</option> <replaceable>'values'</replaceable></term>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>del <replaceable>VALUE(S)</replaceable></option></term>
<listitem>
- <simpara>
- Remove the
- catalog entry corresponding to <replaceable>'values'</replaceable>.
- </simpara>
+ <para>
+ Remove the catalog entry corresponding to <replaceable>VALUE(S)</replaceable>.
+ </para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry>
+ <varlistentry>
<term><option>dump</option></term>
<listitem>
- <simpara>
- Print the current catalog.
- </simpara>
+ <para>Print the current catalog.</para>
</listitem>
- </varlistentry>
+ </varlistentry>
- <varlistentry>
- <term><option>debug</option></term>
+ <varlistentry>
+ <term><option>exit</option></term>
+ <listitem>
+ <para>Quit the shell.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>public <replaceable>PUBLIC-ID</replaceable></option></term>
<listitem>
- <simpara>
- Print debugging statements showing the steps
- <application>xmlcatalog</application> is executing.
- </simpara>
+ <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>
+ </varlistentry>
+
+ <varlistentry>
<term><option>quiet</option></term>
<listitem>
- <simpara>
- Stop printing debugging statements.
- </simpara>
+ <para>Stop printing debugging statements.</para>
</listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>exit</option></term>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>system <replaceable>SYSTEM-ID</replaceable></option></term>
<listitem>
- <simpara>
- Quit the shell.
- </simpara>
+ <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>
+ </varlistentry>
- </refsect1>
+ </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>
+<refsect1 id="environment">
+ <title>ENVIRONMENT</title>
+ <variablelist>
- <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>
+ <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>
- <para><ulink url="http://www.xmlsoft.org/catalog.html"><application>libxml</application>
- catalog support web page</ulink></para>
+ </variablelist>
+</refsect1>
- <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>
+<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> -->
+ <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>
diff --git a/doc/xmllint.1 b/doc/xmllint.1
index cb8f4473..84eb10d5 100644
--- a/doc/xmllint.1
+++ b/doc/xmllint.1
@@ -1,386 +1,371 @@
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.TH "XMLLINT" 1 "2006-02-20" "libxml2" "xmllint Manual"
-.SH NAME
+.\" ** You probably do not want to edit this file directly **
+.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
+.\" Instead of manually editing it, you probably should edit the DocBook XML
+.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
+.TH "XMLLINT" "1" "2006\-03\-05" "libxml2" ""
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
xmllint \- command line XML tool
.SH "SYNOPSIS"
-.ad l
-.hy 0
.HP 8
-\fBxmllint\fR [\fB\fB\-\-version\fR\fR | \fB\fB\-\-debug\fR\fR | \fB\fB\-\-shell\fR\fR | \fB\fB\-\-debugent\fR\fR | \fB\fB\-\-copy\fR\fR | \fB\fB\-\-recover\fR\fR | \fB\fB\-\-noent\fR\fR | \fB\fB\-\-noout\fR\fR | \fB\fB\-\-nonet\fR\fR | \fB\fB\-\-path\ \fI"PATHS"\fR\fR\fR | \fB\fB\-\-load\-trace\fR\fR | \fB\fB\-\-htmlout\fR\fR | \fB\fB\-\-nowrap\fR\fR | \fB\fB\-\-valid\fR\fR | \fB\fB\-\-postvalid\fR\fR | \fB\fB\-\-dtdvalid\ \fIURL\fR\fR\fR | \fB\fB\-\-dtdvalidfpi\ \fIFPI\fR\fR\fR | \fB\fB\-\-timing\fR\fR | \fB\fB\-\-output\ \fIFILE\fR\fR\fR | \fB\fB\-\-repeat\fR\fR | \fB\fB\-\-insert\fR\fR | \fB\fB\-\-compress\fR\fR | \fB\fB\-\-html\fR\fR | \fB\fB\-\-xmlout\fR\fR | \fB\fB\-\-push\fR\fR | \fB\fB\-\-memory\fR\fR | \fB\fB\-\-maxmem\ \fINBBYTES\fR\fR\fR | \fB\fB\-\-nowarning\fR\fR | \fB\fB\-\-noblanks\fR\fR | \fB\fB\-\-nocdata\fR\fR | \fB\fB\-\-format\fR\fR | \fB\fB\-\-encode\ \fIENCODING\fR\fR\fR | \fB\fB\-\-dropdtd\fR\fR | \fB\fB\-\-nsclean\fR\fR | \fB\fB\-\-testIO\fR\fR | \fB\fB\-\-catalogs\fR\fR | \fB\fB\-\-nocatalogs\fR\fR | \fB\fB\-\-auto\fR\fR | \fB\fB\-\-xinclude\fR\fR | \fB\fB\-\-noxincludenode\fR\fR | \fB\fB\-\-loaddtd\fR\fR | \fB\fB\-\-dtdattr\fR\fR | \fB\fB\-\-stream\fR\fR | \fB\fB\-\-walker\fR\fR | \fB\fB\-\-pattern\ \fIPATTERNVALUE\fR\fR\fR | \fB\fB\-\-chkregister\fR\fR | \fB\fB\-\-relaxng\ \fISCHEMA\fR\fR\fR | \fB\fB\-\-schema\ \fISCHEMA\fR\fR\fR | \fB\fB\-\-c14n\fR\fR] {\fB\fIXML\-FILE(S)\fR\fR | \fB\-\fR}
-.ad
-.hy
-.ad l
-.hy 0
+\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\-\-path\ "\fR\fB\fIPATH(S)\fR\fR\fB"\fR \fB\-\-load\-trace\fR \fB\-\-htmlout\fR \fB\-\-nowrap\fR \fB\-\-valid\fR \fB\-\-postvalid\fR \fB\-\-dtdvalid\ \fR\fB\fIURL\fR\fR \fB\-\-dtdvalidfpi\ \fR\fB\fIFPI\fR\fR \fB\-\-timing\fR \fB\-\-output\ \fR\fB\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\ \fR\fB\fINBBYTES\fR\fR \fB\-\-nowarning\fR \fB\-\-noblanks\fR \fB\-\-nocdata\fR \fB\-\-format\fR \fB\-\-encode\ \fR\fB\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\-\-noxincludenode\fR \fB\-\-loaddtd\fR \fB\-\-dtdattr\fR \fB\-\-stream\fR \fB\-\-walker\fR \fB\-\-pattern\ \fR\fB\fIPATTERNVALUE\fR\fR \fB\-\-chkregister\fR \fB\-\-relaxng\ \fR\fB\fISCHEMA\fR\fR \fB\-\-schema\ \fR\fB\fISCHEMA\fR\fR \fB\-\-c14n\fR] {\fIXML\-FILE(S)\fR... \-}
.HP 8
\fBxmllint\fR \fB\-\-help\fR
-.ad
-.hy
-
.SH "DESCRIPTION"
-
.PP
-The \fBxmllint\fR program parses one or more XML files, specified on the command line as \fIXML\-FILE\fR (or the standard input if the filename provided is \- )\&. It prints various types of output, depending upon the options selected\&. It is useful for detecting errors both in XML code and in the XML parser itself\&.
-
+The
+\fBxmllint\fR
+program parses one or more XML files, specified on the command line as
+\fIXML\-FILE\fR
+(or the standard input if the filename provided is
+\fB\-\fR
+). It prints various types of output, depending upon the options selected. It is useful for detecting errors both in
+XML
+code and in the
+XML
+parser itself.
.PP
-\fBxmllint\fR is included in libxml2\&.
-
+\fBxmllint\fR
+is included in
+\fBlibxml\fR(3).
.PP
-More information can be found at the libxml web pages at \fIhttp://www.xmlsoft.org/\fR and the W3C XSLT pages at \fIhttp://www.w3.org/TR/xslt\fR\&.
-
+More information can be found at
+.TP 3
+\(bu
+\fBlibxml\fR(3)
+web page
+\fI\%http://www.xmlsoft.org/\fR
+.TP
+\(bu
+W3C
+XSLT
+page
+\fI\%http://www.w3.org/TR/xslt\fR
.SH "OPTIONS"
-
.PP
-\fBxmllint\fR accepts the following options (in alphabetical order):
-
+\fBxmllint\fR
+accepts the following options (in alphabetical order):
.TP
\fB\-\-auto\fR
-Generate a small document for testing purposes\&.
-
+Generate a small document for testing purposes.
.TP
\fB\-\-catalogs\fR
-Use the catalogs from \fBSGML_CATALOG_FILES\fR\&. Otherwise \fI/etc/xml/catalog\fR is used by default\&.
-
+Use the catalogs from
+\fBSGML_CATALOG_FILES\fR. Otherwise
+\fI/etc/xml/catalog\fR
+is used by default.
.TP
\fB\-\-chkregister\fR
-Turn on node registration\&. Useful for developers testing libxml2 node tracking code\&.
-
+Turn on node registration. Useful for developers testing
+\fBlibxml\fR(3)
+node tracking code.
.TP
\fB\-\-compress\fR
-Turn on gzip compression of output\&.
-
+Turn on
+gzip
+compression of output.
.TP
\fB\-\-copy\fR
-Test the internal copy implementation\&.
-
+Test the internal copy implementation.
.TP
\fB\-\-c14n\fR
-Use the W3C XML Canonicalisation (C14N) to serialize the result of parsing to \fIstdout\fR\&. It keeps comments in the result\&.
-
-.TP
-\fB\-\-dtdvalid \fIURL\fR\fR
-Use the DTD specified by an \fIURL\fR for validation\&.
-
-.TP
-\fB\-\-dtdvalidfpi \fIFPI\fR\fR
-Use the DTD specified by a Public Identifier \fIFPI\fR for validation, note that this will require a Catalog exporting that Public Identifier to work\&.
-
+Use the W3C XML Canonicalisation (C14N) to serialize the result of parsing to
+\fIstdout\fR. It keeps comments in the result.
+.TP
+\fB\-\-dtdvalid \fR\fB\fIURL\fR\fR
+Use the
+DTD
+specified by an
+\fIURL\fR
+for validation.
+.TP
+\fB\-\-dtdvalidfpi \fR\fB\fIFPI\fR\fR
+Use the
+DTD
+specified by a Public Identifier
+\fIFPI\fR
+for validation, note that this will require a Catalog exporting that Public Identifier to work.
.TP
\fB\-\-debug\fR
-Parse a file and output an annotated tree of the in\-memory version of the document\&.
-
+Parse a file and output an annotated tree of the in\-memory version of the document.
.TP
\fB\-\-debugent\fR
-Debug the entities defined in the document\&.
-
+Debug the entities defined in the document.
.TP
\fB\-\-dropdtd\fR
-Remove DTD from output\&.
-
+Remove
+DTD
+from output.
.TP
\fB\-\-dtdattr\fR
-Fetch external DTD and populate the tree with inherited attributes\&.
-
+Fetch external
+DTD
+and populate the tree with inherited attributes.
.TP
-\fB\-\-encode \fIENCODING\fR\fR
-Output in the given encoding\&.
-
+\fB\-\-encode \fR\fB\fIENCODING\fR\fR
+Output in the given encoding.
.TP
\fB\-\-format\fR
-Reformat and reindent the output\&. The \fBXMLLINT_INDENT\fR environment variable controls the indentation (default value is two spaces " ")\&.
-
+Reformat and reindent the output. The
+\fBXMLLINT_INDENT\fR
+environment variable controls the indentation (default value is two spaces " ").
.TP
\fB\-\-help\fR
-Print out a short usage summary for \fBxmllint\fR\&.
-
+Print out a short usage summary for
+\fBxmllint\fR.
.TP
\fB\-\-html\fR
-Use the HTML parser\&.
-
+Use the
+HTML
+parser.
.TP
\fB\-\-htmlout\fR
-Output results as an HTML file\&. This causes \fBxmllint\fR to output the necessary HTML tags surrounding the result tree output so the results can be displayed/viewed in a browser\&.
-
+Output results as an
+HTML
+file. This causes
+\fBxmllint\fR
+to output the necessary
+HTML
+tags surrounding the result tree output so the results can be displayed/viewed in a browser.
.TP
\fB\-\-insert\fR
-Test for valid insertions\&.
-
+Test for valid insertions.
.TP
\fB\-\-loaddtd\fR
-Fetch external DTD\&.
-
+Fetch external
+DTD.
.TP
\fB\-\-load\-trace\fR
-Display all the documents loaded during the processing to \fIstderr\fR\&.
-
+Display all the documents loaded during the processing to
+\fIstderr\fR.
.TP
-\fB\-\-maxmem \fINNBYTES\fR\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\&.
-
+\fB\-\-maxmem \fR\fB\fINNBYTES\fR\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\-\-memory\fR
-Parse from memory\&.
-
+Parse from memory.
.TP
\fB\-\-noblanks\fR
-Drop ignorable blank spaces\&.
-
+Drop ignorable blank spaces.
.TP
\fB\-\-nocatalogs\fR
-Do not use any catalogs\&.
-
+Do not use any catalogs.
.TP
\fB\-\-nocdata\fR
-Substitute CDATA section by equivalent text nodes\&.
-
+Substitute CDATA section by equivalent text nodes.
.TP
\fB\-\-noent\fR
-Substitute entity values for entity references\&. By default, \fBxmllint\fR leaves entity references in place\&.
-
+Substitute entity values for entity references. By default,
+\fBxmllint\fR
+leaves entity references in place.
.TP
\fB\-\-nonet\fR
-Do not use the Internet to fetch DTDs or entities\&.
-
+Do not use the Internet to fetch
+DTDs or entities.
.TP
\fB\-\-noout\fR
-Suppress output\&. By default, \fBxmllint\fR outputs the result tree\&.
-
+Suppress output. By default,
+\fBxmllint\fR
+outputs the result tree.
.TP
\fB\-\-nowarning\fR
-Do not emit warnings from the parser and/or validator\&.
-
+Do not emit warnings from the parser and/or validator.
.TP
\fB\-\-nowrap\fR
-Do not output HTML doc wrapper\&.
-
+Do not output
+HTML
+doc wrapper.
.TP
\fB\-\-noxincludenode\fR
-Do XInclude processing but do not generate XInclude start and end nodes\&.
-
+Do XInclude processing but do not generate XInclude start and end nodes.
.TP
\fB\-\-nsclean\fR
-Remove redundant namespace declarations\&.
-
+Remove redundant namespace declarations.
.TP
-\fB\-\-output \fIFILE\fR\fR
-Define a file path where \fBxmllint\fR will save the result of parsing\&. Usually the programs build a tree and save it on \fIstdout\fR, with this option the result XML instance will be saved onto a file\&.
-
+\fB\-\-output \fR\fB\fIFILE\fR\fR
+Define a file path where
+\fBxmllint\fR
+will save the result of parsing. Usually the programs build a tree and save it on
+\fIstdout\fR, with this option the result
+XML
+instance will be saved onto a file.
.TP
-\fB\-\-path \fI"PATHS"\fR\fR
-Use the (space\- or colon\-separated) list of filesystem paths specified by \fIPATHS\fR to load DTDs or entities\&. Enclose space\-separated lists by quotation marks\&.
-
+\fB\-\-path "\fR\fB\fIPATH(S)\fR\fR\fB"\fR
+Use the (space\- or colon\-separated) list of filesystem paths specified by
+\fIPATHS\fR
+to load
+DTDs or entities. Enclose space\-separated lists by quotation marks.
.TP
-\fB\-\-pattern \fIPATTERNVALUE\fR\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\&.
-
+\fB\-\-pattern \fR\fB\fIPATTERNVALUE\fR\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\-\-postvalid\fR
-Validate after parsing is completed\&.
-
+Validate after parsing is completed.
.TP
\fB\-\-push\fR
-Use the push mode of the parser\&.
-
+Use the push mode of the parser.
.TP
\fB\-\-recover\fR
-Output any parsable portions of an invalid document\&.
-
+Output any parsable portions of an invalid document.
.TP
-\fB\-\-relaxng \fISCHEMA\fR\fR
-Use RelaxNG file named \fISCHEMA\fR for validation\&.
-
+\fB\-\-relaxng \fR\fB\fISCHEMA\fR\fR
+Use RelaxNG file named
+\fISCHEMA\fR
+for validation.
.TP
\fB\-\-repeat\fR
-Repeat 100 times, for timing or profiling\&.
-
+Repeat 100 times, for timing or profiling.
.TP
-\fB\-\-schema \fISCHEMA\fR\fR
-Use a W3C XML Schema file named \fISCHEMA\fR for validation\&.
-
+\fB\-\-schema \fR\fB\fISCHEMA\fR\fR
+Use a W3C XML Schema file named
+\fISCHEMA\fR
+for validation.
.TP
\fB\-\-shell\fR
-Run a navigating shell\&. Details on available commands in shell mode are below (see section SHELL COMMANDS)\&.
-
+Run a navigating shell. Details on available commands in shell mode are below (see
+the section called \(lqSHELL COMMANDS\(rq).
.TP
\fB\-\-stream\fR
-Use streaming API \- useful when used in combination with \fB\-\-relaxng\fR or \fB\-\-valid\fR options for validation of files that are too large to be held in memory\&.
-
+Use streaming API \- useful when used in combination with
+\fB\-\-relaxng\fR
+or
+\fB\-\-valid\fR
+options for validation of files that are too large to be held in memory.
.TP
\fB\-\-testIO\fR
-Test user input/output support\&.
-
+Test user input/output support.
.TP
\fB\-\-timing\fR
-Output information about the time it takes \fBxmllint\fR to perform the various steps\&.
-
+Output information about the time it takes
+\fBxmllint\fR
+to perform the various steps.
.TP
\fB\-\-valid\fR
-Determine if the document is a valid instance of the included Document Type Definition (DTD)\&. A DTD to be validated against also can be specified at the command line using the \fB\-\-dtdvalid\fR option\&. By default, \fBxmllint\fR also checks to determine if the document is well\-formed\&.
-
+Determine if the document is a valid instance of the included Document Type Definition (DTD). A
+DTD
+to be validated against also can be specified at the command line using the
+\fB\-\-dtdvalid\fR
+option. By default,
+\fBxmllint\fR
+also checks to determine if the document is well\-formed.
.TP
\fB\-\-version\fR
-Display the version of libxml2 used\&.
-
+Display the version of
+\fBlibxml\fR(3)
+used.
.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\&.
-
+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\-\-xinclude\fR
-Do XInclude processing\&.
-
+Do XInclude processing.
.TP
\fB\-\-xmlout\fR
-Used in conjunction 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\&.
-
+Used in conjunction 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.
.SH "SHELL COMMANDS"
-
.PP
-\fBxmllint\fR offers an interactive shell mode invoked with the \fB\-\-shell\fR command\&. Available commands in shell mode include (in alphabetical order):
-
+\fBxmllint\fR
+offers an interactive shell mode invoked with the
+\fB\-\-shell\fR
+command. Available commands in shell mode include (in alphabetical order):
.TP
\fBbase\fR
-Display XML base of the node\&.
-
+Display
+XML
+base of the node.
.TP
\fBbye\fR
-Leave the shell\&.
-
+Leave the shell.
.TP
-\fBcat \fINODE\fR\fR
-Display the given node or the current one\&.
-
+\fBcat \fR\fB\fINODE\fR\fR
+Display the given node or the current one.
.TP
-\fBcd \fIPATH\fR\fR
-Change the current node to the given path (if unique) or root if no argument is given\&.
-
+\fBcd \fR\fB\fIPATH\fR\fR
+Change the current node to the given path (if unique) or root if no argument is given.
.TP
-\fBdir \fIPATH\fR\fR
-Dumps information about the node (namespace, attributes, content)\&.
-
+\fBdir \fR\fB\fIPATH\fR\fR
+Dumps information about the node (namespace, attributes, content).
.TP
-\fBdu \fIPATH\fR\fR
-Show the structure of the subtree under the given path or the current node\&.
-
+\fBdu \fR\fB\fIPATH\fR\fR
+Show the structure of the subtree under the given path or the current node.
.TP
\fBexit\fR
-Leave the shell\&.
-
+Leave the shell.
.TP
\fBhelp\fR
-Show this help\&.
-
+Show this help.
.TP
\fBfree\fR
-Display memory usage\&.
-
+Display memory usage.
.TP
-\fBload \fIFILENAME\fR\fR
-Load a new document with the given filename\&.
-
+\fBload \fR\fB\fIFILENAME\fR\fR
+Load a new document with the given filename.
.TP
-\fBls \fIPATH\fR\fR
-List contents of the given path or the current directory\&.
-
+\fBls \fR\fB\fIPATH\fR\fR
+List contents of the given path or the current directory.
.TP
\fBpwd\fR
-Display the path to the current node\&.
-
+Display the path to the current node.
.TP
\fBquit\fR
-Leave the shell\&.
-
+Leave the shell.
.TP
-\fBsave \fIFILENAME\fR\fR
-Save the current document to the given filename or to the original name\&.
-
+\fBsave \fR\fB\fIFILENAME\fR\fR
+Save the current document to the given filename or to the original name.
.TP
\fBvalidate\fR
-Check the document for errors\&.
-
+Check the document for errors.
.TP
-\fBwrite \fIFILENAME\fR\fR
-Write the current node to the given filename\&.
-
+\fBwrite \fR\fB\fIFILENAME\fR\fR
+Write the current node to the given filename.
.SH "ENVIRONMENT"
-
.TP
\fBSGML_CATALOG_FILES\fR
-\&.\&.\&.
-
+to be written ...
.TP
\fBXML_CATALOG_FILES\fR
-Catalog behavior can be changed by redirecting queries to the user's own set of catalogs\&. This can be done by setting the \fBXML_CATALOG_FILES\fR environment variable to a list of catalogs\&. An empty one should deactivate loading the default \fI/etc/xml/catalog\fR default catalog\&.
-
+Catalog behavior can be changed by redirecting queries to the user's own set of catalogs. This can be done by setting the
+\fBXML_CATALOG_FILES\fR
+environment variable to a list of catalogs. An empty one should deactivate loading the default
+\fI/etc/xml/catalog\fR
+default catalog.
.TP
\fBXML_DEBUG_CATALOG\fR
-Setting the environment variable \fBXML_DEBUG_CATALOG\fR using the \fBexport\fR command outputs debugging information related to catalog operations\&.
-
+Setting the environment variable
+\fBXML_DEBUG_CATALOG\fR
+using the
+\fBexport\fR
+command outputs debugging information related to catalog operations.
.TP
\fBXMLLINT_INDENT\fR
-\&.\&.\&.
-
+to be written ...
.SH "DIAGNOSTICS"
-
.PP
-On the completion of execution, \fBxmllint\fR returns the following error codes:
-
-.TP
-\fB0\fR
-No error
-
-.TP
-\fB1\fR
-Unclassified
-
-.TP
-\fB2\fR
-Error in DTD
-
-.TP
-\fB3\fR
-Validation error
-
-.TP
-\fB4\fR
-Validation error
-
-.TP
-\fB5\fR
-Error in schema compilation
-
-.TP
-\fB6\fR
-Error writing output
-
-.TP
-\fB7\fR
-Error in pattern (generated when \fB\-\-pattern\fR option is used)
-
-.TP
-\fB8\fR
-Error in Reader registration (generated when \fB\-\-chkregister\fR option is used)
-
-.TP
-\fB9\fR
-Out of memory error
-
-.SH AUTHORS
-John Fleck <jfleck@inkstain\&.net>, Ziying Sherwin <sherwin@nlm\&.nih\&.gov>, Heiko Rupp <hwr@pilhuhn\&.de>.
+On the completion of execution,
+\fBxmllint\fR
+returns the following error codes:
+Errorcode: \fB0\fRError: No errorErrorcode: \fB1\fRError: UnclassifiedErrorcode: \fB2\fRError: Error in DTDErrorcode: \fB3\fRError: Validation errorErrorcode: \fB4\fRError: Validation errorErrorcode: \fB5\fRError: Error in schema compilationErrorcode: \fB6\fRError: Error writing outputErrorcode: \fB7\fRError: Error in pattern (generated when \fB\-\-pattern\fR option is used)Errorcode: \fB8\fRError: Error in reader registration (generated when \fB\-\-chkregister\fR option is used)Errorcode: \fB9\fRError: Out of memory.SH "SEE ALSO"
+.PP
+\fBlibxml\fR(3)
+.SH "AUTHOR"
+John Fleck <jfleck@inkstain.net>, Ziying Sherwin <sherwin@nlm.nih.gov>, Heiko Rupp <hwr@pilhuhn.de>.
diff --git a/doc/xmllint.xml b/doc/xmllint.xml
index 8c3ddf2d..a899bb37 100644
--- a/doc/xmllint.xml
+++ b/doc/xmllint.xml
@@ -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,73 @@
<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> -->
+ <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>