One Hat Cyber Team

Edit File: xmllint.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 Vsnapshot"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry"><a name="idm1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2>xmllint &#8212; command line <acronym class="acronym">XML</acronym> tool</div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><code class="command">xmllint</code> [ <code class="option">--version</code> | <code class="option">--debug</code> | <code class="option">--quiet</code> | <code class="option">--shell</code> | <code class="option">--xpath "<code>XPath_expression</code>"</code> | <code class="option">--debugent</code> | <code class="option">--copy</code> | <code class="option">--recover</code> | <code class="option">--nodict</code> | <code class="option">--noent</code> | <code class="option">--noout</code> | <code class="option">--nonet</code> | <code class="option">--path "<code>PATH(S)</code>"</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 <code>URL</code></code> | <code class="option">--dtdvalidfpi <code>FPI</code></code> | <code class="option">--timing</code> | <code class="option">--output <code>FILE</code></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">--max-ampl <code>INTEGER</code></code> | <code class="option">--maxmem <code>NBBYTES</code></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 <code>ENCODING</code></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 <code>PATTERNVALUE</code></code> | <code class="option">--relaxng <code>SCHEMA</code></code> | <code class="option">--schema <code>SCHEMA</code></code> | <code class="option">--c14n</code> | <code class="option">--pedantic</code> ] { <code>XML-FILE(S)</code>... | - }</div><div class="cmdsynopsis"><code class="command">xmllint</code> <code class="option">--help</code> </div></div><div class="refsect1"><a name="description"></a><h2>DESCRIPTION</h2>
 The xmllint program parses one or more <acronym class="acronym">XML</acronym> files,
 specified on the command line as <code>XML-FILE</code>
 (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 class="acronym">XML</acronym> code and in
 the <acronym class="acronym">XML</acronym> parser itself.
 xmllint is included in libxml(3).</div><div class="refsect1"><a name="options"></a><h2>OPTIONS</h2>
 xmllint accepts the following options (in alphabetical order):
 <div class="variablelist"><dl class="variablelist"><dt><code class="option">--auto</code></dt><dd>Generate a small document for testing purposes.</dd><dt><code class="option">--catalogs</code></dt><dd>
 Use the <acronym class="acronym">SGML</acronym> catalog(s) from <code class="envar">SGML_CATALOG_FILES</code>.
 Otherwise <acronym class="acronym">XML</acronym> catalogs starting
 from <code class="filename">/etc/xml/catalog</code> or, more specifically,
 <code class="filename">${sysconfdir}/xml/catalog</code> are used by default.
 </dd><dt><code class="option">--compress</code></dt><dd>
 Turn on gzip(1) compression of output.
 </dd><dt><code class="option">--copy</code></dt><dd>Test the internal copy implementation.</dd><dt><code class="option">--c14n</code></dt><dd>
 Use the W3C <acronym class="acronym">XML</acronym> Canonicalisation (<acronym class="acronym">C14N</acronym>) to
 serialize the result of parsing to <code class="filename">stdout</code>.
 It keeps comments in the result.
 </dd><dt><code class="option">--dtdvalid <code>URL</code></code></dt><dd>
 Use the <acronym class="acronym">DTD</acronym> specified by
 an <code>URL</code> for validation.
 </dd><dt><code class="option">--dtdvalidfpi <code>FPI</code></code></dt><dd>
 Use the <acronym class="acronym">DTD</acronym> specified by a Formal Public
 Identifier <code>FPI</code> for validation, note that this
 will require a catalog exporting that Formal Public Identifier to work.
 </dd><dt><code class="option">--debug</code></dt><dd>
 Parse a file and output an annotated tree of the
 in-memory version of the document.
 </dd><dt><code class="option">--debugent</code></dt><dd>Debug the entities defined in the document.</dd><dt><code class="option">--dropdtd</code></dt><dd>Remove <acronym class="acronym">DTD</acronym> from output.</dd><dt><code class="option">--dtdattr</code></dt><dd>
 Fetch external <acronym class="acronym">DTD</acronym> and populate the tree with
 inherited attributes.
 </dd><dt><code class="option">--encode <code>ENCODING</code></code></dt><dd>Output in the given encoding. Note that this works for full document not fragments or result from XPath queries.</dd><dt><code class="option">--format</code></dt><dd>
 Reformat and reindent the output. The <code class="envar">XMLLINT_INDENT</code>
 environment variable controls the indentation. The default value is two
 spaces " ").
 </dd><dt><code class="option">--help</code></dt><dd>Print out a short usage summary for xmllint.</dd><dt><code class="option">--html</code></dt><dd>Use the <acronym class="acronym">HTML</acronym> parser.</dd><dt><code class="option">--htmlout</code></dt><dd>
 Output results as an <acronym class="acronym">HTML</acronym> file. This
 causes xmllint to output the necessary <acronym class="acronym">HTML</acronym>
 tags surrounding the result tree output so the results can be
 displayed/viewed in a browser.
 </dd><dt><code class="option">--insert</code></dt><dd>Test for valid insertions.</dd><dt><code class="option">--loaddtd</code></dt><dd>Fetch an external <acronym class="acronym">DTD</acronym>.</dd><dt><code class="option">--load-trace</code></dt><dd>
 Display all the documents loaded during the processing
 to <code class="filename">stderr</code>.
 </dd><dt><code class="option">--max-ampl <code>INTEGER</code></code></dt><dd>
 Set the maximum amplification factor which protects against
 exponential entity expansion ("billion laughs"). The default value
 is 5. Documents making heavy use of entity expansion may require a
 higher value.
 </dd><dt><code class="option">--maxmem <code>NNBYTES</code></code></dt><dd>
 Test the parser memory support. <code>NNBYTES</code>
 is the maximum number of bytes the library is allowed to allocate.
 This can also be used to make sure batch processing
 of <acronym class="acronym">XML</acronym> files will not exhaust the virtual memory
 of the server running them.
 </dd><dt><code class="option">--memory</code></dt><dd>Parse from memory.</dd><dt><code class="option">--noblanks</code></dt><dd>Drop ignorable blank spaces.</dd><dt><code class="option">--nocatalogs</code></dt><dd>Do not use any catalogs.</dd><dt><code class="option">--nocdata</code></dt><dd>Substitute CDATA section by equivalent text nodes.</dd><dt><code class="option">--nodict</code></dt><dd>
 Don't use dictionaries (parser option XML_PARSE_NODICT).
 Only for debugging.
 </dd><dt><code class="option">--noent</code></dt><dd>
 Substitute entity values for entity references. By default, xmllint
 leaves entity references in place.
 </dd><dt><code class="option">--nonet</code></dt><dd>
 Do not use the Internet to fetch <acronym class="acronym">DTD</acronym>s or entities.
 </dd><dt><code class="option">--noout</code></dt><dd>
 Suppress output. By default, xmllint outputs the result tree.
 </dd><dt><code class="option">--nowarning</code></dt><dd>Do not emit warnings from the parser and/or validator.</dd><dt><code class="option">--nowrap</code></dt><dd>Do not output <acronym class="acronym">HTML</acronym> doc wrapper.</dd><dt><code class="option">--noxincludenode</code></dt><dd>
 Do XInclude processing but do not generate XInclude start and end nodes.
 </dd><dt><code class="option">--nsclean</code></dt><dd>Remove redundant namespace declarations.</dd><dt><code class="option">--output <code>FILE</code></code></dt><dd>
 Define a file path where xmllint 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 <acronym class="acronym">XML</acronym> instance will be saved onto a file.
 </dd><dt><code class="option">--path "<code>PATH(S)</code>"</code></dt><dd>
 Use the (space- or colon-separated) list of filesystem paths specified
 by <code>PATHS</code> to load <acronym class="acronym">DTD</acronym>s or
 entities. Enclose space-separated lists by quotation marks.
 </dd><dt><code class="option">--pattern <code>PATTERNVALUE</code></code></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><code class="option">--pedantic</code></dt><dd>Enable additional warnings.</dd><dt><code class="option">--postvalid</code></dt><dd>Validate after parsing has completed.</dd><dt><code class="option">--push</code></dt><dd>Use the push mode of the parser.</dd><dt><code class="option">--quiet</code></dt><dd>Don't print informational messages to stderr.</dd><dt><code class="option">--recover</code></dt><dd>Output any parsable portions of an invalid document.</dd><dt><code class="option">--relaxng <code>SCHEMA</code></code></dt><dd>
 Use RelaxNG file named <code>SCHEMA</code>
 for validation.
 </dd><dt><code class="option">--repeat</code></dt><dd>Repeat 100 times, for timing or profiling.</dd><dt><code class="option">--schema <code>SCHEMA</code></code></dt><dd>
 Use a W3C <acronym class="acronym">XML</acronym> Schema file
 named <code>SCHEMA</code> for validation.
 </dd><dt><code class="option">--shell</code></dt><dd>
 Run a navigating shell. Details on available commands in shell mode
 are below (see <a class="xref" href="#shell" title="SHELL COMMANDS">the section called &#8220;SHELL COMMANDS&#8221;</a>).
 </dd><dt><code class="option">--xpath "<code>XPath_expression</code>"</code></dt><dd>
 Run an XPath expression given as argument and print the
 result. In case of a nodeset result, each node in the
 node set is serialized in full in the output. In case
 of an empty node set the "XPath set is empty" result
 will be shown and exit code 11 will be returned..
 This feature is EXPERIMENTAL. Implementation details can
 change without futher notice.
 </dd><dt><code class="option">--stream</code></dt><dd>
 Use streaming <acronym class="acronym">API</acronym> - 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.
 </dd><dt><code class="option">--testIO</code></dt><dd>Test user input/output support.</dd><dt><code class="option">--timing</code></dt><dd>
 Output information about the time it takes xmllint to perform the
 various steps.
 </dd><dt><code class="option">--valid</code></dt><dd>
 Determine if the document is a valid instance of the included
 Document Type Definition (<acronym class="acronym">DTD</acronym>).
 A <acronym class="acronym">DTD</acronym> to be validated against also can be
 specified at the command line using the <code class="option">--dtdvalid</code>
 option. By default, xmllint also checks to determine if the
 document is well-formed.
 </dd><dt><code class="option">--version</code></dt><dd>
 Display the version of libxml(3) used.
 </dd><dt><code class="option">--walker</code></dt><dd>
 Test the walker module, which is a reader interface but for a
 document tree, instead of using the reader <acronym class="acronym">API</acronym> on
 an unparsed document it works on an existing in-memory tree. Used for
 debugging.
 </dd><dt><code class="option">--xinclude</code></dt><dd>Do XInclude processing.</dd><dt><code class="option">--xmlout</code></dt><dd>
 Used in conjunction with <code class="option">--html</code>. Usually
 when <acronym class="acronym">HTML</acronym> is parsed the document is saved with
 the <acronym class="acronym">HTML</acronym> serializer. But with this option the
 resulting document is saved with the <acronym class="acronym">XML</acronym>
 serializer. This is primarily used to
 generate <acronym class="acronym">XHTML</acronym> from <acronym class="acronym">HTML</acronym> input.
 </dd></dl></div></div><div class="refsect1"><a name="shell"></a><h2>SHELL COMMANDS</h2>
 xmllint offers an interactive shell mode invoked with
 the <code class="option">--shell</code> command. Available commands in shell mode
 include (in alphabetical order):
 <div class="variablelist"><dl class="variablelist"><dt>base</dt><dd>Display <acronym class="acronym">XML</acronym> base of the node.</dd><dt>bye</dt><dd>Leave the shell.</dd><dt>cat <code>NODE</code></dt><dd>Display the given node or the current one.</dd><dt>cd <code>PATH</code></dt><dd>
 Change the current node to the given path (if unique) or root if no
 argument is given.
 </dd><dt>dir <code>PATH</code></dt><dd>
 Dumps information about the node (namespace, attributes, content).
 </dd><dt>du <code>PATH</code></dt><dd>
 Show the structure of the subtree under the given path or the current node.
 </dd><dt>exit</dt><dd>Leave the shell.</dd><dt>help</dt><dd>Show this help.</dd><dt>load <code>FILENAME</code></dt><dd>Load a new document with the given filename.</dd><dt>ls <code>PATH</code></dt><dd>List contents of the given path or the current directory.</dd><dt>pwd</dt><dd>Display the path to the current node.</dd><dt>quit</dt><dd>Leave the shell.</dd><dt>save <code>FILENAME</code></dt><dd>
 Save the current document to the given filename or to the original name.
 </dd><dt><code class="option">validate</code></dt><dd>Check the document for errors.</dd><dt>write <code>FILENAME</code></dt><dd>Write the current node to the given filename.</dd></dl></div></div><div class="refsect1"><a name="environment"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl class="variablelist"><dt><code class="envar">SGML_CATALOG_FILES</code></dt><dd><acronym class="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 <code class="envar">SGML_CATALOG_FILES</code> environment variable to a list
 of catalogs. An empty one should deactivate loading the
 default catalog.
 </dd><dt><code class="envar">XML_CATALOG_FILES</code></dt><dd><acronym class="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 <code class="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.
 </dd><dt><code class="envar">XML_DEBUG_CATALOG</code></dt><dd>Setting the environment variable <code class="envar">XML_DEBUG_CATALOG</code>
 to <code>non-zero</code> using the export
 command outputs debugging information related to catalog operations.
 </dd><dt><code class="envar">XMLLINT_INDENT</code></dt><dd>Setting the environment variable <code class="envar">XMLLINT_INDENT</code>
 controls the indentation. The default value is two spaces " ".
 </dd></dl></div></div><div class="refsect1"><a name="diagnostics"></a><h2>DIAGNOSTICS</h2>
 xmllint return codes provide information that can be used when
 calling it from scripts.
 <div class="variablelist"><dl class="variablelist"><dt>0</dt><dd>No error</dd><dt>1</dt><dd>Unclassified</dd><dt>2</dt><dd>Error in <acronym class="acronym">DTD</acronym></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 <code class="option">--pattern</code> option is used)
 </dd><dt>9</dt><dd>Out of memory error</dd><dt>10</dt><dd>XPath evaluation error</dd><dt>11</dt><dd>XPath result is empty</dd></dl></div></div><div class="refsect1"><a name="seealso"></a><h2>SEE ALSO</h2>libxml(3)
 
 More information can be found at
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">libxml(3) web page <a class="ulink" href="https://gitlab.gnome.org/GNOME/libxml2" target="_top">https://gitlab.gnome.org/GNOME/libxml2</a>
 </li></ul></div>
 </div></div></body></html>