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, 5 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

1: <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> 2: The xmllint program parses one or more XML files, specified on the 3: command line as <tt>xmlfile</tt>. It prints various 4: types of output, depending upon the options selected. It is useful for 5: detecting errors both in XML code and in the 6: XML parser itself. 7:  8: It is included in libxml2. 9: </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> 10: Display the version of 11: libxml2 used. 12: </dd><dt><tt class="option">--debug</tt></dt><dd> 13: Parse a file and output an annotated tree of the 14: in-memory version of the document. 15: </dd><dt><tt class="option">--shell</tt></dt><dd> 16: Run a navigating shell. Details on available commands in shell mode 17: are below. 18: </dd><dt><tt class="option">--debugent</tt></dt><dd> 19: Debug the entities defined in the document. 20: </dd><dt><tt class="option">--copy</tt> </dt><dd> 21: Test the internal copy implementation. 22: </dd><dt><tt class="option">--recover</tt></dt><dd> 23: Output any parsable portions of an invalid 24: document. 25: </dd><dt><tt class="option">--noent</tt></dt><dd> 26: Substitute entity values for entity 27: references. By default, xmllint leaves entity 28: references in place. 29: </dd><dt><tt class="option">--nocdata</tt></dt><dd> 30: Substitute CDATA section by equivalent text nodes. 31: </dd><dt><tt class="option">--nsclean</tt></dt><dd> 32: Remove redundant namespace declarations. 33: </dd><dt><tt class="option">--noout</tt></dt><dd> 34: Suppress output. By default, 35: xmllint outputs the result tree. 36: </dd><dt><tt class="option">--htmlout</tt></dt><dd> 37: Output results as an HTML 38: file. This causes xmllint to output 39: the necessary HTML tags surrounding the result tree 40: output so the results can be displayed in a browser. 41: </dd><dt><tt class="option">--nowrap </tt></dt><dd> 42: Do not output HTML doc wrapper. 43: </dd><dt><tt class="option">--valid </tt></dt><dd> 44: Determine if the document is a valid instance 45: of the included Document Type Definition (DTD). A 46: DTD to be validated against also can be specified at 47: the command line using the <tt class="option">--dtdvalid</tt> option. By default, 48: xmllint also checks to determine if the 49: document is well-formed. 50: </dd><dt><tt class="option">--postvalid</tt></dt><dd> 51: Validate after parsing is completed. 52: </dd><dt> <tt class="option">--dtdvalid</tt> <tt>URL</tt></dt><dd> 53: Use the 54: DTD specified by <tt>URL</tt> for 55: validation. 56: </dd><dt> <tt class="option">--dtdvalidfpi</tt> <tt>FPI</tt></dt><dd> 57: Use the 58: DTD specified by the Public Identifier 59: <tt>FPI</tt> for validation, note that this 60: will require a Catalog exporting that Public Identifier to work. 61: </dd><dt><tt class="option">--timing</tt></dt><dd> 62: Output information about the time it takes 63: xmllint to perform the various steps. 64: </dd><dt><tt class="option">--output</tt> <tt>file</tt></dt><dd>Define a file path where xmllint will save the result of 65: parsing. Usually the programs build a tree and save it on stdout, with 66: this option the result XML instance will be saved onto a file.</dd><dt><tt class="option">--repeat</tt></dt><dd> 67: Repeat 100 times, for timing or profiling. 68: </dd><dt><tt class="option">--insert</tt></dt><dd> 69: Test for valid insertions. 70: </dd><dt><tt class="option">--compress</tt></dt><dd> 71: Turn on gzip compression of output. 72: </dd><dt><tt class="option">--html</tt></dt><dd> 73: Use the HTML parser. 74: </dd><dt><tt class="option">--xmlout</tt></dt><dd>Used in conjunction with <tt class="option">--html</tt>. Usually 75: when HTML is parsed the document is saved with the HTML serializer, but with 76: this option the resulting document is saved with the XML serializer. This is 77: primarily used to generate XHTML from HTML input.</dd><dt><tt class="option">--push</tt></dt><dd> 78: Use the push mode of the parser. 79: </dd><dt><tt class="option">--memory</tt></dt><dd> 80: Parse from memory. 81: </dd><dt><tt class="option">--maxmem</tt> <tt>nnbytes</tt></dt><dd>Test the parser memory 82: support. <tt>nnbytes</tt> is the maximum number of bytes the 83: library is allowed to allocate. This can also be used to make sure batch 84: processing of XML files will not exhaust the virtual memory of the server 85: running them.</dd><dt><tt class="option">--nowarning</tt></dt><dd> 86: Do not emit warnings from the parser and/or validator. 87: </dd><dt><tt class="option">--noblanks</tt></dt><dd> 88: Drop ignorable blank spaces. 89: </dd><dt><tt class="option">--format</tt></dt><dd> 90: Reformat and reindent the output. The $XMLLINT_INDENT 91: environment variable controls the indentation (default 92: value is two spaces " "). 93: </dd><dt><tt class="option">--testIO</tt></dt><dd> 94: Test user input/output support. 95: </dd><dt><tt class="option">--encode</tt> <tt>encoding</tt></dt><dd> 96: Output in the given encoding. 97: </dd><dt><tt class="option">--catalogs</tt></dt><dd> 98: Use the catalogs from $SGML_CATALOG_FILES. Otherwise /etc/xml/catalog 99: is used by default. 100: </dd><dt><tt class="option">--nocatalogs</tt></dt><dd> 101: Do not use any catalogs. 102: </dd><dt><tt class="option">--auto</tt></dt><dd> 103: Generate a small document for testing purposes. 104: </dd><dt><tt class="option">--xinclude</tt></dt><dd> 105: Do XInclude processing. 106: </dd><dt><tt class="option">--noxincludenode</tt></dt><dd> 107: Do XInclude processing but do not generate XInclude start and end 108: nodes. 109: </dd><dt><tt class="option">--loaddtd</tt></dt><dd> 110: Fetch external DTD. 111: </dd><dt><tt class="option">--dtdattr</tt></dt><dd> 112: Fetch external DTD and populate the tree with inherited attributes. 113: </dd><dt><tt class="option">--dropdtd</tt></dt><dd> 114: Remove DTD from output. 115: </dd><dt><tt class="option">--stream</tt></dt><dd>Use streaming API - useful when used in combination with 116: --relaxng or --valid options for validation of files that are 117: 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 118: document tree, instead of using the reader API on an unparsed document it 119: 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 120: 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 121: used with the reader interface to the parser. It allows to select some 122: nodes in the document based on an XPath (subset) expression. Used for 123: debugging.</dd><dt><tt class="option">--relaxng</tt> <tt>schema</tt></dt><dd>Use RelaxNG file named <tt>schema</tt> for 124: 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> 125: <tt class="option">--c14n</tt></dt><dd>Use the W3C XML Canonicalisation (C14N) to 126: serialize the result of parsing to stdout. It keeps comments in 127: the result.</dd></dl></div></div><div class="refsect1" lang="en"><a name="shell"></a><h2>Shell</h2> 128: xmllint offers an interactive shell mode 129: invoked with the <tt class="option">--shell</tt> command. Available commands in 130: shell mode include: 131: <div class="variablelist"><dl><dt><tt class="option">base</tt></dt><dd> 132: display XML base of the node 133: </dd><dt><tt class="option">bye</tt></dt><dd> 134: leave shell 135: </dd><dt><tt class="option">cat <tt>node</tt></tt></dt><dd> 136: Display node if given or current node. 137: </dd><dt><tt class="option">cd <tt>path</tt></tt></dt><dd> 138: Change the current node to <tt>path</tt> (if given 139: and unique) or root if no argument given. 140: </dd><dt><tt class="option">dir <tt>path</tt></tt></dt><dd> 141: Dumps information about the node (namespace, attributes, content). 142: </dd><dt><tt class="option">du <tt>path</tt></tt></dt><dd> 143: Show the structure of the subtree under path or the current node. 144: </dd><dt><tt class="option">exit</tt></dt><dd> 145: Leave the shell. 146: </dd><dt><tt class="option">help</tt></dt><dd> 147: Show this help. 148: </dd><dt><tt class="option">free</tt></dt><dd> 149: Display memory usage. 150: </dd><dt><tt class="option">load <tt>name</tt></tt></dt><dd> 151: Load a new document with the given name. 152: </dd><dt><tt class="option">ls <tt>path</tt></tt></dt><dd> 153: List contents of <tt>path</tt> (if given) or the 154: current directory. 155: </dd><dt><tt class="option">pwd</tt></dt><dd> 156: Display the path to the current node. 157: </dd><dt><tt class="option">quit</tt></dt><dd> 158: Leave the shell. 159: </dd><dt><tt class="option">save <tt>name</tt></tt></dt><dd> 160: Saves the current document to <tt>name</tt> if 161: given or to the original name. 162: </dd><dt><tt class="option">validate</tt></dt><dd> 163: Check the document for error. 164: </dd><dt><tt class="option">write <tt>name</tt></tt></dt><dd> 165: Write the current node to the given filename. 166: </dd></dl></div></div><div class="refsect1" lang="en"><h2>Catalogs</h2>Catalog behavior can be changed by redirecting 167: queries to the user's own set of catalogs. This can be done by setting the 168: <tt class="varname">XML_CATALOG_FILES</tt> environment variable to a list of 169: catalogs. An empty one should deactivate loading the default 170: <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> 171: using the command "export XML_DEBUG_CATALOG=" 172: outputs debugging information related to catalog operations.</div><div class="refsect1" lang="en"><h2>Error Return Codes</h2>On the completion of execution, Xmllint 173: 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 174: [--pattern] option is used)</dd><dt>8</dt><dd>Error in Reader registration (generated when 175: [--chkregister] option is used)</dd><dt>9</dt><dd>Out of memory error</dd></dl></div></div></div></body></html>