diff options
author | Mike Hommey <glandium@debian.org> | 2006-02-20 18:24:34 +0100 |
---|---|---|
committer | Mike Hommey <glandium@debian.org> | 2006-02-20 18:24:34 +0100 |
commit | 0f9c33ecd8dc478e31624824a1e3a19e156f5a8b (patch) | |
tree | a9188c8d99a06a5be10896c19b7f42ba63540860 | |
parent | 389359bb8e2ef568a183a5c5ad5a296dd2ad148b (diff) | |
download | libxml2-0f9c33ecd8dc478e31624824a1e3a19e156f5a8b.tar.gz |
* debian/control: Removed python2.2-libxml2 and build-dep on python2.2-dev.debian/2.6.23.dfsg.2-2
Closes: #351125.
* doc/xmllint.xml, doc/xmllint.1: Applied patch from upstream cvs. That
improves the manual page by many ways.
* doc/xmllint.html: Manually updated with changes from the .xml file.
* xmllint.c: Don't throw error when failed to load an entity through --path
option of xmllint (patch from upstream cvs). Closes: #352634.
Thanks Daniel Leidert.
-rw-r--r-- | debian/changelog | 13 | ||||
-rw-r--r-- | debian/control | 17 | ||||
-rw-r--r-- | doc/xmllint.1 | 301 | ||||
-rw-r--r-- | doc/xmllint.html | 320 | ||||
-rw-r--r-- | doc/xmllint.xml | 1387 | ||||
-rw-r--r-- | xmllint.c | 9 |
6 files changed, 1056 insertions, 991 deletions
diff --git a/debian/changelog b/debian/changelog index adeab96..3d4f2f6 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,16 @@ +libxml2 (2.6.23.dfsg.2-2) unstable; urgency=low + + * debian/control: Removed python2.2-libxml2 and build-dep on python2.2-dev. + Closes: #351125. + * doc/xmllint.xml, doc/xmllint.1: Applied patch from upstream cvs. That + improves the manual page by many ways. + * doc/xmllint.html: Manually updated with changes from the .xml file. + * xmllint.c: Don't throw error when failed to load an entity through --path + option of xmllint (patch from upstream cvs). Closes: #352634. + Thanks Daniel Leidert. + + -- Mike Hommey <glandium@debian.org> Mon, 20 Feb 2006 10:52:46 +0100 + libxml2 (2.6.23.dfsg.2-1) unstable; urgency=low * result/, test/: Totally removed. There is more suspicious content than diff --git a/debian/control b/debian/control index 02cdb9f..e22af8d 100644 --- a/debian/control +++ b/debian/control @@ -4,7 +4,7 @@ Section: libs Maintainer: Debian XML/SGML Group <debian-xml-sgml-pkgs@lists.alioth.debian.org> Uploaders: Mike Hommey <glandium@debian.org> Standards-Version: 3.6.2.1 -Build-Depends: debhelper (>= 5.0.0), zlib1g-dev | libz-dev, python, python2.4-dev, python2.3-dev, python2.2-dev, autotools-dev, libreadline5-dev | libreadline-dev, binutils (>= 2.14.90.0.7) +Build-Depends: debhelper (>= 5.0.0), zlib1g-dev | libz-dev, python, python2.4-dev, python2.3-dev, autotools-dev, libreadline5-dev | libreadline-dev, binutils (>= 2.14.90.0.7) Package: libxml2 Architecture: any @@ -124,18 +124,3 @@ Description: Python 2.3 bindings for the GNOME XML library . This package contains the files needed to use the GNOME XML library in Python programs. - -Package: python2.2-libxml2 -Architecture: any -Section: python -Depends: ${shlibs:Depends}, ${misc:Depends}, python2.2 -Description: Python 2.2 bindings for the GNOME XML library - XML is a metalanguage to let you design your own markup language. - A regular markup language defines a way to describe information in - a certain class of documents (eg HTML). XML lets you define your - own customized markup languages for many classes of document. It - can do this because it's written in SGML, the international standard - metalanguage for markup languages. - . - This package contains the files needed to use the GNOME XML library - in Python programs. diff --git a/doc/xmllint.1 b/doc/xmllint.1 index db24d61..ea41aec 100644 --- a/doc/xmllint.1 +++ b/doc/xmllint.1 @@ -17,251 +17,264 @@ .el .ne 3 .IP "\\$1" \\$2 .. -.TH "XMLLINT" 1 "" "" "xmllint Manual" +.TH "XMLLINT" 1 "2006-02-20" "libxml2" "xmllint Manual" .SH NAME xmllint \- command line XML tool .SH "SYNOPSIS" .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\-\-noout\fR | \fB\-\-nonet\fR | \fB\-\-path\ \fIpaths\fR\fR | \fB\-\-load\-trace\fR | \fB\-\-htmlout\fR | \fB\-\-nowrap\fR | \fB\-\-valid\fR | \fB\-\-postvalid\fR | \fB\-\-dtdvalid\ \fIURL\fR\fR | \fB\-\-dtdvalidfpi\ \fIFPI\fR\fR | \fB\-\-timing\fR | \fB\-\-output\ \fIfile\fR\fR | \fB\-\-repeat\fR | \fB\-\-insert\fR | \fB\-\-compress\fR | \fB\-\-html\fR | \fB\-\-xmlout\fR | \fB\-\-push\fR | \fB\-\-memory\fR | \fB\-\-maxmem\ \fInbbytes\fR\fR | \fB\-\-nowarning\fR | \fB\-\-noblanks\fR | \fB\-\-nocdata\fR | \fB\-\-format\fR | \fB\-\-encode\ \fIencoding\fR\fR | \fB\-\-dropdtd\fR | \fB\-\-nsclean\fR | \fB\-\-testIO\fR | \fB\-\-catalogs\fR | \fB\-\-nocatalogs\fR | \fB\-\-auto\fR | \fB\-\-xinclude\fR | \fB\-\-noxincludenode\fR | \fB\-\-loaddtd\fR | \fB\-\-dtdattr\fR | \fB\-\-stream\fR | \fB\-\-walker\fR | \fB\-\-pattern\ \fIpatternvalue\fR\fR | \fB\-\-chkregister\fR | \fB\-\-relaxng\fR | \fB\-\-schema\fR | \fB\-\-c14n\fR] [\fB\fIxmlfile\fR\fR] +\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 +.HP 8 +\fBxmllint\fR \fB\-\-help\fR .ad .hy -.SH "INTRODUCTION" +.SH "DESCRIPTION" .PP -The xmllint program parses one or more XML files, specified on the command line as \fIxmlfile\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 \- )\&. 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\&. +\fBxmllint\fR is included in libxml2\&. .SH "OPTIONS" +.PP +\fBxmllint\fR accepts the following options (in alphabetical order): + .TP -\fB\-\-version\fR -Display the version of libxml2 used\&. +\fB\-\-auto\fR +Generate a small document for testing purposes\&. .TP -\fB\-\-debug\fR -Parse a file and output an annotated tree of the in\-memory version of the document\&. +\fB\-\-catalogs\fR +Use the catalogs from \fBSGML_CATALOG_FILES\fR\&. Otherwise \fI/etc/xml/catalog\fR is used by default\&. .TP -\fB\-\-shell\fR -Run a navigating shell\&. Details on available commands in shell mode are below\&. +\fB\-\-chkregister\fR +Turn on node registration\&. Useful for developers testing libxml2 node tracking code\&. .TP -\fB\-\-debugent\fR -Debug the entities defined in the document\&. +\fB\-\-compress\fR +Turn on gzip compression of output\&. .TP \fB\-\-copy\fR Test the internal copy implementation\&. .TP -\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\-\-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\-\-nocdata\fR -Substitute CDATA section by equivalent text nodes\&. +\fB\-\-dtdvalid \fIURL\fR\fR +Use the DTD specified by an \fIURL\fR for validation\&. .TP -\fB\-\-nsclean\fR -Remove redundant namespace declarations\&. +\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\&. .TP -\fB\-\-noout\fR -Suppress output\&. By default, xmllint outputs the result tree\&. +\fB\-\-debug\fR +Parse a file and output an annotated tree of the in\-memory version of the document\&. .TP -\fB\-\-nonet\fR -Do not use the Internet to fetch DTD's or entities\&. +\fB\-\-debugent\fR +Debug the entities defined in the document\&. .TP -\fB\-\-path\fR \fIpaths\fR -Use the list (separated by space or column) of filesystem path specified by \fIpaths\fR to load DTDs or entities \&. +\fB\-\-dropdtd\fR +Remove DTD from output\&. .TP -\fB\-\-load\-trace\fR -Display to stderr all the documents loaded during the processing\&. +\fB\-\-dtdattr\fR +Fetch external DTD and populate the tree with inherited attributes\&. .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\-\-encode \fIENCODING\fR\fR +Output in the given encoding\&. .TP -\fB\-\-nowrap \fR -Do not output HTML doc wrapper\&. +\fB\-\-format\fR +Reformat and reindent the output\&. The \fBXMLLINT_INDENT\fR environment variable controls the indentation (default value is two spaces " ")\&. .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\-\-help\fR +Print out a short usage summary for \fBxmllint\fR\&. .TP -\fB\-\-postvalid\fR -Validate after parsing is completed\&. +\fB\-\-html\fR +Use the HTML parser\&. .TP -\fB\-\-dtdvalid\fR \fIURL\fR -Use the DTD specified by \fIURL\fR for validation\&. +\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\&. .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\-\-insert\fR +Test for valid insertions\&. .TP -\fB\-\-timing\fR -Output information about the time it takes xmllint to perform the various steps\&. +\fB\-\-loaddtd\fR +Fetch external DTD\&. .TP -\fB\-\-output\fR \fIfile\fR -Define a file path where xmllint will save the result of parsing\&. Usually the programs build a tree and save it on stdout, with this option the result XML instance will be saved onto a file\&. +\fB\-\-load\-trace\fR +Display all the documents loaded during the processing to \fIstderr\fR\&. .TP -\fB\-\-repeat\fR -Repeat 100 times, for timing or profiling\&. +\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\&. .TP -\fB\-\-insert\fR -Test for valid insertions\&. +\fB\-\-memory\fR +Parse from memory\&. .TP -\fB\-\-compress\fR -Turn on gzip compression of output\&. +\fB\-\-noblanks\fR +Drop ignorable blank spaces\&. .TP -\fB\-\-html\fR -Use the HTML parser\&. +\fB\-\-nocatalogs\fR +Do not use any catalogs\&. .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\&. +\fB\-\-nocdata\fR +Substitute CDATA section by equivalent text nodes\&. .TP -\fB\-\-push\fR -Use the push mode of the parser\&. +\fB\-\-noent\fR +Substitute entity values for entity references\&. By default, \fBxmllint\fR leaves entity references in place\&. .TP -\fB\-\-memory\fR -Parse from memory\&. +\fB\-\-nonet\fR +Do not use the Internet to fetch DTDs or entities\&. .TP -\fB\-\-maxmem\fR \fInnbytes\fR -Test the parser memory support\&. \fInnbytes\fR is the maximum number of bytes the library is allowed to allocate\&. This can also be used to make sure batch processing of XML files will not exhaust the virtual memory of the server running them\&. +\fB\-\-noout\fR +Suppress output\&. By default, \fBxmllint\fR outputs the result tree\&. .TP \fB\-\-nowarning\fR Do not emit warnings from the parser and/or validator\&. .TP -\fB\-\-noblanks\fR -Drop ignorable blank spaces\&. +\fB\-\-nowrap\fR +Do not output HTML doc wrapper\&. .TP -\fB\-\-format\fR -Reformat and reindent the output\&. The $XMLLINT_INDENT environment variable controls the indentation (default value is two spaces " ")\&. +\fB\-\-noxincludenode\fR +Do XInclude processing but do not generate XInclude start and end nodes\&. .TP -\fB\-\-testIO\fR -Test user input/output support\&. +\fB\-\-nsclean\fR +Remove redundant namespace declarations\&. .TP -\fB\-\-encode\fR \fIencoding\fR -Output in the given encoding\&. +\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\&. .TP -\fB\-\-catalogs\fR -Use the catalogs from $SGML_CATALOG_FILES\&. Otherwise /etc/xml/catalog is used by default\&. +\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\&. .TP -\fB\-\-nocatalogs\fR -Do not use any catalogs\&. +\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\&. .TP -\fB\-\-auto\fR -Generate a small document for testing purposes\&. +\fB\-\-postvalid\fR +Validate after parsing is completed\&. .TP -\fB\-\-xinclude\fR -Do XInclude processing\&. +\fB\-\-push\fR +Use the push mode of the parser\&. .TP -\fB\-\-noxincludenode\fR -Do XInclude processing but do not generate XInclude start and end nodes\&. +\fB\-\-recover\fR +Output any parsable portions of an invalid document\&. .TP -\fB\-\-loaddtd\fR -Fetch external DTD\&. +\fB\-\-relaxng \fISCHEMA\fR\fR +Use RelaxNG file named \fISCHEMA\fR for validation\&. .TP -\fB\-\-dtdattr\fR -Fetch external DTD and populate the tree with inherited attributes\&. +\fB\-\-repeat\fR +Repeat 100 times, for timing or profiling\&. .TP -\fB\-\-dropdtd\fR -Remove DTD from output\&. +\fB\-\-schema \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)\&. .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\&. +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\-\-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\&. +\fB\-\-testIO\fR +Test user input/output support\&. .TP -\fB\-\-chkregister\fR -Turn on node registration\&. Useful for developers testing libxml2 node tracking code\&. +\fB\-\-timing\fR +Output information about the time it takes \fBxmllint\fR to perform the various steps\&. .TP -\fB\-\-pattern\fR \fIpatternvalue\fR -Used to exercise the pattern recognition engine, which can be used with the reader interface to the parser\&. It allows to select some nodes in the document based on an XPath (subset) expression\&. Used for debugging\&. +\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\&. + +.TP +\fB\-\-version\fR +Display the version of libxml2 used\&. .TP -\fB\-\-relaxng\fR \fIschema\fR -Use RelaxNG file named \fIschema\fR for validation\&. +\fB\-\-walker\fR +Test the walker module, which is a reader interface but for a document tree, instead of using the reader API on an unparsed document it works on a existing in\-memory tree\&. Used in debugging\&. .TP -\fB\-\-schema\fR \fIschema\fR -Use a W3C XML Schema file named \fIschema\fR for validation\&. +\fB\-\-xinclude\fR +Do XInclude processing\&. .TP -\fB\-\-c14n\fR -Use the W3C XML Canonicalisation (C14N) to serialize the result of parsing to stdout\&. It keeps comments in the result\&. +\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\&. -.SH "SHELL" +.SH "SHELL COMMANDS" .PP - xmllint offers an interactive shell mode invoked with the \fB\-\-shell\fR command\&. Available commands in shell mode include: +\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 shell +Leave the shell\&. .TP -\fBcat \fInode\fR\fR -Display node if given or current node\&. +\fBcat \fINODE\fR\fR +Display the given node or the current one\&. .TP -\fBcd \fIpath\fR\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 the given path (if unique) or root if no argument is given\&. .TP -\fBdir \fIpath\fR\fR +\fBdir \fIPATH\fR\fR Dumps information about the node (namespace, attributes, content)\&. .TP -\fBdu \fIpath\fR\fR -Show the structure of the subtree under path or the current node\&. +\fBdu \fIPATH\fR\fR +Show the structure of the subtree under the given path or the current node\&. .TP \fBexit\fR @@ -276,12 +289,12 @@ Show this help\&. Display memory usage\&. .TP -\fBload \fIname\fR\fR -Load a new document with the given name\&. +\fBload \fIFILENAME\fR\fR +Load a new document with the given filename\&. .TP -\fBls \fIpath\fR\fR -List contents of \fIpath\fR (if given) or the current directory\&. +\fBls \fIPATH\fR\fR +List contents of the given path or the current directory\&. .TP \fBpwd\fR @@ -292,71 +305,79 @@ Display the path to the current node\&. Leave the shell\&. .TP -\fBsave \fIname\fR\fR -Saves the current document to \fIname\fR if given or to the original name\&. +\fBsave \fIFILENAME\fR\fR +Save the current document to the given filename or to the original name\&. .TP \fBvalidate\fR -Check the document for error\&. +Check the document for errors\&. .TP -\fBwrite \fIname\fR\fR +\fBwrite \fIFILENAME\fR\fR Write the current node to the given filename\&. -.SH "CATALOGS" +.SH "ENVIRONMENT" -.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\&. +.TP +\fBSGML_CATALOG_FILES\fR +\&.\&.\&. -.SH "DEBUGGING CATALOGS" +.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\&. -.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\&. +.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\&. + +.TP +\fBXMLLINT_INDENT\fR +\&.\&.\&. -.SH "ERROR RETURN CODES" +.SH "DIAGNOSTICS" .PP -On the completion of execution, Xmllint returns the following error codes: +On the completion of execution, \fBxmllint\fR returns the following error codes: .TP -0 +\fB0\fR No error .TP -1 +\fB1\fR Unclassified .TP -2 +\fB2\fR Error in DTD .TP -3 +\fB3\fR Validation error .TP -4 +\fB4\fR Validation error .TP -5 +\fB5\fR Error in schema compilation .TP -6 +\fB6\fR Error writing output .TP -7 -Error in pattern (generated when [\-\-pattern] option is used) +\fB7\fR +Error in pattern (generated when \fB\-\-pattern\fR option is used) .TP -8 -Error in Reader registration (generated when [\-\-chkregister] option is used) +\fB8\fR +Error in Reader registration (generated when \fB\-\-chkregister\fR option is used) .TP -9 +\fB9\fR Out of memory error .SH AUTHORS -John Fleck, Ziying Sherwin, Heiko Rupp. +John Fleck <jfleck@inkstain\&.net>, Ziying Sherwin <sherwin@nlm\&.nih\&.gov>, Heiko Rupp <hwr@pilhuhn\&.de>. diff --git a/doc/xmllint.html b/doc/xmllint.html index 0a55877..8bca279 100644 --- a/doc/xmllint.html +++ b/doc/xmllint.html @@ -1,175 +1,145 @@ -<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="id2876302"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>xmllint — command line <span class="acronym">XML</span> tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">xmllint</tt> [[--version] | [--debug] | [--shell] | [--debugent] | [--copy] | [--recover] | [--noent] | [--noout] | [--nonet] | [--htmlout] | [--nowrap] | [--valid] | [--postvalid] | [--dtdvalid <i class="replaceable"><tt>URL</tt></i>] | [--dtdvalidfpi <i class="replaceable"><tt>FPI</tt></i>] | [--timing] | [--output <i class="replaceable"><tt>file</tt></i>] | [--repeat] | [--insert] | [--compress] | [--html] | [--xmlout] | [--push] | [--memory] | [--maxmem <i class="replaceable"><tt>nbbytes</tt></i>] | [--nowarning] | [--noblanks] | [--nocdata] | [--format] | [--encode <i class="replaceable"><tt>encoding</tt></i>] | [--dropdtd] | [--nsclean] | [--testIO] | [--catalogs] | [--nocatalogs] | [--auto] | [--xinclude] | [--noxincludenode] | [--loaddtd] | [--dtdattr] | [--stream] | [--walker] | [--pattern <i class="replaceable"><tt>patternvalue</tt></i>] | [--chkregister] | [--relaxng] | [--schema] | [--c14n]] [<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 - detecting errors both in <span class="acronym">XML</span> code and in the - <span class="acronym">XML</span> parser itself. - </p><p> - It is included in <span class="application">libxml2</span>. - </p></div><div class="refsect1" lang="en"><a name="options"></a><h2>Options</h2><div class="variablelist"><dl><dt><span class="term"><tt class="option">--version</tt></span></dt><dd> - Display the version of - <span class="application">libxml2</span> used. - </dd><dt><span class="term"><tt class="option">--debug</tt></span></dt><dd> - Parse a file and output an annotated tree of the - in-memory version of the document. - </dd><dt><span class="term"><tt class="option">--shell</tt></span></dt><dd> - Run a navigating shell. Details on available commands in shell mode - are below. - </dd><dt><span class="term"><tt class="option">--debugent</tt></span></dt><dd> - Debug the entities defined in the document. - </dd><dt><span class="term"><tt class="option">--copy</tt> </span></dt><dd> - Test the internal copy implementation. - </dd><dt><span class="term"><tt class="option">--recover</tt></span></dt><dd> - Output any parsable portions of an invalid - document. - </dd><dt><span class="term"><tt class="option">--noent</tt></span></dt><dd> - 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. - </dd><dt><span class="term"><tt class="option">--htmlout</tt></span></dt><dd> - Output results as an <span class="acronym">HTML</span> - file. This causes <span class="application">xmllint</span> to output - the necessary <span class="acronym">HTML</span> tags surrounding the result tree - output so the results can be displayed in a browser. - </dd><dt><span class="term"><tt class="option">--nowrap </tt></span></dt><dd> - Do not output HTML doc wrapper. - </dd><dt><span class="term"><tt class="option">--valid </tt></span></dt><dd> - Determine if the document is a valid instance - of the included Document Type Definition (<span class="acronym">DTD</span>). A - <span class="acronym">DTD</span> to be validated against also can be specified at - the command line using the <tt class="option">--dtdvalid</tt> option. By default, - <span class="application">xmllint</span> also checks to determine if the - document is well-formed. - </dd><dt><span class="term"><tt class="option">--postvalid</tt></span></dt><dd> - Validate after parsing is completed. - </dd><dt><span class="term"> <tt class="option">--dtdvalid</tt> <i class="replaceable"><tt>URL</tt></i></span></dt><dd> - 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. - </dd><dt><span class="term"><tt class="option">--output</tt> <i class="replaceable"><tt>file</tt></i></span></dt><dd>Define a file path where xmllint will save the result of - parsing. Usually the programs build a tree and save it on stdout, with - this option the result XML instance will be saved onto a file.</dd><dt><span class="term"><tt class="option">--repeat</tt></span></dt><dd> - Repeat 100 times, for timing or profiling. - </dd><dt><span class="term"><tt class="option">--insert</tt></span></dt><dd> - Test for valid insertions. - </dd><dt><span class="term"><tt class="option">--compress</tt></span></dt><dd> - Turn on gzip compression of output. - </dd><dt><span class="term"><tt class="option">--html</tt></span></dt><dd> - Use the <span class="acronym">HTML</span> parser. - </dd><dt><span class="term"><tt class="option">--xmlout</tt></span></dt><dd>Used in conjunction with <tt class="option">--html</tt>. Usually - when HTML is parsed the document is saved with the HTML serializer, but with - this option the resulting document is saved with the XML serializer. This is - primarily used to generate XHTML from HTML input.</dd><dt><span class="term"><tt class="option">--push</tt></span></dt><dd> - Use the push mode of the parser. - </dd><dt><span class="term"><tt class="option">--memory</tt></span></dt><dd> - Parse from memory. - </dd><dt><span class="term"><tt class="option">--maxmem</tt> <i class="replaceable"><tt>nnbytes</tt></i></span></dt><dd>Test the parser memory - support. <i class="replaceable"><tt>nnbytes</tt></i> is the maximum number of bytes the - library is allowed to allocate. This can also be used to make sure batch - processing of XML files will not exhaust the virtual memory of the server - running them.</dd><dt><span class="term"><tt class="option">--nowarning</tt></span></dt><dd> - Do not emit warnings from the parser and/or validator. - </dd><dt><span class="term"><tt class="option">--noblanks</tt></span></dt><dd> - Drop ignorable blank spaces. - </dd><dt><span class="term"><tt class="option">--format</tt></span></dt><dd> - Reformat and reindent the output. The $XMLLINT_INDENT - environment variable controls the indentation (default - value is two spaces " "). - </dd><dt><span class="term"><tt class="option">--testIO</tt></span></dt><dd> - Test user input/output support. - </dd><dt><span class="term"><tt class="option">--encode</tt> <i class="replaceable"><tt>encoding</tt></i></span></dt><dd> - Output in the given encoding. - </dd><dt><span class="term"><tt class="option">--catalogs</tt></span></dt><dd> - Use the catalogs from $SGML_CATALOG_FILES. Otherwise /etc/xml/catalog - is used by default. - </dd><dt><span class="term"><tt class="option">--nocatalogs</tt></span></dt><dd> - Do not use any catalogs. - </dd><dt><span class="term"><tt class="option">--auto</tt></span></dt><dd> - Generate a small document for testing purposes. - </dd><dt><span class="term"><tt class="option">--xinclude</tt></span></dt><dd> - Do XInclude processing. - </dd><dt><span class="term"><tt class="option">--noxincludenode</tt></span></dt><dd> - Do XInclude processing but do not generate XInclude start and end - nodes. - </dd><dt><span class="term"><tt class="option">--loaddtd</tt></span></dt><dd> - Fetch external DTD. - </dd><dt><span class="term"><tt class="option">--dtdattr</tt></span></dt><dd> - Fetch external DTD and populate the tree with inherited attributes. - </dd><dt><span class="term"><tt class="option">--dropdtd</tt></span></dt><dd> - Remove <span class="acronym">DTD</span> from output. - </dd><dt><span class="term"><tt class="option">--stream</tt></span></dt><dd>Use streaming API - useful when used in combination with - --relaxng or --valid options for validation of files that are - too large to be held in memory.</dd><dt><span class="term"><tt class="option">--walker</tt></span></dt><dd>Test the walker module, which is a reader interface but for a - document tree, instead of using the reader API on an unparsed document it - works on a existing in-memory tree. Used in debugging.</dd><dt><span class="term"><tt class="option">--chkregister</tt></span></dt><dd>Turn on node registration. Useful for developers testing - libxml2 node tracking code.</dd><dt><span class="term"><tt class="option">--pattern</tt> <i class="replaceable"><tt>patternvalue</tt></i></span></dt><dd>Used to exercise the pattern recognition engine, which can be - used with the reader interface to the parser. It allows to select some - nodes in the document based on an XPath (subset) expression. Used for - debugging.</dd><dt><span class="term"><tt class="option">--relaxng</tt> <i class="replaceable"><tt>schema</tt></i></span></dt><dd>Use RelaxNG file named <i class="replaceable"><tt>schema</tt></i> for - validation.</dd><dt><span class="term"><tt class="option">--schema</tt> <i class="replaceable"><tt>schema</tt></i></span></dt><dd>Use a W3C XML Schema file named <i class="replaceable"><tt>schema</tt></i> for validation.</dd><dt><span class="term"> - <tt class="option">--c14n</tt></span></dt><dd>Use the W3C XML Canonicalisation (C14N) to -serialize the result of parsing to stdout. It keeps comments in -the result.</dd></dl></div></div><div class="refsect1" lang="en"><a name="shell"></a><h2>Shell</h2><p> - <span class="application">xmllint</span> offers an interactive shell mode - invoked with the <tt class="option">--shell</tt> command. Available commands in - shell mode include: - </p><div class="variablelist"><dl><dt><span class="term"><tt class="option">base</tt></span></dt><dd> - display XML base of the node - </dd><dt><span class="term"><tt class="option">bye</tt></span></dt><dd> - leave shell - </dd><dt><span class="term"><tt class="option">cat <i class="replaceable"><tt>node</tt></i></tt></span></dt><dd> - Display node if given or current node. - </dd><dt><span class="term"><tt class="option">cd <i class="replaceable"><tt>path</tt></i></tt></span></dt><dd> - Change the current node to <i class="replaceable"><tt>path</tt></i> (if given - and unique) or root if no argument given. - </dd><dt><span class="term"><tt class="option">dir <i class="replaceable"><tt>path</tt></i></tt></span></dt><dd> - Dumps information about the node (namespace, attributes, content). - </dd><dt><span class="term"><tt class="option">du <i class="replaceable"><tt>path</tt></i></tt></span></dt><dd> - Show the structure of the subtree under path or the current node. - </dd><dt><span class="term"><tt class="option">exit</tt></span></dt><dd> - Leave the shell. - </dd><dt><span class="term"><tt class="option">help</tt></span></dt><dd> - Show this help. - </dd><dt><span class="term"><tt class="option">free</tt></span></dt><dd> - Display memory usage. - </dd><dt><span class="term"><tt class="option">load <i class="replaceable"><tt>name</tt></i></tt></span></dt><dd> - Load a new document with the given name. - </dd><dt><span class="term"><tt class="option">ls <i class="replaceable"><tt>path</tt></i></tt></span></dt><dd> - List contents of <i class="replaceable"><tt>path</tt></i> (if given) or the - current directory. - </dd><dt><span class="term"><tt class="option">pwd</tt></span></dt><dd> - Display the path to the current node. - </dd><dt><span class="term"><tt class="option">quit</tt></span></dt><dd> - Leave the shell. - </dd><dt><span class="term"><tt class="option">save <i class="replaceable"><tt>name</tt></i></tt></span></dt><dd> - Saves the current document to <i class="replaceable"><tt>name</tt></i> if - given or to the original name. - </dd><dt><span class="term"><tt class="option">validate</tt></span></dt><dd> - 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>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 class="refsect1" lang="en"><h2>Error Return Codes</h2><p>On the completion of execution, <span class="application">Xmllint</span> - returns the following error codes:</p><div class="variablelist"><dl><dt><span class="term">0</span></dt><dd>No error</dd><dt><span class="term">1</span></dt><dd>Unclassified</dd><dt><span class="term">2</span></dt><dd>Error in DTD</dd><dt><span class="term">3</span></dt><dd>Validation error</dd><dt><span class="term">4</span></dt><dd>Validation error</dd><dt><span class="term">5</span></dt><dd>Error in schema compilation</dd><dt><span class="term">6</span></dt><dd>Error writing output</dd><dt><span class="term">7</span></dt><dd>Error in pattern (generated when - [<span class="optional">--pattern</span>] option is used)</dd><dt><span class="term">8</span></dt><dd>Error in Reader registration (generated when - [<span class="optional">--chkregister</span>] option is used)</dd><dt><span class="term">9</span></dt><dd>Out of memory error</dd></dl></div></div></div></body></html> +<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.68.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="id2450995"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>xmllint — command line <span class="acronym">XML</span> tool</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">xmllint</code> [ <code class="option">--version</code> | <code class="option">--debug</code> | <code class="option">--shell</code> | <code class="option">--debugent</code> | <code class="option">--copy</code> | <code class="option">--recover</code> | <code class="option">--noent</code> | <code class="option">--noout</code> | <code class="option">--nonet</code> | <code class="option">--path <em class="replaceable"><code>"PATHS"</code></em></code> | <code class="option">--load-trace</code> | <code class="option">--htmlout</code> | <code class="option">--nowrap</code> | <code class="option">--valid</code> | <code class="option">--postvalid</code> | <code class="option">--dtdvalid <em class="replaceable"><code>URL</code></em></code> | <code class="option">--dtdvalidfpi <em class="replaceable"><code>FPI</code></em></code> | <code class="option">--timing</code> | <code class="option">--output <em class="replaceable"><code>FILE</code></em></code> | <code class="option">--repeat</code> | <code class="option">--insert</code> | <code class="option">--compress</code> | <code class="option">--html</code> | <code class="option">--xmlout</code> | <code class="option">--push</code> | <code class="option">--memory</code> | <code class="option">--maxmem <em class="replaceable"><code>NBBYTES</code></em></code> | <code class="option">--nowarning</code> | <code class="option">--noblanks</code> | <code class="option">--nocdata</code> | <code class="option">--format</code> | <code class="option">--encode <em class="replaceable"><code>ENCODING</code></em></code> | <code class="option">--dropdtd</code> | <code class="option">--nsclean</code> | <code class="option">--testIO</code> | <code class="option">--catalogs</code> | <code class="option">--nocatalogs</code> | <code class="option">--auto</code> | <code class="option">--xinclude</code> | <code class="option">--noxincludenode</code> | <code class="option">--loaddtd</code> | <code class="option">--dtdattr</code> | <code class="option">--stream</code> | <code class="option">--walker</code> | <code class="option">--pattern <em class="replaceable"><code>PATTERNVALUE</code></em></code> | <code class="option">--chkregister</code> | <code class="option">--relaxng <em class="replaceable"><code>SCHEMA</code></em></code> | <code class="option">--schema <em class="replaceable"><code>SCHEMA</code></em></code> | <code class="option">--c14n</code> ] { <em class="replaceable"><code>XML-FILE(S)</code></em>... | - }</p></div><div class="cmdsynopsis"><p><code class="command">xmllint</code> <code class="option">--help</code> </p></div></div><div class="refsect1" lang="en"><a name="introduction"></a><h2>DESCRIPTION</h2><p> + The <span><strong class="command">xmllint</strong></span> program parses one or more XML files, specified on the + command line as <em class="replaceable"><code>XML-FILE</code></em> (or the standard + input if the filename provided is <span class="bold"><strong>-</strong></span> ). + It prints various types of output, depending upon the options selected. + It is useful for detecting errors both + in <span class="acronym">XML</span> code and in the <span class="acronym">XML</span> parser + itself. + </p><p><span><strong class="command">xmllint</strong></span> is included in <span class="application">libxml2</span>.</p></div><div class="refsect1" lang="en"><a name="options"></a><h2>OPTIONS</h2><p> + <span><strong class="command">xmllint</strong></span> accepts the following options (in alphabetical order): + </p><div class="variablelist"><dl><dt><span class="term"><code class="option">--auto</code></span></dt><dd><p>Generate a small document for testing purposes.</p></dd><dt><span class="term"><code class="option">--catalogs</code></span></dt><dd><p> + Use the catalogs from <code class="envar">SGML_CATALOG_FILES</code>. + Otherwise <code class="filename">/etc/xml/catalog</code> is used by default. + </p></dd><dt><span class="term"><code class="option">--chkregister</code></span></dt><dd><p> + Turn on node registration. Useful for developers + testing <span class="application">libxml2</span> node tracking code. + </p></dd><dt><span class="term"><code class="option">--compress</code></span></dt><dd><p> + Turn on <span class="application">gzip</span> compression of output. + </p></dd><dt><span class="term"><code class="option">--copy</code></span></dt><dd><p>Test the internal copy implementation.</p></dd><dt><span class="term"><code class="option">--c14n</code></span></dt><dd><p> + Use the W3C XML Canonicalisation (<span class="acronym">C14N</span>) to serialize + the result of parsing to <code class="filename">stdout</code>. + It keeps comments in the result. + </p></dd><dt><span class="term"><code class="option">--dtdvalid <em class="replaceable"><code>URL</code></em></code></span></dt><dd><p> + Use the <span class="acronym">DTD</span> specified by + an <em class="replaceable"><code>URL</code></em> for validation. + </p></dd><dt><span class="term"><code class="option">--dtdvalidfpi <em class="replaceable"><code>FPI</code></em></code></span></dt><dd><p> + Use the <span class="acronym">DTD</span> specified by a Public + Identifier <em class="replaceable"><code>FPI</code></em> for validation, note that this + will require a Catalog exporting that Public Identifier to work. + </p></dd><dt><span class="term"><code class="option">--debug</code></span></dt><dd><p> + Parse a file and output an annotated tree of the + in-memory version of the document. + </p></dd><dt><span class="term"><code class="option">--debugent</code></span></dt><dd><p>Debug the entities defined in the document.</p></dd><dt><span class="term"><code class="option">--dropdtd</code></span></dt><dd><p>Remove <span class="acronym">DTD</span> from output.</p></dd><dt><span class="term"><code class="option">--dtdattr</code></span></dt><dd><p> + Fetch external <span class="acronym">DTD</span> and populate the tree with + inherited attributes. + </p></dd><dt><span class="term"><code class="option">--encode <em class="replaceable"><code>ENCODING</code></em></code></span></dt><dd><p>Output in the given encoding.</p></dd><dt><span class="term"><code class="option">--format</code></span></dt><dd><p> + Reformat and reindent the output. The <code class="envar">XMLLINT_INDENT</code> + environment variable controls the indentation (default value is two + spaces " "). + </p></dd><dt><span class="term"><code class="option">--help</code></span></dt><dd><p>Print out a short usage summary for <span><strong class="command">xmllint</strong></span>.</p></dd><dt><span class="term"><code class="option">--html</code></span></dt><dd><p>Use the <span class="acronym">HTML</span> parser.</p></dd><dt><span class="term"><code class="option">--htmlout</code></span></dt><dd><p> + Output results as an <span class="acronym">HTML</span> file. This + causes <span><strong class="command">xmllint</strong></span> to output the necessary <span class="acronym">HTML</span> + tags surrounding the result tree output so the results can be + displayed/viewed in a browser. + </p></dd><dt><span class="term"><code class="option">--insert</code></span></dt><dd><p>Test for valid insertions.</p></dd><dt><span class="term"><code class="option">--loaddtd</code></span></dt><dd><p>Fetch external <span class="acronym">DTD</span>.</p></dd><dt><span class="term"><code class="option">--load-trace</code></span></dt><dd><p> + Display all the documents loaded during the processing + to <code class="filename">stderr</code>. + </p></dd><dt><span class="term"><code class="option">--maxmem <em class="replaceable"><code>NNBYTES</code></em></code></span></dt><dd><p> + Test the parser memory support. <em class="replaceable"><code>NNBYTES</code></em> + is the maximum number of bytes the library is allowed to allocate. + This can also be used to make sure batch processing + of <span class="acronym">XML</span> files will not exhaust the virtual memory + of the server running them. + </p></dd><dt><span class="term"><code class="option">--memory</code></span></dt><dd><p>Parse from memory.</p></dd><dt><span class="term"><code class="option">--noblanks</code></span></dt><dd><p>Drop ignorable blank spaces.</p></dd><dt><span class="term"><code class="option">--nocatalogs</code></span></dt><dd><p>Do not use any catalogs.</p></dd><dt><span class="term"><code class="option">--nocdata</code></span></dt><dd><p>Substitute CDATA section by equivalent text nodes.</p></dd><dt><span class="term"><code class="option">--noent</code></span></dt><dd><p> + Substitute entity values for entity references. By default, <span><strong class="command">xmllint</strong></span> + leaves entity references in place. + </p></dd><dt><span class="term"><code class="option">--nonet</code></span></dt><dd><p> + Do not use the Internet to fetch <span class="acronym">DTD</span>s or entities. + </p></dd><dt><span class="term"><code class="option">--noout</code></span></dt><dd><p> + Suppress output. By default, <span><strong class="command">xmllint</strong></span> outputs the result tree. + </p></dd><dt><span class="term"><code class="option">--nowarning</code></span></dt><dd><p>Do not emit warnings from the parser and/or validator.</p></dd><dt><span class="term"><code class="option">--nowrap</code></span></dt><dd><p>Do not output <span class="acronym">HTML</span> doc wrapper.</p></dd><dt><span class="term"><code class="option">--noxincludenode</code></span></dt><dd><p> + Do XInclude processing but do not generate XInclude start and end nodes. + </p></dd><dt><span class="term"><code class="option">--nsclean</code></span></dt><dd><p>Remove redundant namespace declarations.</p></dd><dt><span class="term"><code class="option">--output <em class="replaceable"><code>FILE</code></em></code></span></dt><dd><p> + Define a file path where <span><strong class="command">xmllint</strong></span> will save the result of parsing. + Usually the programs build a tree and save it + on <code class="filename">stdout</code>, with this option + the result <span class="acronym">XML</span> instance will be saved onto a file. + </p></dd><dt><span class="term"><code class="option">--path <em class="replaceable"><code>"PATHS"</code></em></code></span></dt><dd><p> + Use the (space- or colon-separated) list of filesystem paths specified + by <em class="replaceable"><code>PATHS</code></em> to load <span class="acronym">DTD</span>s or + entities. Enclose space-separated lists by quotation marks. + </p></dd><dt><span class="term"><code class="option">--pattern <em class="replaceable"><code>PATTERNVALUE</code></em></code></span></dt><dd><p> + 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. + </p></dd><dt><span class="term"><code class="option">--postvalid</code></span></dt><dd><p>Validate after parsing is completed.</p></dd><dt><span class="term"><code class="option">--push</code></span></dt><dd><p>Use the push mode of the parser.</p></dd><dt><span class="term"><code class="option">--recover</code></span></dt><dd><p>Output any parsable portions of an invalid document.</p></dd><dt><span class="term"><code class="option">--relaxng <em class="replaceable"><code>SCHEMA</code></em></code></span></dt><dd><p> + Use RelaxNG file named <em class="replaceable"><code>SCHEMA</code></em> + for validation. + </p></dd><dt><span class="term"><code class="option">--repeat</code></span></dt><dd><p>Repeat 100 times, for timing or profiling.</p></dd><dt><span class="term"><code class="option">--schema <em class="replaceable"><code>SCHEMA</code></em></code></span></dt><dd><p> + Use a W3C XML Schema file named <em class="replaceable"><code>SCHEMA</code></em> + for validation. + </p></dd><dt><span class="term"><code class="option">--shell</code></span></dt><dd><p> + Run a navigating shell. Details on available commands in shell mode + are below (see section <span class="bold"><strong>SHELL COMMANDS</strong></span>). + </p></dd><dt><span class="term"><code class="option">--stream</code></span></dt><dd><p> + Use streaming API - useful when used in combination + with <code class="option">--relaxng</code> or <code class="option">--valid</code> options + for validation of files that are too large to be held in memory. + </p></dd><dt><span class="term"><code class="option">--testIO</code></span></dt><dd><p>Test user input/output support.</p></dd><dt><span class="term"><code class="option">--timing</code></span></dt><dd><p> + Output information about the time it takes <span><strong class="command">xmllint</strong></span> to perform the + various steps. + </p></dd><dt><span class="term"><code class="option">--valid</code></span></dt><dd><p> + Determine if the document is a valid instance of the included + Document Type Definition (<span class="acronym">DTD</span>). + A <span class="acronym">DTD</span> to be validated against also can be + specified at the command line using the <code class="option">--dtdvalid</code> + option. By default, <span><strong class="command">xmllint</strong></span> also checks to determine if the + document is well-formed. + </p></dd><dt><span class="term"><code class="option">--version</code></span></dt><dd><p> + Display the version of <span class="application">libxml2</span> used. + </p></dd><dt><span class="term"><code class="option">--walker</code></span></dt><dd><p> + Test the walker module, which is a reader interface but for a + document tree, instead of using the reader <span class="acronym">API</span> on + an unparsed document it works on a existing in-memory tree. Used in + debugging. + </p></dd><dt><span class="term"><code class="option">--xinclude</code></span></dt><dd><p>Do XInclude processing.</p></dd><dt><span class="term"><code class="option">--xmlout</code></span></dt><dd><p> + Used in conjunction with <code class="option">--html</code>. Usually + when <span class="acronym">HTML</span> is parsed the document is saved with + the <span class="acronym">HTML</span> serializer, but with this option the + resulting document is saved with the <span class="acronym">XML</span> + serializer. This is primarily used to + generate <span class="acronym">XHTML</span> + from <span class="acronym">HTML</span> input. + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="shell"></a><h2>SHELL COMMANDS</h2><p> + <span><strong class="command">xmllint</strong></span> offers an interactive shell mode invoked with + the <code class="option">--shell</code> command. Available commands in shell mode + include (in alphabetical order): + </p><div class="variablelist"><dl><dt><span class="term"><span><strong class="command">base</strong></span></span></dt><dd><p>Display <span class="acronym">XML</span> base of the node.</p></dd><dt><span class="term"><span><strong class="command">bye</strong></span></span></dt><dd><p>Leave the shell.</p></dd><dt><span class="term"><span><strong class="command">cat <em class="replaceable"><code>NODE</code></em></strong></span></span></dt><dd><p>Display the given node or the current one.</p></dd><dt><span class="term"><span><strong class="command">cd <em class="replaceable"><code>PATH</code></em></strong></span></span></dt><dd><p> + Change the current node to the given path (if unique) or root if no + argument is given. + </p></dd><dt><span class="term"><span><strong class="command">dir <em class="replaceable"><code>PATH</code></em></strong></span></span></dt><dd><p> + Dumps information about the node (namespace, attributes, content). + </p></dd><dt><span class="term"><span><strong class="command">du <em class="replaceable"><code>PATH</code></em></strong></span></span></dt><dd><p> + Show the structure of the subtree under the given path or the current node. + </p></dd><dt><span class="term"><span><strong class="command">exit</strong></span></span></dt><dd><p>Leave the shell.</p></dd><dt><span class="term"><span><strong class="command">help</strong></span></span></dt><dd><p>Show this help.</p></dd><dt><span class="term"><span><strong class="command">free</strong></span></span></dt><dd><p>Display memory usage.</p></dd><dt><span class="term"><span><strong class="command">load <em class="replaceable"><code>FILENAME</code></em></strong></span></span></dt><dd><p>Load a new document with the given filename.</p></dd><dt><span class="term"><span><strong class="command">ls <em class="replaceable"><code>PATH</code></em></strong></span></span></dt><dd><p>List contents of the given path or the current directory.</p></dd><dt><span class="term"><span><strong class="command">pwd</strong></span></span></dt><dd><p>Display the path to the current node.</p></dd><dt><span class="term"><span><strong class="command">quit</strong></span></span></dt><dd><p>Leave the shell.</p></dd><dt><span class="term"><span><strong class="command">save <em class="replaceable"><code>FILENAME</code></em></strong></span></span></dt><dd><p> + Save the current document to the given filename or to the original name. + </p></dd><dt><span class="term"><code class="option">validate</code></span></dt><dd><p>Check the document for errors.</p></dd><dt><span class="term"><span><strong class="command">write <em class="replaceable"><code>FILENAME</code></em></strong></span></span></dt><dd><p>Write the current node to the given filename.</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2496878"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl><dt><span class="term"><code class="envar">SGML_CATALOG_FILES</code></span></dt><dd><p>...</p></dd><dt><span class="term"><code class="envar">XML_CATALOG_FILES</code></span></dt><dd><p> + Catalog behavior can be changed by redirecting queries to the user's + own set of catalogs. This can be done by setting + the <code class="envar">XML_CATALOG_FILES</code> environment variable to a list + of catalogs. An empty one should deactivate loading the + default <code class="filename">/etc/xml/catalog</code> default catalog. + </p></dd><dt><span class="term"><code class="envar">XML_DEBUG_CATALOG</code></span></dt><dd><p> + Setting the environment variable <code class="envar">XML_DEBUG_CATALOG</code> + using the <span><strong class="command">export</strong></span> command outputs debugging information + related to catalog operations. + </p></dd><dt><span class="term"><code class="envar">XMLLINT_INDENT</code></span></dt><dd><p>...</p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2496971"></a><h2>DIAGNOSTICS</h2><p> + On the completion of execution, <span><strong class="command">xmllint</strong></span> returns the following error codes: + </p><div class="variablelist"><dl><dt><span class="term"><span class="errorcode">0</span></span></dt><dd><p>No error</p></dd><dt><span class="term"><span class="errorcode">1</span></span></dt><dd><p>Unclassified</p></dd><dt><span class="term"><span class="errorcode">2</span></span></dt><dd><p>Error in <span class="acronym">DTD</span></p></dd><dt><span class="term"><span class="errorcode">3</span></span></dt><dd><p>Validation error</p></dd><dt><span class="term"><span class="errorcode">4</span></span></dt><dd><p>Validation error</p></dd><dt><span class="term"><span class="errorcode">5</span></span></dt><dd><p>Error in schema compilation</p></dd><dt><span class="term"><span class="errorcode">6</span></span></dt><dd><p>Error writing output</p></dd><dt><span class="term"><span class="errorcode">7</span></span></dt><dd><p> + Error in pattern (generated when <code class="option">--pattern</code> option is used) + </p></dd><dt><span class="term"><span class="errorcode">8</span></span></dt><dd><p> + Error in Reader registration (generated + when <code class="option">--chkregister</code> option is used) + </p></dd><dt><span class="term"><span class="errorcode">9</span></span></dt><dd><p>Out of memory error</p></dd></dl></div></div></div></body></html> diff --git a/doc/xmllint.xml b/doc/xmllint.xml index 904f43f..c0d6eba 100644 --- a/doc/xmllint.xml +++ b/doc/xmllint.xml @@ -3,801 +3,868 @@ 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 xmllint "<command>xmllint</command>"> ]> + <refentry> - <refentryinfo> - <title>xmllint 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> - <author> - <firstname>Ziying</firstname> - <surname>Sherwin</surname> - </author> - <address><email>sherwin@nlm.nih.gov</email></address> - <author> - <firstname>Heiko</firstname> - <surname>Rupp</surname> - </author> - <address><email>hwr@pilhuhn.de</email></address> - - <releaseinfo>This is release 0.5 of the xmllint Manual.</releaseinfo> - </refentryinfo> - - <refmeta> - <refentrytitle>xmllint</refentrytitle> - <manvolnum>1</manvolnum> - </refmeta> - - <refnamediv> - <refname>xmllint</refname> - <refpurpose>command line <acronym>XML</acronym> tool</refpurpose> - </refnamediv> - - <refsynopsisdiv> - <cmdsynopsis> - <command>xmllint</command> - <group> - <arg>--version</arg> - <arg>--debug</arg> - <arg>--shell</arg> - <arg>--debugent</arg> - <arg>--copy</arg> - <arg>--recover</arg> - <arg>--noent</arg> - <arg>--noout</arg> - <arg>--nonet</arg> - <arg>--path <replaceable>paths</replaceable></arg> - <arg>--load-trace</arg> - <arg>--htmlout</arg> - <arg>--nowrap</arg> - <arg>--valid</arg> - <arg>--postvalid</arg> - <arg>--dtdvalid <replaceable>URL</replaceable></arg> - <arg>--dtdvalidfpi <replaceable>FPI</replaceable></arg> - <arg>--timing</arg> - <arg>--output <replaceable>file</replaceable></arg> - <arg>--repeat</arg> - <arg>--insert</arg> - <arg>--compress</arg> - <arg>--html</arg> - <arg>--xmlout</arg> - <arg>--push</arg> - <arg>--memory</arg> - <arg>--maxmem <replaceable>nbbytes</replaceable></arg> - <arg>--nowarning</arg> - <arg>--noblanks</arg> - <arg>--nocdata</arg> - <arg>--format</arg> - <arg>--encode <replaceable>encoding</replaceable></arg> - <arg>--dropdtd</arg> - <arg>--nsclean</arg> - <arg>--testIO</arg> - <arg>--catalogs</arg> - <arg>--nocatalogs</arg> - <arg>--auto</arg> - <arg>--xinclude</arg> - <arg>--noxincludenode</arg> - <arg>--loaddtd</arg> - <arg>--dtdattr</arg> - <arg>--stream</arg> - <arg>--walker</arg> - <arg>--pattern <replaceable>patternvalue</replaceable></arg> - <arg>--chkregister</arg> - <arg>--relaxng</arg> - <arg>--schema</arg> - <arg>--c14n</arg> - </group> - <arg><option><replaceable>xmlfile</replaceable></option></arg> - </cmdsynopsis> - </refsynopsisdiv> - - <refsect1 id="introduction"> - <title>Introduction</title> - <para> - The xmllint program parses one or more XML files, specified on the - command line as <replaceable>xmlfile</replaceable> (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 <acronym>XML</acronym> code and in the - <acronym>XML</acronym> parser itself. - </para> - - <para> - It is included in <application>libxml2</application>. - </para> - </refsect1> - <refsect1 id="options"> - <title>Options</title> - <variablelist> - <varlistentry> - <term><option>--version</option></term> + +<refentryinfo> + <title>xmllint Manual</title> + <productname>libxml2</productname> + <copyright> + <year>2001</year> + <year>2004</year> + </copyright> + <authorgroup> + <author> + <firstname>John</firstname> + <surname>Fleck</surname> + <affiliation> + <address> + <email>jfleck@inkstain.net</email> + </address> + </affiliation> + </author> + <author> + <firstname>Ziying</firstname> + <surname>Sherwin</surname> + <affiliation> + <address> + <email>sherwin@nlm.nih.gov</email> + </address> + </affiliation> + </author> + <author> + <firstname>Heiko</firstname> + <surname>Rupp</surname> + <affiliation> + <address> + <email>hwr@pilhuhn.de</email> + </address> + </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> +</refentryinfo> + +<refmeta> + <refentrytitle>xmllint</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> + <refname>xmllint</refname> + <refpurpose>command line <acronym>XML</acronym> tool</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>xmllint</command> + <group choice="opt"> + <arg choice="plain"><option>--version</option></arg> + <arg choice="plain"><option>--debug</option></arg> + <arg choice="plain"><option>--shell</option></arg> + <arg choice="plain"><option>--debugent</option></arg> + <arg choice="plain"><option>--copy</option></arg> + <arg choice="plain"><option>--recover</option></arg> + <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>--load-trace</option></arg> + <arg choice="plain"><option>--htmlout</option></arg> + <arg choice="plain"><option>--nowrap</option></arg> + <arg choice="plain"><option>--valid</option></arg> + <arg choice="plain"><option>--postvalid</option></arg> + <arg choice="plain"><option>--dtdvalid <replaceable class="option">URL</replaceable></option></arg> + <arg choice="plain"><option>--dtdvalidfpi <replaceable class="option">FPI</replaceable></option></arg> + <arg choice="plain"><option>--timing</option></arg> + <arg choice="plain"><option>--output <replaceable class="option">FILE</replaceable></option></arg> + <arg choice="plain"><option>--repeat</option></arg> + <arg choice="plain"><option>--insert</option></arg> + <arg choice="plain"><option>--compress</option></arg> + <arg choice="plain"><option>--html</option></arg> + <arg choice="plain"><option>--xmlout</option></arg> + <arg choice="plain"><option>--push</option></arg> + <arg choice="plain"><option>--memory</option></arg> + <arg choice="plain"><option>--maxmem <replaceable class="option">NBBYTES</replaceable></option></arg> + <arg choice="plain"><option>--nowarning</option></arg> + <arg choice="plain"><option>--noblanks</option></arg> + <arg choice="plain"><option>--nocdata</option></arg> + <arg choice="plain"><option>--format</option></arg> + <arg choice="plain"><option>--encode <replaceable class="option">ENCODING</replaceable></option></arg> + <arg choice="plain"><option>--dropdtd</option></arg> + <arg choice="plain"><option>--nsclean</option></arg> + <arg choice="plain"><option>--testIO</option></arg> + <arg choice="plain"><option>--catalogs</option></arg> + <arg choice="plain"><option>--nocatalogs</option></arg> + <arg choice="plain"><option>--auto</option></arg> + <arg choice="plain"><option>--xinclude</option></arg> + <arg choice="plain"><option>--noxincludenode</option></arg> + <arg choice="plain"><option>--loaddtd</option></arg> + <arg choice="plain"><option>--dtdattr</option></arg> + <arg choice="plain"><option>--stream</option></arg> + <arg choice="plain"><option>--walker</option></arg> + <arg choice="plain"><option>--pattern <replaceable class="option">PATTERNVALUE</replaceable></option></arg> + <arg choice="plain"><option>--chkregister</option></arg> + <arg choice="plain"><option>--relaxng <replaceable class="option">SCHEMA</replaceable></option></arg> + <arg choice="plain"><option>--schema <replaceable class="option">SCHEMA</replaceable></option></arg> + <arg choice="plain"><option>--c14n</option></arg> + </group> + <group choice="req"> + <arg choice="plain" rep="repeat"><replaceable>XML-FILE(S)</replaceable></arg> + <arg choice="plain" rep="norepeat">-</arg> + </group> + </cmdsynopsis> + <cmdsynopsis> + <command>xmllint</command> + <arg choice="plain"><option>--help</option></arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1 id="introduction"> + <title>DESCRIPTION</title> + <para> + The &xmllint; program parses one or more XML files, specified on the + command line as <replaceable>XML-FILE</replaceable> (or the standard + input if the filename provided is <emphasis role="bold">-</emphasis> ). + It prints various types of output, depending upon the options selected. + It is useful for detecting errors both + in <acronym>XML</acronym> code and in the <acronym>XML</acronym> parser + itself. + </para> + <para>&xmllint; is included in <application>libxml2</application>.</para> +</refsect1> + +<refsect1 id="options"> + <title>OPTIONS</title> + <para> + &xmllint; accepts the following options (in alphabetical order): + </para> + + <variablelist> + + <varlistentry> + <term><option>--auto</option></term> <listitem> - <simpara> - Display the version of - <application>libxml2</application> used. - </simpara> + <para>Generate a small document for testing purposes.</para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> - <term><option>--debug</option></term> + <varlistentry> + <term><option>--catalogs</option></term> <listitem> - <simpara> - Parse a file and output an annotated tree of the - in-memory version of the document. - </simpara> + <para> + Use the catalogs from <envar>SGML_CATALOG_FILES</envar>. + Otherwise <filename>/etc/xml/catalog</filename> is used by default. + </para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> - <term><option>--shell</option></term> + <varlistentry> + <term><option>--chkregister</option></term> + <listitem> + <para> + Turn on node registration. Useful for developers + testing <application>libxml2</application> node tracking code. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--compress</option></term> + <listitem> + <para> + Turn on <application>gzip</application> compression of output. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--copy</option></term> <listitem> - <simpara> - Run a navigating shell. Details on available commands in shell mode - are below. - </simpara> + <para>Test the internal copy implementation.</para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> + <varlistentry> + <term><option>--c14n</option></term> + <listitem> + <para> + Use the W3C XML Canonicalisation (<acronym>C14N</acronym>) to serialize + the result of parsing to <filename class="devicefile">stdout</filename>. + It keeps comments in the result. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--dtdvalid <replaceable class="option">URL</replaceable></option></term> + <listitem> + <para> + Use the <acronym>DTD</acronym> specified by + an <replaceable>URL</replaceable> for validation. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--dtdvalidfpi <replaceable class="option">FPI</replaceable></option></term> + <listitem> + <para> + Use the <acronym>DTD</acronym> specified by a Public + Identifier <replaceable>FPI</replaceable> for validation, note that this + will require a Catalog exporting that Public Identifier to work. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--debug</option></term> + <listitem> + <para> + Parse a file and output an annotated tree of the + in-memory version of the document. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term><option>--debugent</option></term> <listitem> - <simpara> - Debug the entities defined in the document. - </simpara> + <para>Debug the entities defined in the document.</para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> - <term><option>--copy</option> </term> + <varlistentry> + <term><option>--dropdtd</option></term> <listitem> - <simpara> - Test the internal copy implementation. - </simpara> + <para>Remove <acronym>DTD</acronym> from output.</para> </listitem> - </varlistentry> - - - <varlistentry> - <term><option>--recover</option></term> + </varlistentry> + + <varlistentry> + <term><option>--dtdattr</option></term> <listitem> - <simpara> - Output any parsable portions of an invalid - document. - </simpara> + <para> + Fetch external <acronym>DTD</acronym> and populate the tree with + inherited attributes. + </para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> - <term><option>--noent</option></term> + <varlistentry> + <term><option>--encode <replaceable class="option">ENCODING</replaceable></option></term> <listitem> - <simpara> - Substitute entity values for entity - references. By default, <application>xmllint</application> leaves entity - references in place. - </simpara> + <para>Output in the given encoding.</para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--nocdata</option></term> + </varlistentry> + + <varlistentry> + <term><option>--format</option></term> <listitem> - <simpara> - Substitute CDATA section by equivalent text nodes. - </simpara> + <para> + Reformat and reindent the output. The <envar>XMLLINT_INDENT</envar> + environment variable controls the indentation (default value is two + spaces " "). + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--nsclean</option></term> + </varlistentry> + + <varlistentry> + <term><option>--help</option></term> <listitem> - <simpara> - Remove redundant namespace declarations. - </simpara> + <para>Print out a short usage summary for &xmllint;.</para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--noout</option></term> + </varlistentry> + + <varlistentry> + <term><option>--html</option></term> <listitem> - <simpara> - Suppress output. By default, - <application>xmllint</application> outputs the result tree. - </simpara> + <para>Use the <acronym>HTML</acronym> parser.</para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> - <term><option>--nonet</option></term> + <varlistentry> + <term><option>--htmlout</option></term> + <listitem> + <para> + Output results as an <acronym>HTML</acronym> file. This + causes &xmllint; to output the necessary <acronym>HTML</acronym> + tags surrounding the result tree output so the results can be + displayed/viewed in a browser. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--insert</option></term> <listitem> - <simpara> - Do not use the Internet to fetch DTD's or entities. - </simpara> + <para>Test for valid insertions.</para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> - <term> <option>--path</option> <replaceable>paths</replaceable></term> + <varlistentry> + <term><option>--loaddtd</option></term> <listitem> - <simpara> - Use the list (separated by space or column) of filesystem path - specified by <replaceable>paths</replaceable> to load - <acronym>DTDs</acronym> or entities . - </simpara> + <para>Fetch external <acronym>DTD</acronym>.</para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> + <varlistentry> <term><option>--load-trace</option></term> <listitem> - <simpara> - Display to stderr all the documents loaded during the processing. - </simpara> + <para> + Display all the documents loaded during the processing + to <filename class="devicefile">stderr</filename>. + </para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> - <term><option>--htmlout</option></term> + <varlistentry> + <term><option>--maxmem <replaceable class="option">NNBYTES</replaceable></option></term> + <listitem> + <para> + Test the parser memory support. <replaceable>NNBYTES</replaceable> + is the maximum number of bytes the library is allowed to allocate. + This can also be used to make sure batch processing + of <acronym>XML</acronym> files will not exhaust the virtual memory + of the server running them. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--memory</option></term> <listitem> - <simpara> - Output results as an <acronym>HTML</acronym> - file. This causes <application>xmllint</application> to output - the necessary <acronym>HTML</acronym> tags surrounding the result tree - output so the results can be displayed in a browser. - </simpara> + <para>Parse from memory.</para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> - <term><option>--nowrap </option></term> + <varlistentry> + <term><option>--noblanks</option></term> <listitem> - <simpara> - Do not output HTML doc wrapper. - </simpara> + <para>Drop ignorable blank spaces.</para> </listitem> - </varlistentry> + </varlistentry> -<varlistentry> - <term><option>--valid </option></term> + <varlistentry> + <term><option>--nocatalogs</option></term> <listitem> - <simpara> - Determine if the document is a valid instance - of the included Document Type Definition (<acronym>DTD</acronym>). A - <acronym>DTD</acronym> to be validated against also can be specified at - the command line using the <option>--dtdvalid</option> option. By default, - <application>xmllint</application> also checks to determine if the - document is well-formed. - </simpara> + <para>Do not use any catalogs.</para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--postvalid</option></term> + </varlistentry> + + <varlistentry> + <term><option>--nocdata</option></term> <listitem> - <simpara> - Validate after parsing is completed. - </simpara> - </listitem> - </varlistentry> - - <varlistentry> - <term> <option>--dtdvalid</option> <replaceable>URL</replaceable></term> - <listitem> - <simpara> - Use the - <acronym>DTD</acronym> specified by <replaceable>URL</replaceable> for - validation. - </simpara> - </listitem> - </varlistentry> - - <varlistentry> - <term> <option>--dtdvalidfpi</option> <replaceable>FPI</replaceable></term> - <listitem> - <simpara> - Use the - <acronym>DTD</acronym> specified by the Public Identifier - <replaceable>FPI</replaceable> for validation, note that this - will require a Catalog exporting that Public Identifier to work. - </simpara> - </listitem> - </varlistentry> - - <varlistentry> - <term><option>--timing</option></term> + <para>Substitute CDATA section by equivalent text nodes.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--noent</option></term> <listitem> - <simpara> - Output information about the time it takes - <application>xmllint</application> to perform the various steps. - </simpara> + <para> + Substitute entity values for entity references. By default, &xmllint; + leaves entity references in place. + </para> </listitem> - </varlistentry> - <varlistentry> - <term><option>--output</option> <replaceable>file</replaceable></term> + </varlistentry> + + <varlistentry> + <term><option>--nonet</option></term> <listitem> - <simpara>Define a file path where xmllint will save the result of - parsing. Usually the programs build a tree and save it on stdout, with - this option the result XML instance will be saved onto a file.</simpara> + <para> + Do not use the Internet to fetch <acronym>DTD</acronym>s or entities. + </para> </listitem> - </varlistentry> - <varlistentry> - <term><option>--repeat</option></term> + </varlistentry> + + <varlistentry> + <term><option>--noout</option></term> <listitem> - <simpara> - Repeat 100 times, for timing or profiling. - </simpara> + <para> + Suppress output. By default, &xmllint; outputs the result tree. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--insert</option></term> + </varlistentry> + + <varlistentry> + <term><option>--nowarning</option></term> <listitem> - <simpara> - Test for valid insertions. - </simpara> + <para>Do not emit warnings from the parser and/or validator.</para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> - <term><option>--compress</option></term> + <varlistentry> + <term><option>--nowrap</option></term> <listitem> - <simpara> - Turn on gzip compression of output. - </simpara> + <para>Do not output <acronym>HTML</acronym> doc wrapper.</para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--html</option></term> + </varlistentry> + + <varlistentry> + <term><option>--noxincludenode</option></term> <listitem> - <simpara> - Use the <acronym>HTML</acronym> parser. - </simpara> + <para> + Do XInclude processing but do not generate XInclude start and end nodes. + </para> </listitem> - </varlistentry> - <varlistentry> - <term><option>--xmlout</option></term> + </varlistentry> + + <varlistentry> + <term><option>--nsclean</option></term> + <listitem> + <para>Remove redundant namespace declarations.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--output <replaceable class="option">FILE</replaceable></option></term> + <listitem> + <para> + Define a file path where &xmllint; will save the result of parsing. + Usually the programs build a tree and save it + on <filename class="devicefile">stdout</filename>, with this option + the result <acronym>XML</acronym> instance will be saved onto a file. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--path <replaceable class="option">"PATHS"</replaceable></option></term> + <listitem> + <para> + Use the (space- or colon-separated) list of filesystem paths specified + by <replaceable>PATHS</replaceable> to load <acronym>DTD</acronym>s or + entities. Enclose space-separated lists by quotation marks. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--pattern <replaceable class="option">PATTERNVALUE</replaceable></option></term> + <listitem> + <para> + 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. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--postvalid</option></term> <listitem> - <simpara>Used in conjunction with <option>--html</option>. Usually - when HTML is parsed the document is saved with the HTML serializer, but with - this option the resulting document is saved with the XML serializer. This is - primarily used to generate XHTML from HTML input.</simpara> + <para>Validate after parsing is completed.</para> </listitem> - </varlistentry> - <varlistentry> + </varlistentry> + + <varlistentry> <term><option>--push</option></term> <listitem> - <simpara> - Use the push mode of the parser. - </simpara> + <para>Use the push mode of the parser.</para> </listitem> - </varlistentry> - + </varlistentry> - <varlistentry> - <term><option>--memory</option></term> + <varlistentry> + <term><option>--recover</option></term> <listitem> - <simpara> - Parse from memory. - </simpara> + <para>Output any parsable portions of an invalid document.</para> </listitem> - </varlistentry> - <varlistentry> - <term><option>--maxmem</option> <replaceable>nnbytes</replaceable></term> + </varlistentry> + + <varlistentry> + <term><option>--relaxng <replaceable class="option">SCHEMA</replaceable></option></term> <listitem> - <simpara>Test the parser memory - support. <replaceable>nnbytes</replaceable> is the maximum number of bytes the - library is allowed to allocate. This can also be used to make sure batch - processing of XML files will not exhaust the virtual memory of the server - running them.</simpara> + <para> + Use RelaxNG file named <replaceable class="option">SCHEMA</replaceable> + for validation. + </para> </listitem> - </varlistentry> - <varlistentry> - <term><option>--nowarning</option></term> + </varlistentry> + + <varlistentry> + <term><option>--repeat</option></term> <listitem> - <simpara> - Do not emit warnings from the parser and/or validator. - </simpara> + <para>Repeat 100 times, for timing or profiling.</para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> - <term><option>--noblanks</option></term> + <varlistentry> + <term><option>--schema <replaceable>SCHEMA</replaceable></option></term> <listitem> - <simpara> - Drop ignorable blank spaces. - </simpara> + <para> + Use a W3C XML Schema file named <replaceable>SCHEMA</replaceable> + for validation. + </para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> - <term><option>--format</option></term> + <varlistentry> + <term><option>--shell</option></term> <listitem> - <simpara> - Reformat and reindent the output. The $XMLLINT_INDENT - environment variable controls the indentation (default - value is two spaces " "). - </simpara> + <para> + Run a navigating shell. Details on available commands in shell mode + are below (see section <emphasis role="bold">SHELL COMMANDS</emphasis>). + </para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> - <term><option>--testIO</option></term> + <varlistentry> + <term><option>--stream</option></term> <listitem> - <simpara> - Test user input/output support. - </simpara> + <para> + Use streaming API - useful when used in combination + with <option>--relaxng</option> or <option>--valid</option> options + for validation of files that are too large to be held in memory. + </para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> - <term><option>--encode</option> <replaceable>encoding</replaceable></term> + <varlistentry> + <term><option>--testIO</option></term> <listitem> - <simpara> - Output in the given encoding. - </simpara> + <para>Test user input/output support.</para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--catalogs</option></term> + </varlistentry> + + <varlistentry> + <term><option>--timing</option></term> <listitem> - <simpara> - Use the catalogs from $SGML_CATALOG_FILES. Otherwise /etc/xml/catalog - is used by default. - </simpara> + <para> + Output information about the time it takes &xmllint; to perform the + various steps. + </para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> - <term><option>--nocatalogs</option></term> + <varlistentry> + <term><option>--valid</option></term> + <listitem> + <para> + Determine if the document is a valid instance of the included + Document Type Definition (<acronym>DTD</acronym>). + A <acronym>DTD</acronym> to be validated against also can be + specified at the command line using the <option>--dtdvalid</option> + option. By default, &xmllint; also checks to determine if the + document is well-formed. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--version</option></term> <listitem> - <simpara> - Do not use any catalogs. - </simpara> + <para> + Display the version of <application>libxml2</application> used. + </para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--auto</option></term> + </varlistentry> + + <varlistentry> + <term><option>--walker</option></term> <listitem> - <simpara> - Generate a small document for testing purposes. - </simpara> + <para> + Test the walker module, which is a reader interface but for a + document tree, instead of using the reader <acronym>API</acronym> on + an unparsed document it works on a existing in-memory tree. Used in + debugging. + </para> </listitem> - </varlistentry> + </varlistentry> - <varlistentry> + <varlistentry> <term><option>--xinclude</option></term> <listitem> - <simpara> - Do XInclude processing. - </simpara> + <para>Do XInclude processing.</para> </listitem> - </varlistentry> - <varlistentry> - <term><option>--noxincludenode</option></term> + </varlistentry> + + <varlistentry> + <term><option>--xmlout</option></term> <listitem> - <simpara> - Do XInclude processing but do not generate XInclude start and end - nodes. - </simpara> + <para> + Used in conjunction with <option>--html</option>. Usually + when <acronym>HTML</acronym> is parsed the document is saved with + the <acronym>HTML</acronym> serializer, but with this option the + resulting document is saved with the <acronym>XML</acronym> + serializer. This is primarily used to + generate <acronym>XHTML</acronym> + from <acronym>HTML</acronym> input. + </para> + </listitem> + </varlistentry> + + </variablelist> +</refsect1> + +<refsect1 id="shell"> + <title>SHELL COMMANDS</title> + <para> + &xmllint; offers an interactive shell mode invoked with + the <option>--shell</option> command. Available commands in shell mode + include (in alphabetical order): + </para> + <variablelist> + + <varlistentry> + <term><command>base</command></term> + <listitem> + <para>Display <acronym>XML</acronym> base of the node.</para> </listitem> - </varlistentry> - <varlistentry> - <term><option>--loaddtd</option></term> + </varlistentry> + + <varlistentry> + <term><command>bye</command></term> <listitem> - <simpara> - Fetch external DTD. - </simpara> + <para>Leave the shell.</para> </listitem> - </varlistentry> - - <varlistentry> - <term><option>--dtdattr</option></term> + </varlistentry> + + <varlistentry> + <term><command>cat <replaceable>NODE</replaceable></command></term> <listitem> - <simpara> - Fetch external DTD and populate the tree with inherited attributes. - </simpara> + <para>Display the given node or the current one.</para> </listitem> - </varlistentry> - <varlistentry> - <term><option>--dropdtd</option></term> + </varlistentry> + + <varlistentry> + <term><command>cd <replaceable>PATH</replaceable></command></term> <listitem> - <simpara> - Remove <acronym>DTD</acronym> from output. - </simpara> + <para> + Change the current node to the given path (if unique) or root if no + argument is given. + </para> </listitem> - </varlistentry> - <varlistentry> - <term><option>--stream</option></term> + </varlistentry> + + <varlistentry> + <term><command>dir <replaceable>PATH</replaceable></command></term> <listitem> - <simpara>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.</simpara> + <para> + Dumps information about the node (namespace, attributes, content). + </para> </listitem> - </varlistentry> - <varlistentry> - <term><option>--walker</option></term> + </varlistentry> + + <varlistentry> + <term><command>du <replaceable>PATH</replaceable></command></term> <listitem> - <simpara>Test the walker module, which is a reader interface but for a - document tree, instead of using the reader API on an unparsed document it - works on a existing in-memory tree. Used in debugging.</simpara> + <para> + Show the structure of the subtree under the given path or the current node. + </para> </listitem> - </varlistentry> - <varlistentry> - <term><option>--chkregister</option></term> + </varlistentry> + + <varlistentry> + <term><command>exit</command></term> <listitem> - <simpara>Turn on node registration. Useful for developers testing - libxml2 node tracking code.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><option>--pattern</option> <replaceable>patternvalue</replaceable></term> - <listitem> - <simpara>Used to exercise the pattern recognition engine, which can be - used with the reader interface to the parser. It allows to select some - nodes in the document based on an XPath (subset) expression. Used for - debugging.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><option>--relaxng</option> <replaceable>schema</replaceable></term> - <listitem> - <simpara>Use RelaxNG file named <replaceable>schema</replaceable> for - validation.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><option>--schema</option> <replaceable>schema</replaceable></term> - <listitem> - <simpara>Use a W3C XML Schema file named <replaceable>schema</replaceable> for validation.</simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <option>--c14n</option></term> + <para>Leave the shell.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>help</command></term> + <listitem> + <para>Show this help.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>free</command></term> + <listitem> + <para>Display memory usage.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>load <replaceable>FILENAME</replaceable></command></term> + <listitem> + <para>Load a new document with the given filename.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>ls <replaceable>PATH</replaceable></command></term> + <listitem> + <para>List contents of the given path or the current directory.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>pwd</command></term> + <listitem> + <para>Display the path to the current node.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>quit</command></term> + <listitem> + <para>Leave the shell.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>save <replaceable>FILENAME</replaceable></command></term> <listitem> - <simpara>Use the W3C XML Canonicalisation (C14N) to -serialize the result of parsing to stdout. It keeps comments in -the result.</simpara> - </listitem> - </varlistentry> - </variablelist> - </refsect1> - - <refsect1 id="shell"> - <title>Shell</title> - <para> - <application>xmllint</application> offers an interactive shell mode - invoked with the <option>--shell</option> command. Available commands in - shell mode include: - </para> - <variablelist> - <varlistentry> - <term><option>base</option></term> - <listitem> - <simpara> - display XML base of the node - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><option>bye</option></term> - <listitem> - <simpara> - leave shell - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><option>cat <replaceable>node</replaceable></option></term> - <listitem> - <simpara> - Display node if given or current node. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><option>cd <replaceable>path</replaceable></option></term> - <listitem> - <simpara> - Change the current node to <replaceable>path</replaceable> (if given - and unique) or root if no argument given. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><option>dir <replaceable>path</replaceable></option></term> - <listitem> - <simpara> - Dumps information about the node (namespace, attributes, content). - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><option>du <replaceable>path</replaceable></option></term> - <listitem> - <simpara> - Show the structure of the subtree under path or the current node. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><option>exit</option></term> - <listitem> - <simpara> - Leave the shell. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><option>help</option></term> - <listitem> - <simpara> - Show this help. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><option>free</option></term> - <listitem> - <simpara> - Display memory usage. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><option>load <replaceable>name</replaceable></option></term> - <listitem> - <simpara> - Load a new document with the given name. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><option>ls <replaceable>path</replaceable></option></term> - <listitem> - <simpara> - List contents of <replaceable>path</replaceable> (if given) or the - current directory. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><option>pwd</option></term> - <listitem> - <simpara> - Display the path to the current node. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><option>quit</option></term> - <listitem> - <simpara> - Leave the shell. - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term><option>save <replaceable>name</replaceable></option></term> - <listitem> - <simpara> - Saves the current document to <replaceable>name</replaceable> if - given or to the original name. - </simpara> + <para> + Save the current document to the given filename or to the original name. + </para> </listitem> - </varlistentry> - <varlistentry> + </varlistentry> + + <varlistentry> <term><option>validate</option></term> <listitem> - <simpara> - Check the document for error. - </simpara> + <para>Check the document for errors.</para> </listitem> - </varlistentry> - <varlistentry> - <term><option>write <replaceable>name</replaceable></option></term> + </varlistentry> + + <varlistentry> + <term><command>write <replaceable>FILENAME</replaceable></command></term> <listitem> - <simpara> - Write the current node to the given filename. - </simpara> + <para>Write the current node to the given filename.</para> </listitem> - </varlistentry> - - </variablelist> - </refsect1> + </varlistentry> + + </variablelist> +</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>Debugging Catalogs</title> - <para>Setting the environment variable <varname>XML_DEBUG_CATALOG</varname> - using the command <command>"export XML_DEBUG_CATALOG="</command> - outputs debugging information related to catalog operations.</para> - </refsect1> - <refsect1> - <title>Error Return Codes</title> - <para>On the completion of execution, <application>Xmllint</application> - returns the following error codes:</para> - <variablelist> - <varlistentry> - <term>0</term> + <title>ENVIRONMENT</title> + <variablelist> + + <varlistentry> + <term><envar>SGML_CATALOG_FILES</envar></term> <listitem> - <simpara>No error</simpara> + <para>...</para> </listitem> - </varlistentry> - <varlistentry> - <term>1</term> + </varlistentry> + + <varlistentry> + <term><envar>XML_CATALOG_FILES</envar></term> + <listitem> + <para> + Catalog behavior can be changed by redirecting queries to the user's + own set of catalogs. This can be done by setting + 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> + + <varlistentry> + <term><envar>XML_DEBUG_CATALOG</envar></term> <listitem> - <simpara>Unclassified</simpara> + <para> + Setting the environment variable <envar>XML_DEBUG_CATALOG</envar> + using the <command>export</command> command outputs debugging information + related to catalog operations. + </para> </listitem> - </varlistentry> - <varlistentry> - <term>2</term> + </varlistentry> + + <varlistentry> + <term><envar>XMLLINT_INDENT</envar></term> <listitem> - <simpara>Error in DTD</simpara> + <para>...</para> </listitem> - </varlistentry> - <varlistentry> - <term>3</term> + </varlistentry> + + </variablelist> +</refsect1> + +<refsect1> + <title>DIAGNOSTICS</title> + <para> + On the completion of execution, &xmllint; returns the following error codes: + </para> + <variablelist> + + <varlistentry> + <term><errorcode>0</errorcode></term> <listitem> - <simpara>Validation error</simpara> + <para>No error</para> </listitem> - </varlistentry> - <varlistentry> - <term>4</term> + </varlistentry> + + <varlistentry> + <term><errorcode>1</errorcode></term> <listitem> - <simpara>Validation error</simpara> + <para>Unclassified</para> </listitem> - </varlistentry> - <varlistentry> - <term>5</term> + </varlistentry> + + <varlistentry> + <term><errorcode>2</errorcode></term> <listitem> - <simpara>Error in schema compilation</simpara> + <para>Error in <acronym>DTD</acronym></para> </listitem> - </varlistentry> - <varlistentry> - <term>6</term> + </varlistentry> + + <varlistentry> + <term><errorcode>3</errorcode></term> <listitem> - <simpara>Error writing output</simpara> + <para>Validation error</para> </listitem> - </varlistentry> - <varlistentry> - <term>7</term> + </varlistentry> + + <varlistentry> + <term><errorcode>4</errorcode></term> <listitem> - <simpara>Error in pattern (generated when - <optional>--pattern</optional> option is used)</simpara> + <para>Validation error</para> </listitem> - </varlistentry> - <varlistentry> - <term>8</term> + </varlistentry> + + <varlistentry> + <term><errorcode>5</errorcode></term> <listitem> - <simpara>Error in Reader registration (generated when - <optional>--chkregister</optional> option is used)</simpara> + <para>Error in schema compilation</para> </listitem> - </varlistentry> - <varlistentry> - <term>9</term> + </varlistentry> + + <varlistentry> + <term><errorcode>6</errorcode></term> <listitem> - <simpara>Out of memory error</simpara> + <para>Error writing output</para> </listitem> - </varlistentry> - </variablelist> - </refsect1> + </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> + + </variablelist> +</refsect1> + </refentry> @@ -242,6 +242,7 @@ xmllintExternalEntityLoader(const char *URL, const char *ID, xmlParserCtxtPtr ctxt) { xmlParserInputPtr ret; warningSAXFunc warning = NULL; + errorSAXFunc err = NULL; int i; const char *lastsegment = URL; @@ -257,7 +258,9 @@ xmllintExternalEntityLoader(const char *URL, const char *ID, if ((ctxt != NULL) && (ctxt->sax != NULL)) { warning = ctxt->sax->warning; + err = ctxt->sax->error; ctxt->sax->warning = NULL; + ctxt->sax->error = NULL; } if (defaultEntityLoader != NULL) { @@ -265,6 +268,8 @@ xmllintExternalEntityLoader(const char *URL, const char *ID, if (ret != NULL) { if (warning != NULL) ctxt->sax->warning = warning; + if (err != NULL) + ctxt->sax->error = err; if (load_trace) { fprintf \ (stderr, @@ -286,6 +291,8 @@ xmllintExternalEntityLoader(const char *URL, const char *ID, if (ret != NULL) { if (warning != NULL) ctxt->sax->warning = warning; + if (err != NULL) + ctxt->sax->error = err; if (load_trace) { fprintf \ (stderr, @@ -299,6 +306,8 @@ xmllintExternalEntityLoader(const char *URL, const char *ID, xmlFree(newURL); } } + if (err != NULL) + ctxt->sax->error = err; if (warning != NULL) { ctxt->sax->warning = warning; if (URL != NULL) |