diff options
author | Mike Hommey <glandium@debian.org> | 2006-04-29 21:57:40 +0200 |
---|---|---|
committer | Mike Hommey <glandium@debian.org> | 2006-04-29 21:57:40 +0200 |
commit | 07a67fa4bcc1b8bf2651ab41e5fc54a05059cf7e (patch) | |
tree | 7b377fd8e804a983cb2c57a43be1093ef179c5fd /doc/xmllint.1 | |
parent | c5d565931c4823dc8f62fffcb65aecfec516f7b9 (diff) | |
download | libxml2-07a67fa4bcc1b8bf2651ab41e5fc54a05059cf7e.tar.gz |
Load /tmp/libxml2-2.6.24 intoupstream/2.6.24.dfsg
libxml2/branches/upstream/current.
Diffstat (limited to 'doc/xmllint.1')
-rw-r--r-- | doc/xmllint.1 | 574 |
1 files changed, 309 insertions, 265 deletions
diff --git a/doc/xmllint.1 b/doc/xmllint.1 index db24d61..13e38f5 100644 --- a/doc/xmllint.1 +++ b/doc/xmllint.1 @@ -1,362 +1,406 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "XMLLINT" 1 "" "" "xmllint Manual" -.SH NAME +.\" ** You probably do not want to edit this file directly ** +.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). +.\" Instead of manually editing it, you probably should edit the DocBook XML +.\" source for it and then use the DocBook XSL Stylesheets to regenerate it. +.TH "XMLLINT" "1" "2006\-03\-05" "libxml2" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" xmllint \- command line XML tool .SH "SYNOPSIS" -.ad l -.hy 0 .HP 8 -\fBxmllint\fR [\fB\-\-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] -.ad -.hy - -.SH "INTRODUCTION" - +\fBxmllint\fR [\fB\-\-version\fR \fB\-\-debug\fR \fB\-\-shell\fR \fB\-\-debugent\fR \fB\-\-copy\fR \fB\-\-recover\fR \fB\-\-noent\fR \fB\-\-noout\fR \fB\-\-nonet\fR \fB\-\-path\ "\fR\fB\fIPATH(S)\fR\fR\fB"\fR \fB\-\-load\-trace\fR \fB\-\-htmlout\fR \fB\-\-nowrap\fR \fB\-\-valid\fR \fB\-\-postvalid\fR \fB\-\-dtdvalid\ \fR\fB\fIURL\fR\fR \fB\-\-dtdvalidfpi\ \fR\fB\fIFPI\fR\fR \fB\-\-timing\fR \fB\-\-output\ \fR\fB\fIFILE\fR\fR \fB\-\-repeat\fR \fB\-\-insert\fR \fB\-\-compress\fR \fB\-\-html\fR \fB\-\-xmlout\fR \fB\-\-push\fR \fB\-\-memory\fR \fB\-\-maxmem\ \fR\fB\fINBBYTES\fR\fR \fB\-\-nowarning\fR \fB\-\-noblanks\fR \fB\-\-nocdata\fR \fB\-\-format\fR \fB\-\-encode\ \fR\fB\fIENCODING\fR\fR \fB\-\-dropdtd\fR \fB\-\-nsclean\fR \fB\-\-testIO\fR \fB\-\-catalogs\fR \fB\-\-nocatalogs\fR \fB\-\-auto\fR \fB\-\-xinclude\fR \fB\-\-noxincludenode\fR \fB\-\-loaddtd\fR \fB\-\-dtdattr\fR \fB\-\-stream\fR \fB\-\-walker\fR \fB\-\-pattern\ \fR\fB\fIPATTERNVALUE\fR\fR \fB\-\-chkregister\fR \fB\-\-relaxng\ \fR\fB\fISCHEMA\fR\fR \fB\-\-schema\ \fR\fB\fISCHEMA\fR\fR \fB\-\-c14n\fR] {\fIXML\-FILE(S)\fR... \-} +.HP 8 +\fBxmllint\fR \fB\-\-help\fR +.SH "DESCRIPTION" +.PP +The +\fBxmllint\fR +program parses one or more XML files, specified on the command line as +\fIXML\-FILE\fR +(or the standard input if the filename provided is +\fB\-\fR +). It prints various types of output, depending upon the options selected. It is useful for detecting errors both in +XML +code and in the +XML +parser itself. .PP -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\&. - +\fBxmllint\fR +is included in +\fBlibxml\fR(3). .PP -It is included in libxml2\&. - +More information can be found at +.TP 3 +\(bu +\fBlibxml\fR(3) +web page +\fI\%http://www.xmlsoft.org/\fR +.TP +\(bu +W3C +XSLT +page +\fI\%http://www.w3.org/TR/xslt\fR .SH "OPTIONS" - +.PP +\fBxmllint\fR +accepts the following options (in alphabetical order): .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 +\fBlibxml\fR(3) +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\&. - +Test the internal copy implementation. .TP -\fB\-\-noent\fR -Substitute entity values for entity references\&. By default, xmllint leaves entity references in place\&. - -.TP -\fB\-\-nocdata\fR -Substitute CDATA section by equivalent text nodes\&. - -.TP -\fB\-\-nsclean\fR -Remove redundant namespace declarations\&. - +\fB\-\-c14n\fR +Use the W3C XML Canonicalisation (C14N) to serialize the result of parsing to +\fIstdout\fR. It keeps comments in the result. +.TP +\fB\-\-dtdvalid \fR\fB\fIURL\fR\fR +Use the +DTD +specified by an +\fIURL\fR +for validation. +.TP +\fB\-\-dtdvalidfpi \fR\fB\fIFPI\fR\fR +Use the +DTD +specified by a Public Identifier +\fIFPI\fR +for validation, note that this will require a Catalog exporting that Public Identifier to work. .TP -\fB\-\-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 \fR\fB\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 \fR\fB\fINNBYTES\fR\fR +Test the parser memory support. +\fINNBYTES\fR +is the maximum number of bytes the library is allowed to allocate. This can also be used to make sure batch processing of +XML +files will not exhaust the virtual memory of the server running them. .TP -\fB\-\-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\&. - +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 \fR\fB\fIFILE\fR\fR +Define a file path where +\fBxmllint\fR +will save the result of parsing. Usually the programs build a tree and save it on +\fIstdout\fR, with this option the result +XML +instance will be saved onto a file. .TP -\fB\-\-catalogs\fR -Use the catalogs from $SGML_CATALOG_FILES\&. Otherwise /etc/xml/catalog is used by default\&. - +\fB\-\-path "\fR\fB\fIPATH(S)\fR\fR\fB"\fR +Use the (space\- or colon\-separated) list of filesystem paths specified by +\fIPATHS\fR +to load +DTDs or entities. Enclose space\-separated lists by quotation marks. .TP -\fB\-\-nocatalogs\fR -Do not use any catalogs\&. - +\fB\-\-pattern \fR\fB\fIPATTERNVALUE\fR\fR +Used to exercise the pattern recognition engine, which can be used with the reader interface to the parser. It allows to select some nodes in the document based on an XPath (subset) expression. Used for debugging. .TP -\fB\-\-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 \fR\fB\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 \fR\fB\fISCHEMA\fR\fR +Use a W3C XML Schema file named +\fISCHEMA\fR +for validation. +.TP +\fB\-\-shell\fR +Run a navigating shell. Details on available commands in shell mode are below (see +the section called \(lqSHELL COMMANDS\(rq). .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\-\-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\-\-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\-\-version\fR +Display the version of +\fBlibxml\fR(3) +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\&. - -.SH "SHELL" - +\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 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 \fR\fB\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 \fR\fB\fIPATH\fR\fR +Change the current node to the given path (if unique) or root if no argument is given. .TP -\fBdir \fIpath\fR\fR -Dumps information about the node (namespace, attributes, content)\&. - +\fBdir \fR\fB\fIPATH\fR\fR +Dumps information about the node (namespace, attributes, content). .TP -\fBdu \fIpath\fR\fR -Show the structure of the subtree under path or the current node\&. - +\fBdu \fR\fB\fIPATH\fR\fR +Show the structure of the subtree under the given path or the current node. .TP \fBexit\fR -Leave the shell\&. - +Leave the shell. .TP \fBhelp\fR -Show this help\&. - +Show this help. .TP \fBfree\fR -Display memory usage\&. - +Display memory usage. .TP -\fBload \fIname\fR\fR -Load a new document with the given name\&. - +\fBload \fR\fB\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 \fR\fB\fIPATH\fR\fR +List contents of the given path or the current directory. .TP \fBpwd\fR -Display the path to the current node\&. - +Display the path to the current node. .TP \fBquit\fR -Leave the shell\&. - +Leave the shell. .TP -\fBsave \fIname\fR\fR -Saves the current document to \fIname\fR if given or to the original name\&. - +\fBsave \fR\fB\fIFILENAME\fR\fR +Save the current document to the given filename or to the original name. .TP \fBvalidate\fR -Check the document for error\&. - -.TP -\fBwrite \fIname\fR\fR -Write the current node to the given filename\&. - -.SH "CATALOGS" - -.PP -Catalog behavior can be changed by redirecting queries to the user's own set of catalogs\&. This can be done by setting the \fIXML_CATALOG_FILES\fR environment variable to a list of catalogs\&. An empty one should deactivate loading the default \fI/etc/xml/catalog\fR default catalog\&. - -.SH "DEBUGGING CATALOGS" - -.PP -Setting the environment variable \fIXML_DEBUG_CATALOG\fR using the command \fB"export XML_DEBUG_CATALOG="\fR outputs debugging information related to catalog operations\&. - -.SH "ERROR RETURN CODES" - +Check the document for errors. +.TP +\fBwrite \fR\fB\fIFILENAME\fR\fR +Write the current node to the given filename. +.SH "ENVIRONMENT" +.TP +\fBSGML_CATALOG_FILES\fR +to be written ... +.TP +\fBXML_CATALOG_FILES\fR +Catalog behavior can be changed by redirecting queries to the user's own set of catalogs. This can be done by setting the +\fBXML_CATALOG_FILES\fR +environment variable to a list of catalogs. An empty one should deactivate loading the default +\fI/etc/xml/catalog\fR +default catalog. +.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 +to be written ... +.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 -Error in DTD - +\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. +.SH "SEE ALSO" +.PP +\fBlibxml\fR(3) +.SH "AUTHOR" +John Fleck <jfleck@inkstain.net>, Ziying Sherwin <sherwin@nlm.nih.gov>, Heiko Rupp <hwr@pilhuhn.de>. |