Xmlstarlet - revision history

Dank: /* Counting */

2024-11-27T03:22:05Z

Counting

Dank: /* Counting */

2024-11-27T03:21:54Z

Counting

Dank at 16:11, 4 August 2013

2013-08-04T16:11:13Z

Dank: /* Subversion */

2010-05-27T20:59:34Z

Subversion

Dank at 07:02, 2 October 2009

2009-10-02T07:02:15Z

Dank at 07:01, 2 October 2009

2009-10-02T07:01:28Z

Dank: Created page with 'XMLStarlet is a command line tool for manipulation of XML. It exposes XPath, XSLT, and validation among many other capabilities. On FreeBSD, it is generally invoked as xml 2009-10-02T06:55:34Z Created page with 'XMLStarlet is a command line tool for manipulation of XML. It exposes XPath, XSLT, and validation among many other capabilities. On FreeBSD, it is generally invoked as <tt>xml</t...' New page XMLStarlet is a command line tool for manipulation of XML. It exposes XPath, XSLT, and validation among many other capabilities. On FreeBSD, it is generally invoked as <tt>xml</tt> and is available from the Ports Collection in <tt>textproc/xmlstarlet</tt>; on Linux, it is generally invoked as <tt>xmlstarlet</tt> (throughout the rest of this article, I shall use <tt>xml</tt>). XMLstarlet invocations take the form: <tt>xml command [command options] [filename]</tt>. It is intended for use within pipelines; any diagnostic output generated will be placed on stderr. To get help on a command, run <tt>xml command --help</tt>.<br> <br> As more and more tools generate XML-based output ([[subversion]], [http://insecure.org/nmap nmap], etc), xmlstarlet becomes a useful and flexible tool for working with XML in a stream-editing context. ==Escaping and Unescaping== Due to [http://en.wikipedia.org/wiki/SGML_entity entity references], text must be processed prior to being embedded within an element as data. Conversion to and from entity references is managed with <tt>xml esc</tt> and <tt>xml unesc</tt>. Neither of these commands take any options. The input has no well-formedness requirements.<pre>[diaconicon](0) $ xmlstarlet esc \<\>\& && echo \<\>\& | xmlstarlet esc &lt;&gt;&amp; &lt;&gt;&amp; [diaconicon](0) $ xmlstarlet esc \<\>\& | xmlstarlet unesc && echo \<\>\& | xmlstarlet esc | xargs xmlstarlet unesc <>& <>& [diaconicon](0) $</pre> ==Document Presentation== ===Canonical Representation=== <tt>xml c14n</tt> can be used to canonicalize XML (this primarily consists of removing whitespace leading or trailing the root node, and expanding empty nodes which use the <foo/> notation). The input must be well-formed. Comments can either be preserved or stripped via the <tt>with-comments</tt> and <tt>without-comments</tt> command-line options.<pre>[diaconicon](0) $ echo -e "\n<foo> <bar />\n<qux> crap\tcrap </qux></foo>" | xmlstarlet c14n <foo> <bar></bar> <qux> crap crap </qux></foo>[diaconicon](0) $</pre> ===Element Structure=== <tt>xml el</tt> will display the element structure of well-formed XML. Attributes and their values can also be displayed; use the <tt>-a</tt> option to enable attribute output, and the <tt>-v</tt> option to enable attribute + value output. Each element and its complete ancestry will appear on its own line, with generations demarcated with foreslashes. Attributes and their values, if enabled, follow the element path in square brackets.<pre>[diaconicon](0) $ echo '<foo><bar qux="quux" fux="fuux">quuux</bar><baz/></foo>' | xmlstarlet el -v foo foo/bar[@qux='quux' and @fux='fuux'] foo/baz [diaconicon](0) $</pre> ===Line-oriented (PyX)=== The [http://www.xml.com/pub/a/2000/03/15/feature/index.html PyX] (PostScript + Python + TeX) notation can be used to prepare XML data for processing by line-oriented tools such as <tt>grep</tt> or <tt>wc</tt>. Each (preserved) syntactic element in the XML source results in a single line of text prefaced with a PyX classifier; this mapping is bijective: {| class="wikitable" border="1" |- ! XML Syntax ! PyX Classifier ! XML Example ! PyX Equivalent |- | start-tag | '(' | <foo>, <foo/> | (foo |- | end-tag | ')' | </foo>, <foo/> | )foo |- | attribute | 'A' | foo="bar" | Afoo bar |- | character data | '-' | <foo>bar</foo> | -bar |- | processing instruction | '?' | <?A4TypeSetter PageBreak?> | ?A4TypeSetter PageBreak |} Use <tt>xml pyx</tt> to convert from XML to PyX and <tt>xml p2x</tt> to convert from PyX to XML. The input must be well-formed in either case.<pre>[diaconicon](0) $ echo '<foo><?xml-stylesheet href="headlines.css" type="text/css"?><bar qux="quux">quuux</bar><baz/></foo>' | xmlstarlet pyx (foo ?xml-stylesheet href="headlines.css" type="text/css" (bar Aqux quux -quuux )bar (baz )baz )foo [diaconicon](0) $ echo '<foo><?xml-stylesheet href="headlines.css" type="text/css"?><bar qux="quux">quuux</bar><baz/></foo>' | xmlstarlet pyx | xmlstarlet p2x <foo><?xml-stylesheet href="headlines.css" type="text/css"?> <bar qux="quux">quuux</bar><baz></baz></foo> [diaconicon](0) $</pre> ===Pretty Printing=== <tt>xml fo</tt> can pretty-print well-formed input using either spaces or tabs. Consult <tt>xml fo --help</tt>; it's pretty self-explanatory. ==XML Input== ===Directory Listings=== <tt>xml ls</tt> will output a verbose listing of the current directory's contents, displaying all times in ISO 8601 format. It takes no options. The return value is, for reasons unfathomable, the number of files listed as opposed to a success/error indicator -- don't get caught unawares.<pre>[diaconicon](0) $ xmlstarlet ls <dir> <d p="rwxr-xr-x" a="20070421T065820Z" m="20070415T190332Z" s="4096" n="trunk"/> <d p="rwxr-xr-x" a="20070421T044013Z" m="20070419T181636Z" s="4096" n=".svn"/> </dir> [diaconicon](2) $</pre> ===Recovering Documents=== <tt>xml fo -R</tt> attempts to magically fix up malformed XML. It's pretty badass.<pre>[diaconicon](0) $ echo "<fucked> this is all <fubar> </fukked>" | xmlstarlet fo -R -:1: parser error : Opening and ending tag mismatch: fubar line 1 and fukked <fucked> this is all <fubar> </fukked> ^ -:2: parser error : Premature end of data in tag fucked line 1 ^ <?xml version="1.0"?> <fucked> this is all <fubar> </fubar> </fucked> [diaconicon](0) $</pre> ===Subversion=== <tt>svn log</tt> and <tt>svn status</tt> both accept the --xml command line option.<pre>[diaconicon](0) $ svn status --xml <?xml version="1.0"?> <status> <target path="."> <entry path="trunk/clients/log.xml"> <wc-status props="none" item="unversioned"> </wc-status> </entry> </target> </status> [diaconicon](0) $ svn log -r299 --xml <?xml version="1.0"?> <log> <logentry revision="299"> <author>dank</author> <date>2007-04-19T16:47:10.226838Z</date> <msg>reenable the exitcode etc buildreport handlers</msg> </logentry> </log> [diaconicon](0) $</pre> ==Validation== All forms of the <tt>xml val</tt> command as used below can be provided the -e command line option to verbosely print the causes of validation failures on stderr. ===Well-formedness=== Well-formedness of an XML document can be verified with <tt>xml val</tt>. Well-formedness mandates a single root node, balancing of all element start- and end-tags, proper syntax, proper use of character entities where necessary, etc. ===RELAX-NG=== If a RELAX-NG schema has been provided, validation can be performed against it using <tt>xml val -r schema</tt>. ==Transformation== [[XSLT]] is awesomely powerful. ===Dump all content=== Delimited by spaces: <code>xml sel -t -m //\\[not$\$\] -v . -o ' '</code>