The <spanclass="command"><strong>xmllint</strong></span> program parses one or more <acronymclass="acronym">XML</acronym> files,
specified on the command line as <emclass="replaceable"><code>XML-FILE</code></em>
(or the standard input if the filename provided
is <spanclass="bold"><strong>-</strong></span> ). It prints various types of
output, depending upon the options selected. It is useful for detecting
errors both in <acronymclass="acronym">XML</acronym> code and in
the <acronymclass="acronym">XML</acronym> parser itself.
</p><p><spanclass="command"><strong>xmllint</strong></span> is included in <spanclass="citerefentry"><spanclass="refentrytitle">libxml</span>(3)</span>.</p></div><divclass="refsect1"><aname="options"></a><h2>OPTIONS</h2><p>
<spanclass="command"><strong>xmllint</strong></span> accepts the following options (in alphabetical order):
</p><divclass="variablelist"><dlclass="variablelist"><dt><spanclass="term"><codeclass="option">--auto</code></span></dt><dd><p>Generate a small document for testing purposes.</p></dd><dt><spanclass="term"><codeclass="option">--catalogs</code></span></dt><dd><p>
Use the <acronymclass="acronym">SGML</acronym> catalog(s) from <codeclass="envar">SGML_CATALOG_FILES</code>.
Turn on <spanclass="citerefentry"><spanclass="refentrytitle">gzip</span>(1)</span> compression of output.
</p></dd><dt><spanclass="term"><codeclass="option">--copy</code></span></dt><dd><p>Test the internal copy implementation.</p></dd><dt><spanclass="term"><codeclass="option">--c14n</code></span></dt><dd><p>
Use the W3C <acronymclass="acronym">XML</acronym> Canonicalisation (<acronymclass="acronym">C14N</acronym>) to
serialize the result of parsing to <codeclass="filename">stdout</code>.
</p></dd><dt><spanclass="term"><codeclass="option">--debugent</code></span></dt><dd><p>Debug the entities defined in the document.</p></dd><dt><spanclass="term"><codeclass="option">--dropdtd</code></span></dt><dd><p>Remove <acronymclass="acronym">DTD</acronym> from output.</p></dd><dt><spanclass="term"><codeclass="option">--dtdattr</code></span></dt><dd><p>
Fetch external <acronymclass="acronym">DTD</acronym> and populate the tree with
inherited attributes.
</p></dd><dt><spanclass="term"><codeclass="option">--encode <emclass="replaceable"><code>ENCODING</code></em></code></span></dt><dd><p>Output in the given encoding. Note that this works for full document not fragments or result from XPath queries.</p></dd><dt><spanclass="term"><codeclass="option">--format</code></span></dt><dd><p>
Reformat and reindent the output. The <codeclass="envar">XMLLINT_INDENT</code>
environment variable controls the indentation. The default value is two
spaces " ").
</p></dd><dt><spanclass="term"><codeclass="option">--help</code></span></dt><dd><p>Print out a short usage summary for <spanclass="command"><strong>xmllint</strong></span>.</p></dd><dt><spanclass="term"><codeclass="option">--html</code></span></dt><dd><p>Use the <acronymclass="acronym">HTML</acronym> parser.</p></dd><dt><spanclass="term"><codeclass="option">--htmlout</code></span></dt><dd><p>
Output results as an <acronymclass="acronym">HTML</acronym> file. This
causes <spanclass="command"><strong>xmllint</strong></span> to output the necessary <acronymclass="acronym">HTML</acronym>
tags surrounding the result tree output so the results can be
displayed/viewed in a browser.
</p></dd><dt><spanclass="term"><codeclass="option">--insert</code></span></dt><dd><p>Test for valid insertions.</p></dd><dt><spanclass="term"><codeclass="option">--loaddtd</code></span></dt><dd><p>Fetch an external <acronymclass="acronym">DTD</acronym>.</p></dd><dt><spanclass="term"><codeclass="option">--load-trace</code></span></dt><dd><p>
Display all the documents loaded during the processing
Test the parser memory support. <emclass="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 <acronymclass="acronym">XML</acronym> files will not exhaust the virtual memory
of the server running them.
</p></dd><dt><spanclass="term"><codeclass="option">--memory</code></span></dt><dd><p>Parse from memory.</p></dd><dt><spanclass="term"><codeclass="option">--noblanks</code></span></dt><dd><p>Drop ignorable blank spaces.</p></dd><dt><spanclass="term"><codeclass="option">--nocatalogs</code></span></dt><dd><p>Do not use any catalogs.</p></dd><dt><spanclass="term"><codeclass="option">--nocdata</code></span></dt><dd><p>Substitute CDATA section by equivalent text nodes.</p></dd><dt><spanclass="term"><codeclass="option">--nodict</code></span></dt><dd><p>
Don't use dictionaries (parser option XML_PARSE_NODICT).
Suppress output. By default, <spanclass="command"><strong>xmllint</strong></span> outputs the result tree.
</p></dd><dt><spanclass="term"><codeclass="option">--nowarning</code></span></dt><dd><p>Do not emit warnings from the parser and/or validator.</p></dd><dt><spanclass="term"><codeclass="option">--nowrap</code></span></dt><dd><p>Do not output <acronymclass="acronym">HTML</acronym> doc wrapper.</p></dd><dt><spanclass="term"><codeclass="option">--noxincludenode</code></span></dt><dd><p>
Do XInclude processing but do not generate XInclude start and end nodes.
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><spanclass="term"><codeclass="option">--pedantic</code></span></dt><dd><p>Enable additional warnings.</p></dd><dt><spanclass="term"><codeclass="option">--postvalid</code></span></dt><dd><p>Validate after parsing has completed.</p></dd><dt><spanclass="term"><codeclass="option">--push</code></span></dt><dd><p>Use the push mode of the parser.</p></dd><dt><spanclass="term"><codeclass="option">--quiet</code></span></dt><dd><p>Don't print informational messages to stderr.</p></dd><dt><spanclass="term"><codeclass="option">--recover</code></span></dt><dd><p>Output any parsable portions of an invalid document.</p></dd><dt><spanclass="term"><codeclass="option">--relaxng <emclass="replaceable"><code>SCHEMA</code></em></code></span></dt><dd><p>
Use RelaxNG file named <emclass="replaceable"><code>SCHEMA</code></em>
for validation.
</p></dd><dt><spanclass="term"><codeclass="option">--repeat</code></span></dt><dd><p>Repeat 100 times, for timing or profiling.</p></dd><dt><spanclass="term"><codeclass="option">--schema <emclass="replaceable"><code>SCHEMA</code></em></code></span></dt><dd><p>
Use a W3C <acronymclass="acronym">XML</acronym> Schema file
named <emclass="replaceable"><code>SCHEMA</code></em> for validation.
Use streaming <acronymclass="acronym">API</acronym> - useful when used in combination
with <codeclass="option">--relaxng</code> or <codeclass="option">--valid</code> options
for validation of files that are too large to be held in memory.
</p></dd><dt><spanclass="term"><codeclass="option">--testIO</code></span></dt><dd><p>Test user input/output support.</p></dd><dt><spanclass="term"><codeclass="option">--timing</code></span></dt><dd><p>
Output information about the time it takes <spanclass="command"><strong>xmllint</strong></span> to perform the
<spanclass="command"><strong>xmllint</strong></span> offers an interactive shell mode invoked with
the <codeclass="option">--shell</code> command. Available commands in shell mode
include (in alphabetical order):
</p><divclass="variablelist"><dlclass="variablelist"><dt><spanclass="term"><spanclass="command"><strong>base</strong></span></span></dt><dd><p>Display <acronymclass="acronym">XML</acronym> base of the node.</p></dd><dt><spanclass="term"><spanclass="command"><strong>bye</strong></span></span></dt><dd><p>Leave the shell.</p></dd><dt><spanclass="term"><spanclass="command"><strong>cat <emclass="replaceable"><code>NODE</code></em></strong></span></span></dt><dd><p>Display the given node or the current one.</p></dd><dt><spanclass="term"><spanclass="command"><strong>cd <emclass="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
Show the structure of the subtree under the given path or the current node.
</p></dd><dt><spanclass="term"><spanclass="command"><strong>exit</strong></span></span></dt><dd><p>Leave the shell.</p></dd><dt><spanclass="term"><spanclass="command"><strong>help</strong></span></span></dt><dd><p>Show this help.</p></dd><dt><spanclass="term"><spanclass="command"><strong>free</strong></span></span></dt><dd><p>Display memory usage.</p></dd><dt><spanclass="term"><spanclass="command"><strong>load <emclass="replaceable"><code>FILENAME</code></em></strong></span></span></dt><dd><p>Load a new document with the given filename.</p></dd><dt><spanclass="term"><spanclass="command"><strong>ls <emclass="replaceable"><code>PATH</code></em></strong></span></span></dt><dd><p>List contents of the given path or the current directory.</p></dd><dt><spanclass="term"><spanclass="command"><strong>pwd</strong></span></span></dt><dd><p>Display the path to the current node.</p></dd><dt><spanclass="term"><spanclass="command"><strong>quit</strong></span></span></dt><dd><p>Leave the shell.</p></dd><dt><spanclass="term"><spanclass="command"><strong>save <emclass="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><spanclass="term"><codeclass="option">validate</code></span></dt><dd><p>Check the document for errors.</p></dd><dt><spanclass="term"><spanclass="command"><strong>write <emclass="replaceable"><code>FILENAME</code></em></strong></span></span></dt><dd><p>Write the current node to the given filename.</p></dd></dl></div></div><divclass="refsect1"><aname="environment"></a><h2>ENVIRONMENT</h2><divclass="variablelist"><dlclass="variablelist"><dt><spanclass="term"><codeclass="envar">SGML_CATALOG_FILES</code></span></dt><dd><p><acronymclass="acronym">SGML</acronym> catalog behavior can be changed by redirecting
queries to the user's own set of catalogs. This can be done by setting
the <codeclass="envar">SGML_CATALOG_FILES</code> environment variable to a list
of catalogs. An empty one should deactivate loading the
default catalog.
</p></dd><dt><spanclass="term"><codeclass="envar">XML_CATALOG_FILES</code></span></dt><dd><p><acronymclass="acronym">XML</acronym> catalog behavior can be changed by redirecting
queries to the user's own set of catalogs. This can be done by setting
the <codeclass="envar">XML_CATALOG_FILES</code> environment variable to a space-separated
list of catalogs. Use percent-encoding to escape spaces or other characters.
An empty variable should deactivate loading the default catalog.
</p></dd><dt><spanclass="term"><codeclass="envar">XML_DEBUG_CATALOG</code></span></dt><dd><p>Setting the environment variable <codeclass="envar">XML_DEBUG_CATALOG</code>
to <emclass="parameter"><code>non-zero</code></em> using the <spanclass="command"><strong>export</strong></span>
command outputs debugging information related to catalog operations.
</p></dd><dt><spanclass="term"><codeclass="envar">XMLLINT_INDENT</code></span></dt><dd><p>Setting the environment variable <codeclass="envar">XMLLINT_INDENT</code>
controls the indentation. The default value is two spaces " ".
