Commit e42ae6f9 authored by MST 2004 John Fleck's avatar MST 2004 John Fleck Committed by John Fleck

doc/xmllint.xml doc/xmllint.1 doc/xmllint.html doc/xmlcatalog_man.xml


Thu Feb 26 20:19:40 MST 2004 John Fleck <jfleck@inkstain.net>

	* doc/xmllint.xml
	* doc/xmllint.1
	* doc/xmllint.html
	* doc/xmlcatalog_man.xml
	* doc/xmlcatalog.1
	* doc/xmlcatalog_man.html
	applying patch from Mike Hommey to clarify XML_CATALOG_FILES
	use
parent 33a773ff
Thu Feb 26 20:19:40 MST 2004 John Fleck <jfleck@inkstain.net>
* doc/xmllint.xml
* doc/xmllint.1
* doc/xmllint.html
* doc/xmlcatalog_man.xml
* doc/xmlcatalog.1
* doc/xmlcatalog_man.html
applying patch from Mike Hommey to clarify XML_CATALOG_FILES
use
Thu Feb 26 23:47:43 CET 2004 Daniel Veillard <daniel@veillard.com>
* Makefile.am: patch for cross-compilation to Windows from
......
......@@ -21,94 +21,94 @@
.SH NAME
xmlcatalog \- Command line tool to parse and manipulate XML or SGML catalog files.
.SH "SYNOPSIS"
.nf
\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] [\fBcatalogfile\fR]
[\fBentities\fR]
.fi
.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.
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.
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"
.TP
\fB--shell\fR \fIfilename\fR
Run a shell allowing interactive queries on catalog file \fIfilename\fR.
\fB\-\-shell\fR \fIfilename\fR
Run a shell allowing interactive queries on catalog file \fIfilename\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.
\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\&.
.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', 'delegatePublic', 'delegateSystem'amd 'rewriteURI'. \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, outputing 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.
\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', 'delegatePublic', 'delegateSystem'amd 'rewriteURI'\&. \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, outputing 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.
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--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, outputing to stdout, unless \fB--noout\fR is used.
\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, outputing to stdout, unless \fB\-\-noout\fR is used\&.
.TP
\fB--noout\fR
Save output to the named file rather than outputing to stdout.
\fB\-\-noout\fR
Save output to the named file rather than outputing to stdout\&.
.TP
\fB--sgml\fR
Uses SGML Super catalogs for --add and --del options
\fB\-\-sgml\fR
Uses SGML Super catalogs for \-\-add and \-\-del options
.TP
\fB-v\fR or \fB--verbose\fR
output debugging information.
\fB\-v\fR or \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 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\&.
.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.
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.
Execute a public identifier lookup of the catalog entry for \fI'SystemID'\fR\&. The corresponding entry will be output to the command line\&.
.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', 'delegatePublic' and 'delegateSystem'. \fI'orig'\fR is the original reference to be replaced, and \fI'replace'\fR is the URI of the replacement entity to be used.
Add an entry to the catalog file\&. \fItype\fR indicates the type of entry\&. Possible types are 'public', 'system', 'rewriteSystem', 'delegatePublic' and 'delegateSystem'\&. \fI'orig'\fR is the original reference to be replaced, and \fI'replace'\fR is the URI of the replacement entity to be used\&.
.TP
\fBdel\fR \fI'values'\fR
Remove the catalog entry corresponding to \fI'values'\fR.
Remove the catalog entry corresponding to \fI'values'\fR\&.
.TP
\fBdump\fR
Print the current catalog.
Print the current catalog\&.
.TP
\fBdebug\fR
Print debugging statements showing the steps xmlcatalog is executing.
Print debugging statements showing the steps xmlcatalog is executing\&.
.TP
\fBquiet\fR
Stop printing debugging statements.
Stop printing debugging statements\&.
.TP
\fBexit\fR
Quit the shell.
Quit the shell\&.
.SH "RETURN VALUES"
.PP
xmlcatalog's return codes provide information that can be used when calling it from scripts.
xmlcatalog's return codes provide information that can be used when calling it from scripts\&.
.PP
0: normal
......@@ -125,19 +125,24 @@ xmlcatalog's return codes provide information that can be used when calling it f
.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 pagehttp://www.xmlsoft.org/
libxml web page: \fIhttp://www.xmlsoft.org/\fR
.PP
: libxml catalog support web page:http://www.xmlsoft.org/catalog.html
libxml catalog support web page:: \fIhttp://www.xmlsoft.org/catalog.html\fR
.PP
: James Clark's SGML catalog page:http://www.jclark.com/sp/catalog.htm
James Clark's SGML catalog page:: \fIhttp://www.jclark.com/sp/catalog.htm\fR
.PP
: OASIS XML catalog specification: http://www.oasis-open.org/committees/entity/spec.html
OASIS XML catalog specification: : \fIhttp://www.oasis-open.org/committees/entity/spec.html\fR
.SH AUTHOR
John Fleck.
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xmlcatalog</title><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="id2590168"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>xmlcatalog &#8212; Command line tool to parse and manipulate <span class="acronym">XML</span> or
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>xmlcatalog</title><meta name="generator" content="DocBook XSL Stylesheets V1.61.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="id2431614"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>xmlcatalog &#8212; Command line tool to parse and manipulate <span class="acronym">XML</span> or
<span class="acronym">SGML</span> catalog files.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">xmlcatalog</tt> [[--shell] | [--create] | [--add <i class="replaceable"><tt>type</tt></i>
<i class="replaceable"><tt>orig</tt></i> <i class="replaceable"><tt>replace</tt></i>] | [--del <i class="replaceable"><tt>values</tt></i>] | [--noout] | [--verbose]] [<tt class="option"><i class="replaceable"><tt>catalogfile</tt></i></tt>] [<tt class="option"><i class="replaceable"><tt>entities</tt></i></tt>]</p></div></div><div class="refsect1" lang="en"><a name="introduction"></a><h2>Introduction</h2><p>
<span class="application">xmlcatalog</span> is a command line application
......@@ -91,7 +91,11 @@
</dd><dt><span class="term"><tt class="option">exit</tt></span></dt><dd>
Quit the shell.
</dd></dl></div></div><div class="refsect1" lang="en"><a name="return"></a><h2>Return values</h2><p><span class="application">xmlcatalog</span>'s return codes provide
information that can be used when calling it from scripts.</p><p>0: normal</p><p>1: Failed to remove an entry from the catalog</p><p>2: Failed to save to the catalog, check file permissions</p><p>3: Failed to add an entry to the catalog</p><p>4: Failed to lookup and entry in the catalog</p></div><div class="refsect1" lang="en"><h2>References</h2><p><a href="http://www.xmlsoft.org/" target="_top">libxml web page</a></p><p><a href="http://www.xmlsoft.org/catalog.html" target="_top"><span class="application">libxml</span>
information that can be used when calling it from scripts.</p><p>0: normal</p><p>1: Failed to remove an entry from the catalog</p><p>2: Failed to save to the catalog, check file permissions</p><p>3: Failed to add an entry to the catalog</p><p>4: Failed to lookup and entry in the catalog</p></div><div class="refsect1" lang="en"><h2>Catalogs</h2><p>Catalog behavior can be changed by redirecting
queries to the user's own set of catalogs. This can be done by setting the
<tt class="varname">XML_CATALOG_FILES</tt> environment variable to a list of
catalogs. An empty one should deactivate loading the default
<tt class="filename">/etc/xml/catalog</tt> default catalog.</p></div><div class="refsect1" lang="en"><h2>References</h2><p><a href="http://www.xmlsoft.org/" target="_top">libxml web page</a></p><p><a href="http://www.xmlsoft.org/catalog.html" target="_top"><span class="application">libxml</span>
catalog support web page:</a></p><p><a href="http://www.jclark.com/sp/catalog.htm" target="_top">James Clark's
<span class="acronym">SGML</span> catalog page:</a></p><p><a href="http://www.oasis-open.org/committees/entity/spec.html" target="_top"><span class="acronym">OASIS</span>
<span class="acronym">XML</span> catalog specification: </a></p></div></div></body></html>
......@@ -10,13 +10,16 @@
<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.2 of the xmlcatalog Manual.</releaseinfo>
<releaseinfo>This is release 0.3 of the xmlcatalog Manual.</releaseinfo>
</refentryinfo>
<refmeta>
......@@ -268,7 +271,14 @@ FIXME - Is my list of possible types correct? Are SGML types the same?
<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>
......
......@@ -21,195 +21,187 @@
.SH NAME
xmllint \- command line XML tool
.SH "SYNOPSIS"
.nf
\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]
[\fBxmlfile\fR]
.fi
.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]
.ad
.hy
.SH "INTRODUCTION"
.PP
The xmllint program parses one or more XML files, specified on the command line as \fIxmlfile\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.
The xmllint program parses one or more XML files, specified on the command line as \fIxmlfile\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
It is included in libxml2.
It is included in libxml2\&.
.SH "OPTIONS"
.TP
\fB--version\fR
Display the version of libxml2 used.
\fB\-\-version\fR
Display the version of libxml2 used\&.
.TP
\fB--debug\fR
Parse a file and output an annotated tree of the in-memory version of the document.
\fB\-\-debug\fR
Parse a file and output an annotated tree of the in\-memory version of the document\&.
.TP
\fB--shell\fR
Run a navigating shell. Details on available commands in shell mode are below.
\fB\-\-shell\fR
Run a navigating shell\&. Details on available commands in shell mode are below\&.
.TP
\fB--debugent\fR
Debug the entities defined in the document.
\fB\-\-debugent\fR
Debug the entities defined in the document\&.
.TP
\fB--copy\fR
Test the internal copy implementation.
\fB\-\-copy\fR
Test the internal copy implementation\&.
.TP
\fB--recover\fR
Output any parsable portions of an invalid document.
\fB\-\-recover\fR
Output any parsable portions of an invalid document\&.
.TP
\fB--noent\fR
Substitute entity values for entity references. By default, xmllint leaves entity references in place.
\fB\-\-noent\fR
Substitute entity values for entity references\&. By default, xmllint leaves entity references in place\&.
.TP
\fB--nocdata\fR
Substitute CDATA section by equivalent text nodes.
\fB\-\-nocdata\fR
Substitute CDATA section by equivalent text nodes\&.
.TP
\fB--nsclean\fR
Remove redundant namespace declarations.
\fB\-\-nsclean\fR
Remove redundant namespace declarations\&.
.TP
\fB--noout\fR
Suppress output. By default, xmllint outputs the result tree.
\fB\-\-noout\fR
Suppress output\&. By default, xmllint outputs the result tree\&.
.TP
\fB--htmlout\fR
Output results as an HTML file. This causes xmllint to output the necessary HTML tags surrounding the result tree output so the results can be displayed in a browser.
\fB\-\-htmlout\fR
Output results as an HTML file\&. This causes xmllint to output the necessary HTML tags surrounding the result tree output so the results can be displayed in a browser\&.
.TP
\fB--nowrap \fR
Do not output HTML doc wrapper.
\fB\-\-nowrap \fR
Do not output HTML doc wrapper\&.
.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, xmllint also checks to determine if the document is well-formed.
\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, xmllint also checks to determine if the document is well\-formed\&.
.TP
\fB--postvalid\fR
Validate after parsing is completed.
\fB\-\-postvalid\fR
Validate after parsing is completed\&.
.TP
\fB--dtdvalid\fR \fIURL\fR
Use the DTD specified by \fIURL\fR for validation.
\fB\-\-dtdvalid\fR \fIURL\fR
Use the DTD specified by \fIURL\fR for validation\&.
.TP
\fB--dtdvalidfpi\fR \fIFPI\fR
Use the DTD specified by the Public Identifier \fIFPI\fR for validation, note that this will require a Catalog exporting that Public Identifier to work.
\fB\-\-dtdvalidfpi\fR \fIFPI\fR
Use the DTD specified by the Public Identifier \fIFPI\fR for validation, note that this will require a Catalog exporting that Public Identifier to work\&.
.TP
\fB--timing\fR
Output information about the time it takes xmllint to perform the various steps.
\fB\-\-timing\fR
Output information about the time it takes xmllint to perform the various steps\&.
.TP
\fB--repeat\fR
Repeat 100 times, for timing or profiling.
\fB\-\-repeat\fR
Repeat 100 times, for timing or profiling\&.
.TP
\fB--insert\fR
Test for valid insertions.
\fB\-\-insert\fR
Test for valid insertions\&.
.TP
\fB--compress\fR
Turn on gzip compression of output.
\fB\-\-compress\fR
Turn on gzip compression of output\&.
.TP
\fB--html\fR
Use the HTML parser.
\fB\-\-html\fR
Use the HTML parser\&.
.TP
\fB--push\fR
Use the push mode of the parser.
\fB\-\-push\fR
Use the push mode of the parser\&.
.TP
\fB--memory\fR
Parse from memory.
\fB\-\-memory\fR
Parse from memory\&.
.TP
\fB--nowarning\fR
Do not emit warnings from the parser and/or validator.
\fB\-\-nowarning\fR
Do not emit warnings from the parser and/or validator\&.
.TP
\fB--noblanks\fR
Drop ignorable blank spaces.
\fB\-\-noblanks\fR
Drop ignorable blank spaces\&.
.TP
\fB--format\fR
Reformat and reindent the output. The $XMLLINT_INDENT environment variable controls the indentation (default value is two spaces " ").
\fB\-\-format\fR
Reformat and reindent the output\&. The $XMLLINT_INDENT environment variable controls the indentation (default value is two spaces " ")\&.
.TP
\fB--testIO\fR
Test user input/output support.
\fB\-\-testIO\fR
Test user input/output support\&.
.TP
\fB--encode\fR \fIencoding\fR
Output in the given encoding.
\fB\-\-encode\fR \fIencoding\fR
Output in the given encoding\&.
.TP
\fB--catalogs\fR
Use the catalogs from $SGML_CATALOG_FILES. Otherwise /etc/xml/catalog is used by default.
\fB\-\-catalogs\fR
Use the catalogs from $SGML_CATALOG_FILES\&. Otherwise /etc/xml/catalog is used by default\&.
.TP
\fB--nocatalogs\fR
Do not use any catalogs.
\fB\-\-nocatalogs\fR
Do not use any catalogs\&.
.TP
\fB--auto\fR
Generate a small document for testing purposes.
\fB\-\-auto\fR
Generate a small document for testing purposes\&.
.TP
\fB--xinclude\fR
Do XInclude processing.
\fB\-\-xinclude\fR
Do XInclude processing\&.
.TP
\fB--loaddtd\fR
Fetch external DTD.
\fB\-\-loaddtd\fR
Fetch external DTD\&.
.TP
\fB--dtdattr\fR
Fetch external DTD and populate the tree with inherited attributes.
\fB\-\-dtdattr\fR
Fetch external DTD and populate the tree with inherited attributes\&.
.TP
\fB--dropdtd\fR
Remove DTD from output.
\fB\-\-dropdtd\fR
Remove DTD from output\&.
.TP
\fB--stream\fR
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.
\fB\-\-stream\fR
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--chkregister\fR
Turn on node registration. Useful for developeres testing libxml2 node tracking code.
\fB\-\-chkregister\fR
Turn on node registration\&. Useful for developeres testing libxml2 node tracking code\&.
.TP
\fB--relaxng\fR \fIschema\fR
Use RelaxNG file named \fIschema\fR for validation.
\fB\-\-relaxng\fR \fIschema\fR
Use RelaxNG file named \fIschema\fR for validation\&.
.TP
\fB--schema\fR \fIschema\fR
Use a W3C XML Schema file named \fIschema\fR for validation.
\fB\-\-schema\fR \fIschema\fR
Use a W3C XML Schema file named \fIschema\fR for validation\&.
.TP
\fB--nonet\fR
Do not use the Internet to fetch DTD's or entities.
\fB\-\-nonet\fR
Do not use the Internet to fetch DTD's or entities\&.
.SH "SHELL"
.PP
xmllint offers an interactive shell mode invoked with the \fB--shell\fR command. Available commands in shell mode include:
xmllint offers an interactive shell mode invoked with the \fB\-\-shell\fR command\&. Available commands in shell mode include:
.TP
\fBbase\fR
......@@ -220,65 +212,70 @@ display XML base of the node
leave shell
.TP
\fBcat node\fR
Display node if given or current node.
\fBcat \fInode\fR\fR
Display node if given or current node\&.
.TP
\fBcd path\fR
Change the current node to \fIpath\fR (if given and unique) or root if no argument given.
\fBcd \fIpath\fR\fR
Change the current node to \fIpath\fR (if given and unique) or root if no argument given\&.
.TP
\fBdir path\fR
Dumps information about the node (namespace, attributes, content).
\fBdir \fIpath\fR\fR
Dumps information about the node (namespace, attributes, content)\&.
.TP
\fBdu path\fR
Show the structure of the subtree under path or the current node.
\fBdu \fIpath\fR\fR
Show the structure of the subtree under 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 name\fR
Load a new document with the given name.
\fBload \fIname\fR\fR
Load a new document with the given name\&.
.TP
\fBls path\fR
List contents of \fIpath\fR (if given) or the current directory.
\fBls \fIpath\fR\fR
List contents of \fIpath\fR (if given) 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 name\fR
Saves the current document to \fIname\fR if given or to the original name.
\fBsave \fIname\fR\fR
Saves the current document to \fIname\fR if given or to the original name\&.
.TP
\fBvalidate\fR
Check the document for error.
Check the document for error\&.
.TP
\fBwrite name\fR
Write the current node to the given filename.
\fBwrite \fIname\fR\fR
Write the current node to the given filename\&.
.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 "DEBUGGING CATALOGS"
.PP
Setting the environment variable \fIXML_DEBUG_CATALOG\fR using the command \fB"export XML_DEBUG_CATALOG="\fR outputs debugging information related to catalog operations.
Setting the environment variable \fIXML_DEBUG_CATALOG\fR using the command \fB"export XML_DEBUG_CATALOG="\fR outputs debugging information related to catalog operations\&.
.SH AUTHORS
John Fleck, Ziying Sherwin, Heiko Rupp.
<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.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="id2589902"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>xmllint &#8212; 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] | [--htmlout] | [--nowrap] | [--valid] | [--postvalid] | [--dtdvalid <i class="replaceable"><tt>URL</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="id2431614"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>xmllint &#8212; 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>
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
......@@ -26,6 +26,10 @@
Substitute entity values for entity
references. By default, <span class="application">xmllint</span> leaves entity
references in place.
</dd><dt><span class="term"><tt class="option">--nocdata</tt></span></dt><dd>
Substitute CDATA section by equivalent text nodes.
</dd><dt><span class="term"><tt class="option">--nsclean</tt></span></dt><dd>
Remove redundant namespace declarations.
</dd><dt><span class="term"><tt class="option">--noout</tt></span></dt><dd>
Suppress output. By default,
<span class="application">xmllint</span> outputs the result tree.
......@@ -49,6 +53,11 @@
Use the
<span class="acronym">DTD</span> specified by <i class="replaceable"><tt>URL</tt></i> for
validation.
</dd><dt><span class="term"> <tt class="option">--dtdvalidfpi</tt> <i class="replaceable"><tt>FPI</tt></i></span></dt><dd>
Use the
<span class="acronym">DTD</span> specified by the Public Identifier
<i class="replaceable"><tt>FPI</tt></i> for validation, note that this
will require a Catalog exporting that Public Identifier to work.
</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.
......@@ -135,6 +144,10 @@
Check the document for error.
</dd><dt><span class="term"><tt class="option">write <i class="replaceable"><tt>name</tt></i></tt></span></dt><dd>
Write the current node to the given filename.
</dd></dl></div></div><div class="refsect1" lang="en"><h2>Debugging Catalogs</h2><p>Setting the environment variable <tt class="varname">XML_DEBUG_CATALOG</tt>
</dd></dl></div></div><div class="refsect1" lang="en"><h2>Catalogs</h2><p>Catalog behavior can be changed by redirecting
queries to the user's own set of catalogs. This can be done by setting the
<tt class="varname">XML_CATALOG_FILES</tt> environment variable to a list of
catalogs. An empty one should deactivate loading the default
<tt class="filename">/etc/xml/catalog</tt> default catalog.</p></div><div class="refsect1" lang="en"><h2>Debugging Catalogs</h2><p>Setting the environment variable <tt class="varname">XML_DEBUG_CATALOG</tt>
using the command <b class="command">"export XML_DEBUG_CATALOG="</b>
outputs debugging information related to catalog operations.</p></div></div></body></html>
......@@ -10,6 +10,9 @@
<copyright>
<year>2001</year>
</copyright>
<copyright>
<year>2004</year>
</copyright>
<author>
<firstname>John</firstname>
<surname>Fleck</surname>
......@@ -26,7 +29,7 @@
</author>
<address><email>hwr@pilhuhn.de</email></address>
<releaseinfo>This is release 0.2 of the xmllint Manual.</releaseinfo>
<releaseinfo>This is release 0.3 of the xmllint Manual.</releaseinfo>
</refentryinfo>
<refmeta>
......@@ -623,6 +626,14 @@
</variablelist>
</refsect1>
<refsect1>
</