embedaddon/libxml2/doc/xmllint.html - view

File: [ELWIX - Embedded LightWeight unIX -] / embedaddon / libxml2 / doc / xmllint.html
Revision 1.1.1.1 (vendor branch): download - view: text, annotated - select for diffs - revision graph
Tue Feb 21 23:37:59 2012 UTC (12 years, 8 months ago) by misho
Branches: libxml2, MAIN
CVS tags: v2_9_1p0, v2_9_1, v2_8_0p0, v2_8_0, v2_7_8, HEAD

libxml2

<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>xmllint — command line XML tool</div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><tt class="command">xmllint</tt> [[--version] | [--debug] | [--shell] | [--debugent] | [--copy] | [--recover] | [--noent] | [--noout] | [--nonet] | [--htmlout] | [--nowrap] | [--valid] | [--postvalid] | [--dtdvalid <tt>URL</tt>] | [--dtdvalidfpi <tt>FPI</tt>] | [--timing] | [--output <tt>file</tt>] | [--repeat] | [--insert] | [--compress] | [--html] | [--xmlout] | [--push] | [--memory] | [--maxmem <tt>nbbytes</tt>] | [--nowarning] | [--noblanks] | [--nocdata] | [--format] | [--encode <tt>encoding</tt>] | [--dropdtd] | [--nsclean] | [--testIO] | [--catalogs] | [--nocatalogs] | [--auto] | [--xinclude] | [--noxincludenode] | [--loaddtd] | [--dtdattr] | [--stream] | [--walker] | [--pattern <tt>patternvalue</tt>] | [--chkregister] | [--relaxng] | [--schema] | [--c14n]] [<tt class="option"><tt>xmlfile</tt></tt>]</div></div><div class="refsect1" lang="en"><a name="introduction"></a><h2>Introduction</h2> The xmllint program parses one or more XML files, specified on the command line as <tt>xmlfile</tt>. 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.  It is included in libxml2. </div><div class="refsect1" lang="en"><a name="options"></a><h2>Options</h2><div class="variablelist"><dl><dt><tt class="option">--version</tt></dt><dd> Display the version of libxml2 used. </dd><dt><tt class="option">--debug</tt></dt><dd> Parse a file and output an annotated tree of the in-memory version of the document. </dd><dt><tt class="option">--shell</tt></dt><dd> Run a navigating shell. Details on available commands in shell mode are below. </dd><dt><tt class="option">--debugent</tt></dt><dd> Debug the entities defined in the document. </dd><dt><tt class="option">--copy</tt> </dt><dd> Test the internal copy implementation. </dd><dt><tt class="option">--recover</tt></dt><dd> Output any parsable portions of an invalid document. </dd><dt><tt class="option">--noent</tt></dt><dd> Substitute entity values for entity references. By default, xmllint leaves entity references in place. </dd><dt><tt class="option">--nocdata</tt></dt><dd> Substitute CDATA section by equivalent text nodes. </dd><dt><tt class="option">--nsclean</tt></dt><dd> Remove redundant namespace declarations. </dd><dt><tt class="option">--noout</tt></dt><dd> Suppress output. By default, xmllint outputs the result tree. </dd><dt><tt class="option">--htmlout</tt></dt><dd> 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. </dd><dt><tt class="option">--nowrap </tt></dt><dd> Do not output HTML doc wrapper. </dd><dt><tt class="option">--valid </tt></dt><dd> 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 <tt class="option">--dtdvalid</tt> option. By default, xmllint also checks to determine if the document is well-formed. </dd><dt><tt class="option">--postvalid</tt></dt><dd> Validate after parsing is completed. </dd><dt> <tt class="option">--dtdvalid</tt> <tt>URL</tt></dt><dd> Use the DTD specified by <tt>URL</tt> for validation. </dd><dt> <tt class="option">--dtdvalidfpi</tt> <tt>FPI</tt></dt><dd> Use the DTD specified by the Public Identifier <tt>FPI</tt> for validation, note that this will require a Catalog exporting that Public Identifier to work. </dd><dt><tt class="option">--timing</tt></dt><dd> Output information about the time it takes xmllint to perform the various steps. </dd><dt><tt class="option">--output</tt> <tt>file</tt></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><tt class="option">--repeat</tt></dt><dd> Repeat 100 times, for timing or profiling. </dd><dt><tt class="option">--insert</tt></dt><dd> Test for valid insertions. </dd><dt><tt class="option">--compress</tt></dt><dd> Turn on gzip compression of output. </dd><dt><tt class="option">--html</tt></dt><dd> Use the HTML parser. </dd><dt><tt class="option">--xmlout</tt></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><tt class="option">--push</tt></dt><dd> Use the push mode of the parser. </dd><dt><tt class="option">--memory</tt></dt><dd> Parse from memory. </dd><dt><tt class="option">--maxmem</tt> <tt>nnbytes</tt></dt><dd>Test the parser memory support. <tt>nnbytes</tt> 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><tt class="option">--nowarning</tt></dt><dd> Do not emit warnings from the parser and/or validator. </dd><dt><tt class="option">--noblanks</tt></dt><dd> Drop ignorable blank spaces. </dd><dt><tt class="option">--format</tt></dt><dd> Reformat and reindent the output. The $XMLLINT_INDENT environment variable controls the indentation (default value is two spaces " "). </dd><dt><tt class="option">--testIO</tt></dt><dd> Test user input/output support. </dd><dt><tt class="option">--encode</tt> <tt>encoding</tt></dt><dd> Output in the given encoding. </dd><dt><tt class="option">--catalogs</tt></dt><dd> Use the catalogs from $SGML_CATALOG_FILES. Otherwise /etc/xml/catalog is used by default. </dd><dt><tt class="option">--nocatalogs</tt></dt><dd> Do not use any catalogs. </dd><dt><tt class="option">--auto</tt></dt><dd> Generate a small document for testing purposes. </dd><dt><tt class="option">--xinclude</tt></dt><dd> Do XInclude processing. </dd><dt><tt class="option">--noxincludenode</tt></dt><dd> Do XInclude processing but do not generate XInclude start and end nodes. </dd><dt><tt class="option">--loaddtd</tt></dt><dd> Fetch external DTD. </dd><dt><tt class="option">--dtdattr</tt></dt><dd> Fetch external DTD and populate the tree with inherited attributes. </dd><dt><tt class="option">--dropdtd</tt></dt><dd> Remove DTD from output. </dd><dt><tt class="option">--stream</tt></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><tt class="option">--walker</tt></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><tt class="option">--chkregister</tt></dt><dd>Turn on node registration. Useful for developers testing libxml2 node tracking code.</dd><dt><tt class="option">--pattern</tt> <tt>patternvalue</tt></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><tt class="option">--relaxng</tt> <tt>schema</tt></dt><dd>Use RelaxNG file named <tt>schema</tt> for validation.</dd><dt><tt class="option">--schema</tt> <tt>schema</tt></dt><dd>Use a W3C XML Schema file named <tt>schema</tt> for validation.</dd><dt> <tt class="option">--c14n</tt></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> xmllint offers an interactive shell mode invoked with the <tt class="option">--shell</tt> command. Available commands in shell mode include: <div class="variablelist"><dl><dt><tt class="option">base</tt></dt><dd> display XML base of the node </dd><dt><tt class="option">bye</tt></dt><dd> leave shell </dd><dt><tt class="option">cat <tt>node</tt></tt></dt><dd> Display node if given or current node. </dd><dt><tt class="option">cd <tt>path</tt></tt></dt><dd> Change the current node to <tt>path</tt> (if given and unique) or root if no argument given. </dd><dt><tt class="option">dir <tt>path</tt></tt></dt><dd> Dumps information about the node (namespace, attributes, content). </dd><dt><tt class="option">du <tt>path</tt></tt></dt><dd> Show the structure of the subtree under path or the current node. </dd><dt><tt class="option">exit</tt></dt><dd> Leave the shell. </dd><dt><tt class="option">help</tt></dt><dd> Show this help. </dd><dt><tt class="option">free</tt></dt><dd> Display memory usage. </dd><dt><tt class="option">load <tt>name</tt></tt></dt><dd> Load a new document with the given name. </dd><dt><tt class="option">ls <tt>path</tt></tt></dt><dd> List contents of <tt>path</tt> (if given) or the current directory. </dd><dt><tt class="option">pwd</tt></dt><dd> Display the path to the current node. </dd><dt><tt class="option">quit</tt></dt><dd> Leave the shell. </dd><dt><tt class="option">save <tt>name</tt></tt></dt><dd> Saves the current document to <tt>name</tt> if given or to the original name. </dd><dt><tt class="option">validate</tt></dt><dd> Check the document for error. </dd><dt><tt class="option">write <tt>name</tt></tt></dt><dd> Write the current node to the given filename. </dd></dl></div></div><div class="refsect1" lang="en"><h2>Catalogs</h2>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.</div><div class="refsect1" lang="en"><h2>Debugging Catalogs</h2>Setting the environment variable <tt class="varname">XML_DEBUG_CATALOG</tt> using the command "export XML_DEBUG_CATALOG=" outputs debugging information related to catalog operations.</div><div class="refsect1" lang="en"><h2>Error Return Codes</h2>On the completion of execution, Xmllint returns the following error codes:<div class="variablelist"><dl><dt>0</dt><dd>No error</dd><dt>1</dt><dd>Unclassified</dd><dt>2</dt><dd>Error in DTD</dd><dt>3</dt><dd>Validation error</dd><dt>4</dt><dd>Validation error</dd><dt>5</dt><dd>Error in schema compilation</dd><dt>6</dt><dd>Error writing output</dd><dt>7</dt><dd>Error in pattern (generated when [--pattern] option is used)</dd><dt>8</dt><dd>Error in Reader registration (generated when [--chkregister] option is used)</dd><dt>9</dt><dd>Out of memory error</dd></dl></div></div></div></body></html>