Group :: Ferramentas de texto
RPM: xmlstarlet
Navegação
Main Changelog Spec Patches Sources Download Gear Bugs e FR Repocop
Patch: xmlstarlet-1.0.1-html.patch
Download
Download
--- xmlstarlet-1.0.1.orig/doc/xmlstarlet-ug.html 2004-11-04 06:03:59 +0300
+++ xmlstarlet-1.0.1/doc/xmlstarlet-ug.html 2007-12-10 14:40:56 +0300
@@ -1,9 +1,39 @@
<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
- <title>XmlStarlet Command Line XML Toolkit User's Guide</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.62.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="d0e1"></a>XmlStarlet Command Line XML Toolkit User's Guide</h1></div><div><div class="author"><h3 class="author"><span class="firstname">Mikhail</span> <span class="surname">Grushinskiy</span></h3></div></div></div><div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#d0e12">1. Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="#d0e15">1. About XmlStarlet</a></span></dt><dt><span class="sect1"><a href="#d0e46">2. Main Features</a></span></dt><dt><span class="sect1"><a href="#d0e95">3. Supported Platforms</a></span></dt><dt><span class="sect1"><a href="#d0e130">4. Finding binary packages</a></span></dt></dl></dd><dt><span class="chapter"><a href="#d0e170">2. Installation</a></span></dt><dd><dl><dt><span class="sect1"><a href="#d0e173">1. Installation on Linux</a></span></dt><dt><span class="sect1"><a href="#d0e187">2. Installation on Solaris</a></span></dt><dt><span class="sect1"><a href="#d0e194">3. Installation on MacOS X</a></span></dt><dt><span class="sect1"><a href="#d0e201">4. Installation on Windows</a></span></dt></dl></dd><dt><span class="chapter"><a href="#d0e209">3. Getting Started</a></span></dt><dd><dl><dt><span class="sect1"><a href="#d0e212">1. Basic Command-Line Options</a></span></dt><dt><span class="sect1"><a href="#d0e219">2. Studying Structure of XML Document</a></span></dt></dl></dd><dt><span class="chapter"><a href="#d0e266">4. XmlStarlet Reference</a></span></dt><dd><dl><dt><span class="sect1"><a href="#d0e270">1. Querying XML documents</a></span></dt><dt><span class="sect1"><a href="#d0e442">2. Transforming XML documents</a></span></dt><dt><span class="sect1"><a href="#d0e461">3. Editing XML documents</a></span></dt><dt><span class="sect1"><a href="#d0e520">4. Validating XML documents</a></span></dt><dt><span class="sect1"><a href="#d0e543">5. Formatting XML documents</a></span></dt><dt><span class="sect1"><a href="#d0e570">6. Canonicalization of XML documents</a></span></dt><dt><span class="sect1"><a href="#d0e601">7. XML and PYX format</a></span></dt><dt><span class="sect1"><a href="#d0e636">8. Escape/Unescape special XML characters</a></span></dt><dt><span class="sect1"><a href="#d0e655">9. List directory as XML</a></span></dt></dl></dd><dt><span class="chapter"><a href="#d0e670">5. Common problems</a></span></dt><dd><dl><dt><span class="sect1"><a href="#d0e673">1. Namespaces and default namespace</a></span></dt><dt><span class="sect1"><a href="#d0e709">2. Special characters</a></span></dt><dt><span class="sect1"><a href="#d0e731">3. Sorting</a></span></dt><dt><span class="sect1"><a href="#d0e744">4. Validation</a></span></dt></dl></dd></dl></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="d0e12"></a>Chapter 1. Introduction</h2></div></div><div></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e15"></a>1. About XmlStarlet</h2></div></div><div></div></div><p><a href="http://xmlstar.sourceforge.net/" target="_top">XMLStarlet</a> is a set of command line utilities (tools) which can be used to transform, query, validate, and edit XML documents and files using simple set of shell commands in similar way it is done for plain text files using UNIX grep, sed, awk, diff, patch, join, etc commands.</p><p>This set of command line utilities can be used by those who deal with many XML documents on UNIX shell command prompt as well as for automated XML processing with shell scripts.</p><p>XMLStarlet command line utility is written in C and uses libxml2 and libxslt from <a href="http://xmlsoft.org/" target="_top">http://xmlsoft.org/</a>. Implementation of extensive choice of options for XMLStarlet utility was only possible because of rich feature set of libxml2 and libxslt (many thanks to the developers of those libraries for great work).</p><p>'diff' and 'patch' options are not currently implemented. Other features need some work too. Please, send an email to the project administrator (see <a href="http://sourceforge.net/projects/xmlstar/" target="_top">http://sourceforge.net/projects/xmlstar/</a>) if you wish to help.</p><p>XMLStarlet is linked statically to both libxml2 and libxslt, so generally all you need to process XML documents is one executable file. To run XmlStarlet utility you can simple type 'xml' on command line and see list of options available.</p><p>XMLStarlet is open source freeware under MIT license which allows free use and distribution for both commercial and non-commercial projects.</p><p>We welcome any user's feedback on this project which would greatly help us to improve its quality. Comments, suggestions, feature requests, bug reports can be done via SourceForge project web site (see <a href="http://sourceforge.net/forum/?group_id=66612" target="_top">XMLStarlet Sourceforge forums</a>, or <a href="http://lists.sourceforge.net/lists/listinfo/xmlstar-devel/" target="_top">XMLStarlet mailing list</a>)</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e46"></a>2. Main Features</h2></div></div><div></div></div><p>The toolkit's feature set includes options to:</p><div class="itemizedlist"><ul type="disc"><li><p>Check or validate XML files (simple well-formedness check, DTD, XSD, RelaxNG)</p></li><li><p>Calculate values of XPath expressions on XML files (such as running sums, etc)</p></li><li><p>Search XML files for matches to given XPath expressions</p></li><li><p>Apply XSLT stylesheets to XML documents (including EXSLT support, and passing parameters to stylesheets)</p></li><li><p>Query XML documents (ex. query for value of some elements of attributes, sorting, etc)</p></li><li><p>Modify or edit XML documents (ex. delete some elements)</p></li><li><p>Format or "beautify" XML documents (as changing indentation, etc)</p></li><li><p>Fetch XML documents using http:// or ftp:// URLs</p></li><li><p>Browse tree structure of XML documents (in similar way to 'ls' command for directories)</p></li><li><p>Include one XML document into another using XInclude</p></li><li><p>XML c14n canonicalization</p></li><li><p>Escape/unescape special XML characters in input text</p></li><li><p>Print directory as XML document</p></li><li><p>Convert XML into PYX format (based on ESIS - ISO 8879), and vice versa</p></li></ul></div><p></p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e95"></a>3. Supported Platforms</h2></div></div><div></div></div><p>Here is a list of platforms on which XmlStarlet is known to work.</p><div class="itemizedlist"><ul type="disc"><li><p>Linux</p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p>Solaris</p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p>Windows</p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p>MacOS X</p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p>FreeBSD/NetBSD</p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p>HP-UX</p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p>AIX</p></li></ul></div><p>You might be able to compile and make it on others too.</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e130"></a>4. Finding binary packages</h2></div></div><div></div></div><p>Here is a list of sites where you can also find XmlStarlet binary packages.</p><div class="itemizedlist"><ul type="disc"><li><p><a href="http://www.suse.com/us/private/products/suse_linux/prof/packages_professional/xmlstarlet.html" target="_top">SuSE Packages</a></p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p><a href="http://linux01.gwdg.de/~pbleser/rpm-navigation.php?cat=%2FUtilities%2Fxmlstarlet/" target="_top">SuSE Guru's RPM Site</a></p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p><a href="http://www.freebsd.org/cgi/ports.cgi?query=xmlstarlet&stype=all" target="_top">FreeBSD Ports</a></p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p><a href="http://www.freshports.org/textproc/xmlstarlet/" target="_top">FreeBSD Fresh Ports</a></p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p><a href="http://fink.sourceforge.net/pdb/package.php/xmlstarlet" target="_top">Mac OS Fink</a></p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p><a href="http://rpms.mandrakeclub.com/linux/rpm2html/search.php?query=xmlstarlet" target="_top">Mandrake RPMs</a></p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p><a href="http://gentoo-portage.com/app-text/xmlstarlet" target="_top">Gentoo Portage</a></p></li></ul></div></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="d0e170"></a>Chapter 2. Installation</h2></div></div><div></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e173"></a>1. Installation on Linux</h2></div></div><div></div></div><p>Execute the following command as root</p><pre class="programlisting">rpm -i xmlstarlet-x.x.x-1.i386.rpm</pre><p>where x.x.x indicates package version.</p><p>You can use <a href="http://fr2.rpmfind.net/linux/rpm2html/search.php?query=xmlstarlet&system=&arch=" target="_top">http://rpmfind.net</a> to search for RPM appropriate for your distribution.</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e187"></a>2. Installation on Solaris</h2></div></div><div></div></div><p>Execute the following commands as root</p><pre class="programlisting">gunzip xmlstarlet-x.x.x-sol8-sparc-local.gz
-pkgadd -d xmlstarlet-x.x.x-sol8-sparc-local all</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e194"></a>3. Installation on MacOS X</h2></div></div><div></div></div><p>XmlStarlet is available on MacOS in Fink. <a href="http://fink.sourceforge.net/pdb/package.php/xmlstarlet" target="_top">See fink.sourceforge.net</a></p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e201"></a>4. Installation on Windows</h2></div></div><div></div></div><p>Unzip the file xmlstarlet-x.x.x-win32.zip to some directory. To take advantage of UNIX shell scripting you might want to run XmlStarlet from Cygwin. Consider installing <a href="http://www.cygwin.com/" target="_top">Cygwin</a> on your Windows machine.</p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="d0e209"></a>Chapter 3. Getting Started</h2></div></div><div></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e212"></a>1. Basic Command-Line Options</h2></div></div><div></div></div><p>Basic command line syntax: </p><pre class="programlisting">bash-2.03$ xml
+ <title>XmlStarlet Command Line XML Toolkit User's Guide</title>
+ <style type='text/css'><!--
+ body { + background: #FFFFFF;
+}
+
+h1, h2, h3, h4, h5 { + color: #800000;
+ font-family: sans-serif;
+}
+
+span.term { + font-weight: bold;
+}
+
+div.sidebar { + background: #F0F0F0;
+ border: 1px solid gray;
+ padding: 5px;
+ margin: 20px;
+}
+
+pre.programlisting { + background: #F0F0F0;
+ border: 1px solid gray;
+ padding: 2px;
+ font-size: 10pt;
+ white-space: pre;
+}
+--></style>
+<meta name="generator" content="DocBook XSL Stylesheets V1.62.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="d0e1"></a>XmlStarlet Command Line XML Toolkit User's Guide</h1></div><div><div class="author"><h3 class="author"><span class="firstname">Mikhail</span> <span class="surname">Grushinskiy</span></h3></div></div></div><div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#d0e12">1. Introduction</a></span></dt><dd><dl><dt><span class="sect1"><a href="#d0e15">1. About XmlStarlet</a></span></dt><dt><span class="sect1"><a href="#d0e46">2. Main Features</a></span></dt><dt><span class="sect1"><a href="#d0e95">3. Supported Platforms</a></span></dt><dt><span class="sect1"><a href="#d0e130">4. Finding binary packages</a></span></dt></dl></dd><dt><span class="chapter"><a href="#d0e170">2. Installation</a></span></dt><dd><dl><dt><span class="sect1"><a href="#d0e173">1. Installation on Linux</a></span></dt><dt><span class="sect1"><a href="#d0e187">2. Installation on Solaris</a></span></dt><dt><span class="sect1"><a href="#d0e194">3. Installation on MacOS X</a></span></dt><dt><span class="sect1"><a href="#d0e201">4. Installation on Windows</a></span></dt></dl></dd><dt><span class="chapter"><a href="#d0e209">3. Getting Started</a></span></dt><dd><dl><dt><span class="sect1"><a href="#d0e212">1. Basic Command-Line Options</a></span></dt><dt><span class="sect1"><a href="#d0e219">2. Studying Structure of XML Document</a></span></dt></dl></dd><dt><span class="chapter"><a href="#d0e266">4. XmlStarlet Reference</a></span></dt><dd><dl><dt><span class="sect1"><a href="#d0e270">1. Querying XML documents</a></span></dt><dt><span class="sect1"><a href="#d0e442">2. Transforming XML documents</a></span></dt><dt><span class="sect1"><a href="#d0e461">3. Editing XML documents</a></span></dt><dt><span class="sect1"><a href="#d0e520">4. Validating XML documents</a></span></dt><dt><span class="sect1"><a href="#d0e543">5. Formatting XML documents</a></span></dt><dt><span class="sect1"><a href="#d0e570">6. Canonicalization of XML documents</a></span></dt><dt><span class="sect1"><a href="#d0e601">7. XML and PYX format</a></span></dt><dt><span class="sect1"><a href="#d0e636">8. Escape/Unescape special XML characters</a></span></dt><dt><span class="sect1"><a href="#d0e655">9. List directory as XML</a></span></dt></dl></dd><dt><span class="chapter"><a href="#d0e670">5. Common problems</a></span></dt><dd><dl><dt><span class="sect1"><a href="#d0e673">1. Namespaces and default namespace</a></span></dt><dt><span class="sect1"><a href="#d0e709">2. Special characters</a></span></dt><dt><span class="sect1"><a href="#d0e731">3. Sorting</a></span></dt><dt><span class="sect1"><a href="#d0e744">4. Validation</a></span></dt></dl></dd></dl></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="d0e12"></a>Chapter 1. Introduction</h2></div></div><div></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e15"></a>1. About XmlStarlet</h2></div></div><div></div></div><p><a href="http://xmlstar.sourceforge.net/" target="_top">XMLStarlet</a> is a set of command line utilities (tools) which can be used to transform, query, validate, and edit XML documents and files using simple set of shell commands in similar way it is done for plain text files using UNIX grep, sed, awk, diff, patch, join, etc commands.</p><p>This set of command line utilities can be used by those who deal with many XML documents on UNIX shell command prompt as well as for automated XML processing with shell scripts.</p><p>XMLStarlet command line utility is written in C and uses libxml2 and libxslt from <a href="http://xmlsoft.org/" target="_top">http://xmlsoft.org/</a>. Implementation of extensive choice of options for XMLStarlet utility was only possible because of rich feature set of libxml2 and libxslt (many thanks to the developers of those libraries for great work).</p><p>'diff' and 'patch' options are not currently implemented. Other features need some work too. Please, send an email to the project administrator (see <a href="http://sourceforge.net/projects/xmlstar/" target="_top">http://sourceforge.net/projects/xmlstar/</a>) if you wish to help.</p><p>XMLStarlet is linked statically to both libxml2 and libxslt, so generally all you need to process XML documents is one executable file. To run XmlStarlet utility you can simple type 'xmlstarlet' on command line and see list of options available.</p><p>XMLStarlet is open source freeware under MIT license which allows free use and distribution for both commercial and non-commercial projects.</p><p>We welcome any user's feedback on this project which would greatly help us to improve its quality. Comments, suggestions, feature requests, bug reports can be done via SourceForge project web site (see <a href="http://sourceforge.net/forum/?group_id=66612" target="_top">XMLStarlet Sourceforge forums</a>, or <a href="http://lists.sourceforge.net/lists/listinfo/xmlstar-devel/" target="_top">XMLStarlet mailing list</a>)</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e46"></a>2. Main Features</h2></div></div><div></div></div><p>The toolkit's feature set includes options to:</p><div class="itemizedlist"><ul type="disc"><li><p>Check or validate XML files (simple well-formedness check, DTD, XSD, RelaxNG)</p></li><li><p>Calculate values of XPath expressions on XML files (such as running sums, etc)</p></li><li><p>Search XML files for matches to given XPath expressions</p></li><li><p>Apply XSLT stylesheets to XML documents (including EXSLT support, and passing parameters to stylesheets)</p></li><li><p>Query XML documents (ex. query for value of some elements of attributes, sorting, etc)</p></li><li><p>Modify or edit XML documents (ex. delete some elements)</p></li><li><p>Format or "beautify" XML documents (as changing indentation, etc)</p></li><li><p>Fetch XML documents using http:// or ftp:// URLs</p></li><li><p>Browse tree structure of XML documents (in similar way to 'ls' command for directories)</p></li><li><p>Include one XML document into another using XInclude</p></li><li><p>XML c14n canonicalization</p></li><li><p>Escape/unescape special XML characters in input text</p></li><li><p>Print directory as XML document</p></li><li><p>Convert XML into PYX format (based on ESIS - ISO 8879), and vice versa</p></li></ul></div><p></p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e95"></a>3. Supported Platforms</h2></div></div><div></div></div><p>Here is a list of platforms on which XmlStarlet is known to work.</p><div class="itemizedlist"><ul type="disc"><li><p>Linux</p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p>Solaris</p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p>Windows</p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p>MacOS X</p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p>FreeBSD/NetBSD</p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p>HP-UX</p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p>AIX</p></li></ul></div><p>You might be able to compile and make it on others too.</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e130"></a>4. Finding binary packages</h2></div></div><div></div></div><p>Here is a list of sites where you can also find XmlStarlet binary packages.</p><div class="itemizedlist"><ul type="disc"><li><p><a href="http://www.suse.com/us/private/products/suse_linux/prof/packages_professional/xmlstarlet.html" target="_top">SuSE Packages</a></p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p><a href="http://linux01.gwdg.de/~pbleser/rpm-navigation.php?cat=%2FUtilities%2Fxmlstarlet/" target="_top">SuSE Guru's RPM Site</a></p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p><a href="http://www.freebsd.org/cgi/ports.cgi?query=xmlstarlet&stype=all" target="_top">FreeBSD Ports</a></p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p><a href="http://www.freshports.org/textproc/xmlstarlet/" target="_top">FreeBSD Fresh Ports</a></p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p><a href="http://fink.sourceforge.net/pdb/package.php/xmlstarlet" target="_top">Mac OS Fink</a></p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p><a href="http://rpms.mandrakeclub.com/linux/rpm2html/search.php?query=xmlstarlet" target="_top">Mandrake RPMs</a></p></li></ul></div><div class="itemizedlist"><ul type="disc"><li><p><a href="http://gentoo-portage.com/app-text/xmlstarlet" target="_top">Gentoo Portage</a></p></li></ul></div></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="d0e170"></a>Chapter 2. Installation</h2></div></div><div></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e173"></a>1. Installation on Linux</h2></div></div><div></div></div><p>Execute the following command as root</p><pre class="programlisting">rpm -i xmlstarlet-x.x.x-1.i386.rpm</pre><p>where x.x.x indicates package version.</p><p>You can use <a href="http://fr2.rpmfind.net/linux/rpm2html/search.php?query=xmlstarlet&system=&arch=" target="_top">http://rpmfind.net</a> to search for RPM appropriate for your distribution.</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e187"></a>2. Installation on Solaris</h2></div></div><div></div></div><p>Execute the following commands as root</p><pre class="programlisting">gunzip xmlstarlet-x.x.x-sol8-sparc-local.gz
+pkgadd -d xmlstarlet-x.x.x-sol8-sparc-local all</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e194"></a>3. Installation on MacOS X</h2></div></div><div></div></div><p>XmlStarlet is available on MacOS in Fink. <a href="http://fink.sourceforge.net/pdb/package.php/xmlstarlet" target="_top">See fink.sourceforge.net</a></p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e201"></a>4. Installation on Windows</h2></div></div><div></div></div><p>Unzip the file xmlstarlet-x.x.x-win32.zip to some directory. To take advantage of UNIX shell scripting you might want to run XmlStarlet from Cygwin. Consider installing <a href="http://www.cygwin.com/" target="_top">Cygwin</a> on your Windows machine.</p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="d0e209"></a>Chapter 3. Getting Started</h2></div></div><div></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e212"></a>1. Basic Command-Line Options</h2></div></div><div></div></div><p>Basic command line syntax: </p><pre class="programlisting">bash-2.03$ xmlstarlet
XMLStarlet Toolkit: Command line utilities for XML
-Usage: xml [<options>] <command> [<cmd-options>]
+Usage: xmlstarlet [<options>] <command> [<cmd-options>]
where <command> is one of:
ed (or edit) - Edit/Update XML document(s)
sel (or select) - Select data or query XML document(s) (XPATH, etc)
@@ -23,7 +53,7 @@ where <command> is one of:
Wherever file name mentioned in command help it is assumed
that URL can be used instead as well.
-Type: xml <command> --help <ENTER> for command help
+Type: xmlstarlet <command> --help <ENTER> for command help
XMLStarlet is a command line toolkit to query/edit/check/transform
XML documents (for more information see http://xmlstar.sourceforge.net/)</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e219"></a>2. Studying Structure of XML Document</h2></div></div><div></div></div><p>Before you do anything with your XML document you probably would like to know its structure at first. 'el' option could be used for this purpose.</p><p>Let's say you have the following XML document (table.xml)</p><pre class="programlisting"><xml>
@@ -41,7 +71,7 @@ XML documents (for more information see
<stringField>stringValue</stringField>
</rec>
</table>
-</xml></pre><pre class="programlisting">xml el table.xml</pre><p>would produce the following output.</p><pre class="programlisting">xml
+</xml></pre><pre class="programlisting">xmlstarlet el table.xml</pre><p>would produce the following output.</p><pre class="programlisting">xml
xml/table
xml/table/rec
xml/table/rec/numField
@@ -51,11 +81,11 @@ xml/table/rec/numField
xml/table/rec/stringField
xml/table/rec
xml/table/rec/numField
-xml/table/rec/stringField</pre><p>Every line in this output is an XPath expression which indicates a 'path' to elements in XML document. You would use these XPath expressions to navigate through your XML documents in other XmlStarlet options.</p><p>XML documents can be pretty large but with a very simple structure. (This is espesially true for data driven XML documents ex: XML formatted result of select from SQL table). If you just interested in structure but not order of the elements you can use -u switch combined with 'el' option.</p><p>EXAMPLE:</p><pre class="programlisting">xml el -u table.xml</pre><p>Output:</p><pre class="programlisting">xml
+xml/table/rec/stringField</pre><p>Every line in this output is an XPath expression which indicates a 'path' to elements in XML document. You would use these XPath expressions to navigate through your XML documents in other XmlStarlet options.</p><p>XML documents can be pretty large but with a very simple structure. (This is espesially true for data driven XML documents ex: XML formatted result of select from SQL table). If you just interested in structure but not order of the elements you can use -u switch combined with 'el' option.</p><p>EXAMPLE:</p><pre class="programlisting">xmlstarlet el -u table.xml</pre><p>Output:</p><pre class="programlisting">xml
xml/table
xml/table/rec
xml/table/rec/numField
-xml/table/rec/stringField</pre><p>If you are interested not just in elements of your XML document, but you want to see attributes as well you can use -a switch with 'el' option. And every line of the output will still be a valid XPath expression.</p><p>EXAMPLE:</p><pre class="programlisting">xml el -a table.xml</pre><p>Output:</p><pre class="programlisting">xml
+xml/table/rec/stringField</pre><p>If you are interested not just in elements of your XML document, but you want to see attributes as well you can use -a switch with 'el' option. And every line of the output will still be a valid XPath expression.</p><p>EXAMPLE:</p><pre class="programlisting">xmlstarlet el -a table.xml</pre><p>Output:</p><pre class="programlisting">xml
xml/table
xml/table/rec
xml/table/rec/@id
@@ -68,7 +98,7 @@ xml/table/rec/stringField
xml/table/rec
xml/table/rec/@id
xml/table/rec/numField
-xml/table/rec/stringField</pre><p>If you are looking for attribute values as well use -v switch of 'el' option. And again - every line of output is a valid XPath expression.</p><p>EXAMPLE:</p><pre class="programlisting">xml el -v table.xml</pre><p>Output:</p><pre class="programlisting">xml
+xml/table/rec/stringField</pre><p>If you are looking for attribute values as well use -v switch of 'el' option. And again - every line of output is a valid XPath expression.</p><p>EXAMPLE:</p><pre class="programlisting">xmlstarlet el -v table.xml</pre><p>Output:</p><pre class="programlisting">xml
xml/table
xml/table/rec[@id='1']
xml/table/rec/numField
@@ -78,8 +108,8 @@ xml/table/rec/numField
xml/table/rec/stringField
xml/table/rec[@id='3']
xml/table/rec/numField
-xml/table/rec/stringField</pre></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="d0e266"></a>Chapter 4. XmlStarlet Reference</h2></div></div><div></div></div><p></p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e270"></a>1. Querying XML documents</h2></div></div><div></div></div><p>XmlStarlet 'select' or 'sel' option can be used to query or search XML documents. Here is synopsis for 'xml sel' command:</p><pre class="programlisting">XMLStarlet Toolkit: Select from XML document(s)
-Usage: xml sel <global-options> {<template>} [ <xml-file> ... ]+xml/table/rec/stringField</pre></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="d0e266"></a>Chapter 4. XmlStarlet Reference</h2></div></div><div></div></div><p></p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e270"></a>1. Querying XML documents</h2></div></div><div></div></div><p>XmlStarlet 'select' or 'sel' option can be used to query or search XML documents. Here is synopsis for 'xmlstarlet sel' command:</p><pre class="programlisting">XMLStarlet Toolkit: Select from XML document(s)
+Usage: xmlstarlet sel <global-options> {<template>} [ <xml-file> ... ]where
<global-options> - global options for selecting
<xml-file> - input XML document file name/uri (stdin is used if missing)
@@ -90,7 +120,7 @@ where
-R or --root - print root element <xsl-select>
-T or --text - output is text (default is XML)
-I or --indent - indent output
- -D or --xml-decl - do not omit xml declaration line
+ -D or --xml-decl - do not omit xmlstarlet declaration line
-B or --noblanks - remove insignificant spaces from XML tree
-N <name>=<value> - predefine namespaces (name without 'xmlns:')
ex: xsql=urn:oracle-xsql
@@ -123,7 +153,7 @@ There can be multiple --match, --copy-of
in a single template. The effect of applying command line templates
can be illustrated with the following XSLT analogue
-xml sel -t -c "xpath0" -m "xpath1" -m "xpath2" -v "xpath3" \
+xmlstarlet sel -t -c "xpath0" -m "xpath1" -m "xpath2" -v "xpath3" \
-t -m "xpath4" -c "xpath5"
is equivalent to applying the following XSLT
@@ -154,7 +184,7 @@ XML documents (for more information see
Current implementation uses libxslt from GNOME codebase as XSLT processor
(see http://xmlsoft.org/ for more details)
-</pre><p>'select' option allows you basically avoid writting XSLT stylesheet to perform some queries on XML documents. I.e. various combinations of command line parameters will let you to generate XSLT stylesheet and apply in to XML documents with a single command line. Very often you do not really care what XSLT was created for you 'select' command, but in those cases when you do; you can always use -C or --comp switch which will let you see exactly which XSLT is applied to your input.</p><p>'select' option supports many EXSLT functions in XPath expressions.</p><p>Here are few examples which will help to understand how 'xml select' works:</p><p>EXAMPLE:</p><p>Count elements matching XPath expression:</p><p></p><pre class="programlisting">xml sel -t -v "count(/xml/table/rec/numField)" table.xml</pre><p>Input (table.xml):</p><pre class="programlisting"><xml>
+</pre><p>'select' option allows you basically avoid writting XSLT stylesheet to perform some queries on XML documents. I.e. various combinations of command line parameters will let you to generate XSLT stylesheet and apply in to XML documents with a single command line. Very often you do not really care what XSLT was created for you 'select' command, but in those cases when you do; you can always use -C or --comp switch which will let you see exactly which XSLT is applied to your input.</p><p>'select' option supports many EXSLT functions in XPath expressions.</p><p>Here are few examples which will help to understand how 'xmlstarlet select' works:</p><p>EXAMPLE:</p><p>Count elements matching XPath expression:</p><p></p><pre class="programlisting">xmlstarlet sel -t -v "count(/xml/table/rec/numField)" table.xml</pre><p>Input (table.xml):</p><pre class="programlisting"><xml>
<table>
<rec id="1">
<numField>123</numField>
@@ -170,7 +200,7 @@ Current implementation uses libxslt from
</rec>
</table>
</xml></pre><p>Output:</p><pre class="programlisting">3
-</pre><p>Let's take a close look what it did internally. For that we will use '-C' option</p><pre class="programlisting">$ xml sel -C -t -v "count(/xml/table/rec/numField)"
+</pre><p>Let's take a close look what it did internally. For that we will use '-C' option</p><pre class="programlisting">$ xmlstarlet sel -C -t -v "count(/xml/table/rec/numField)"
<?xml version="1.0"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:exslt="http://exslt.org/common"
@@ -204,8 +234,8 @@ Current implementation uses libxslt from
<xsl:template name="t1">
<xsl:value-of select="count(/xml/table/rec/numField)"/>
</xsl:template>
-</xsl:stylesheet></pre><p>Every -t option is mapped into XSLT template. Options after '-t' are mapped into XSLT elements:</p><div class="itemizedlist"><ul type="disc"><li><p>-v to <xsl:value-of></p></li><li><p>-c to <xsl:copy-of></p></li><li><p>-e to <xsl:element></p></li><li><p>-a to <xsl:attribute></p></li><li><p>-s to <xsl:sort></p></li><li><p>-m to <xsl:for-each></p></li><li><p>-i to <xsl:if></p></li><li><p>and so on</p></li></ul></div><p>By default subsequent options (for instance: -m) will result in nested corresponding XSLT elements (<xsl:for-each> for '-m'). To break this nesting you would have to put '-b' or '--break' after first '-m'.</p><p>Below are few more examples:</p><p>EXAMPLE</p><p>Count all nodes in XML documents. Print input name and node count after it.</p><pre class="programlisting">xml sel -t -f -o " " -v "count(//node())" xml/table.xml xml/tab-obj.xml</pre><p>Output:</p><pre class="programlisting">xml/table.xml 32
-xml/tab-obj.xml 41</pre><p></p><p>EXAMPLE</p><p>Find XML files matching XPath expression (containing 'object' element)</p><pre class="programlisting">xml sel -t -m //object -f xml/table.xml xml/tab-obj.xml</pre><p>Result output:</p><pre class="programlisting">xml/tab-obj.xml</pre><p></p><p>EXAMPLE</p><p>Calculate EXSLT (XSLT extentions) XPath value</p><pre class="programlisting">echo "<x/>" | xml sel -t -v "math:abs(-1000)"</pre><p>Result output:</p><pre class="programlisting">1000</pre><p></p><p>EXAMPLE</p><p>Adding elements and attributes using command line 'xml sel'</p><pre class="programlisting">echo "<x/>" | xml sel -t -m / -e xml -e child -a data -o value</pre><p>Result Output:</p><pre class="programlisting"><xml><child data="value"/></xml></pre><p></p><p>EXAMPLE</p><p>Query XML document and produce sorted text table</p><pre class="programlisting">xml sel -T -t -m /xml/table/rec -s D:N:- "@id" -v "concat(@id,'|',numField,'|',stringField)" -n xml/table.xml</pre><p>Result Output:</p><pre class="programlisting">3|-23|stringValue
+</xsl:stylesheet></pre><p>Every -t option is mapped into XSLT template. Options after '-t' are mapped into XSLT elements:</p><div class="itemizedlist"><ul type="disc"><li><p>-v to <xsl:value-of></p></li><li><p>-c to <xsl:copy-of></p></li><li><p>-e to <xsl:element></p></li><li><p>-a to <xsl:attribute></p></li><li><p>-s to <xsl:sort></p></li><li><p>-m to <xsl:for-each></p></li><li><p>-i to <xsl:if></p></li><li><p>and so on</p></li></ul></div><p>By default subsequent options (for instance: -m) will result in nested corresponding XSLT elements (<xsl:for-each> for '-m'). To break this nesting you would have to put '-b' or '--break' after first '-m'.</p><p>Below are few more examples:</p><p>EXAMPLE</p><p>Count all nodes in XML documents. Print input name and node count after it.</p><pre class="programlisting">xmlstarlet sel -t -f -o " " -v "count(//node())" xml/table.xml xml/tab-obj.xml</pre><p>Output:</p><pre class="programlisting">xml/table.xml 32
+xml/tab-obj.xml 41</pre><p></p><p>EXAMPLE</p><p>Find XML files matching XPath expression (containing 'object' element)</p><pre class="programlisting">xmlstarlet sel -t -m //object -f xml/table.xml xml/tab-obj.xml</pre><p>Result output:</p><pre class="programlisting">xml/tab-obj.xml</pre><p></p><p>EXAMPLE</p><p>Calculate EXSLT (XSLT extentions) XPath value</p><pre class="programlisting">echo "<x/>" | xmlstarlet sel -t -v "math:abs(-1000)"</pre><p>Result output:</p><pre class="programlisting">1000</pre><p></p><p>EXAMPLE</p><p>Adding elements and attributes using command line 'xmlstarlet sel'</p><pre class="programlisting">echo "<x/>" | xmlstarlet sel -t -m / -e xml -e child -a data -o value</pre><p>Result Output:</p><pre class="programlisting"><xml><child data="value"/></xml></pre><p></p><p>EXAMPLE</p><p>Query XML document and produce sorted text table</p><pre class="programlisting">xmlstarlet sel -T -t -m /xml/table/rec -s D:N:- "@id" -v "concat(@id,'|',numField,'|',stringField)" -n xml/table.xml</pre><p>Result Output:</p><pre class="programlisting">3|-23|stringValue
2|346|Text Value
1|123|String Value</pre><p>Equivalent stylesheet</p><pre class="programlisting"><xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:output omit-xml-declaration="yes" indent="no" method="text"/>
@@ -220,7 +250,7 @@ xml/tab-obj.xml 41</pre><p></p><p>EXAMPL
<xsl:value-of select="'&#10;'"/>
</xsl:for-each>
</xsl:template>
-</xsl:stylesheet></pre><p></p><p>EXAMPLE</p><p>Predefine namespaces for XPath expressions</p><pre class="programlisting">xml sel -N xsql=urn:oracle-xsql -t -v /xsql:query xsql/jobserve.xsql</pre><p>Input (xsql/jobserve.xsql)</p><pre class="programlisting">$ cat xsql/jobserve.xsql
+</xsl:stylesheet></pre><p></p><p>EXAMPLE</p><p>Predefine namespaces for XPath expressions</p><pre class="programlisting">xmlstarlet sel -N xsql=urn:oracle-xsql -t -v /xsql:query xsql/jobserve.xsql</pre><p>Input (xsql/jobserve.xsql)</p><pre class="programlisting">$ cat xsql/jobserve.xsql
<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="jobserve.xsl"?>
<xsql:query connection="jobs" xmlns:xsql="urn:oracle-xsql" max-rows="5">
@@ -232,7 +262,7 @@ xml/tab-obj.xml 41</pre><p></p><p>EXAMPL
FROM job
WHERE UPPER(title) LIKE '%ORACLE%'
ORDER BY first_posted DESC
-</pre><p></p><p>EXAMPLE</p><p>Print structure of XML element using xml sel (advanced XPath expressions and xml sel command usage)</p><pre class="programlisting">xml sel -T -t -m '//*' \
+</pre><p></p><p>EXAMPLE</p><p>Print structure of XML element using xmlstarlet sel (advanced XPath expressions and xmlstarlet sel command usage)</p><pre class="programlisting">xmlstarlet sel -T -t -m '//*' \
-m 'ancestor-or-self::*' -v 'name()' -i 'not(position()=last())' -o . -b -b -n \
xml/structure.xml</pre><p>Input (xml/structure.xml)</p><pre class="programlisting"><a1>
<a11>
@@ -272,7 +302,7 @@ a1.a13.a131</pre><p>This example is a go
<xsl:value-of select="'&#10;'"/>
</xsl:for-each>
</xsl:template>
-</xsl:stylesheet></pre><p></p><p></p><p>EXAMPLE</p><p>Print all links of xhtml document</p><pre class="programlisting">xml sel --net --html -T -t -m "//*[local-name()='a']" \
+</xsl:stylesheet></pre><p></p><p></p><p>EXAMPLE</p><p>Print all links of xhtml document</p><pre class="programlisting">xmlstarlet sel --net --html -T -t -m "//*[local-name()='a']" \
-o 'NAME: ' -v "translate(. , '&#10;', ' ')" -n \
-o 'LINK: ' -v @href -n -n \
http://xmlstar.sourceforge.net/</pre><p>Sample output</p><pre class="programlisting">NAME: XmlStarlet SourceForge Site
@@ -289,8 +319,8 @@ LINK: http://sourceforge.net/forum/?grou
NAME: XMLStarlet mailing list
LINK: http://lists.sourceforge.net/lists/listinfo/xmlstar-devel
-</pre><p></p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e442"></a>2. Transforming XML documents</h2></div></div><div></div></div><p>Here is synopsis for 'xml tr' command:</p><pre class="programlisting">XMLStarlet Toolkit: Transform XML document(s) using XSLT
-Usage: xml tr [<options>] <xsl-file> {-p|-s <name>=<value>} [ <xml-file-or-uri> ... ]+</pre><p></p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e442"></a>2. Transforming XML documents</h2></div></div><div></div></div><p>Here is synopsis for 'xmlstarlet tr' command:</p><pre class="programlisting">XMLStarlet Toolkit: Transform XML document(s) using XSLT
+Usage: xmlstarlet tr [<options>] <xsl-file> {-p|-s <name>=<value>} [ <xml-file-or-uri> ... ]where
<xsl-file> - main XSLT stylesheet for transformation
<xml-file> - input XML document file name (stdin is used if missing)
@@ -315,7 +345,7 @@ XML documents (for more information see
Current implementation uses libxslt from GNOME codebase as XSLT processor
(see http://xmlsoft.org/ for more details)
</pre><p>EXAMPLE:</p><pre class="programlisting"># Transform passing parameters to XSLT stylesheet
-xml tr xsl/param1.xsl -p Count='count(/xml/table/rec)' -s Text="Count=" xml/table.xml
+xmlstarlet tr xsl/param1.xsl -p Count='count(/xml/table/rec)' -s Text="Count=" xml/table.xml
</pre><p>Input xsl/params1.xsl</p><pre class="programlisting"><xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:output method="text"/>
<xsl:param name="Text"/>
@@ -331,8 +361,8 @@ xml tr xsl/param1.xsl -p Count='count(/x
</xsl:for-each>
</xsl:template>
</xsl:stylesheet></pre><p>Output</p><pre class="programlisting">Count=3
-</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e461"></a>3. Editing XML documents</h2></div></div><div></div></div><p>Here is the synopsis for 'xml ed' command:</p><pre class="programlisting">XMLStarlet Toolkit: Edit XML document(s)
-Usage: xml ed <global-options> {<action>} [ <xml-file-or-uri> ... ]+</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e461"></a>3. Editing XML documents</h2></div></div><div></div></div><p>Here is the synopsis for 'xmlstarlet ed' command:</p><pre class="programlisting">XMLStarlet Toolkit: Edit XML document(s)
+Usage: xmlstarlet ed <global-options> {<action>} [ <xml-file-or-uri> ... ]where
<global-options> - global options for editing
<xml-file-or-uri> - input XML document file name/uri (stdin is used if missing)
@@ -360,7 +390,7 @@ where <action>
XMLStarlet is a command line toolkit to query/edit/check/transform
XML documents (for more information see http://xmlstar.sourceforge.net/)
</pre><p>EXAMPLE:</p><pre class="programlisting"># Delete elements matching XPath expression
-xml ed -d "/xml/table/rec[@id='2']" xml/table.xml
+xmlstarlet ed -d "/xml/table/rec[@id='2']" xml/table.xml
</pre><p>Input</p><pre class="programlisting"><xml>
<table>
<rec id="1">
@@ -390,14 +420,14 @@ xml ed -d "/xml/table/rec[@id='2']" xml/
</table>
</xml>
</pre><p>EXAMPLE</p><pre class="programlisting"># Move element node
-echo '<x id="1"><a/><b/></x>' | xml ed -m "//b" "//a"
+echo '<x id="1"><a/><b/></x>' | xmlstarlet ed -m "//b" "//a"
</pre><p>Output</p><pre class="programlisting"><x id="1">
<a>
<b/>
</a>
</x>
</pre><p>EXAMPLE</p><pre class="programlisting"># Rename attributes
-xml ed -r "//*/@id" -v ID xml/tab-obj.xml
+xmlstarlet ed -r "//*/@id" -v ID xml/tab-obj.xml
</pre><p>Output:</p><pre class="programlisting"><xml>
<table>
<rec ID="1">
@@ -419,7 +449,7 @@ xml ed -r "//*/@id" -v ID xml/tab-obj.xm
</table>
</xml>
</pre><p>EXAMPLE</p><pre class="programlisting"># Rename elements
-xml ed -r "/xml/table/rec" -v record xml/tab-obj.xml
+xmlstarlet ed -r "/xml/table/rec" -v record xml/tab-obj.xml
</pre><p>Output:</p><pre class="programlisting"><xml>
<table>
<record id="1">
@@ -441,7 +471,7 @@ xml ed -r "/xml/table/rec" -v record xml
</table>
</xml>
</pre><p>EXAMPLE</p><pre class="programlisting"># Update value of an attribute
-xml ed -u "/xml/table/rec[@id=3]/@id" -v 5 xml/tab-obj.xml
+xmlstarlet ed -u "/xml/table/rec[@id=3]/@id" -v 5 xml/tab-obj.xml
</pre><p>Output:</p><pre class="programlisting"><xml>
<table>
<rec id="1">
@@ -463,7 +493,7 @@ xml ed -u "/xml/table/rec[@id=3]/@id" -v
</table>
</xml>
</pre><p>EXAMPLE</p><pre class="programlisting"># Update value of an element
-xml ed -u "/xml/table/rec[@id=1]/numField" -v 0 xml/tab-obj.xml
+xmlstarlet ed -u "/xml/table/rec[@id=1]/numField" -v 0 xml/tab-obj.xml
</pre><p>Output:</p><pre class="programlisting"><xml>
<table>
<rec id="1">
@@ -484,8 +514,8 @@ xml ed -u "/xml/table/rec[@id=1]/numFiel
</rec>
</table>
</xml>
-</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e520"></a>4. Validating XML documents</h2></div></div><div></div></div><p>Here is synopsis for 'xml val' command:</p><pre class="programlisting">XMLStarlet Toolkit: Validate XML document(s)
-Usage: xml val <options> [ <xml-file-or-uri> ... ]
+</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e520"></a>4. Validating XML documents</h2></div></div><div></div></div><p>Here is synopsis for 'xmlstarlet val' command:</p><pre class="programlisting">XMLStarlet Toolkit: Validate XML document(s)
+Usage: xmlstarlet val <options> [ <xml-file-or-uri> ... ]
where <options>
-w or --well-formed - validate well-formedness only (default)
-d or --dtd <dtd-file> - validate against DTD
@@ -502,14 +532,14 @@ NOTE: XML Schemas are not fully supporte
XMLStarlet is a command line toolkit to query/edit/check/transform
XML documents (for more information see http://xmlstar.sourceforge.net/)
</pre><p>EXAMPLE</p><pre class="programlisting"># Validate XML document against DTD
-xml val --dtd dtd/table.dtd xml/tab-obj.xml >/dev/null 2>&1; echo $?
+xmlstarlet val --dtd dtd/table.dtd xml/tab-obj.xml >/dev/null 2>&1; echo $?
</pre><p>Output:</p><pre class="programlisting">1
</pre><p>EXAMPLE</p><pre class="programlisting"># Validate against XSD schema
-xml val -b -s xsd/table.xsd xml/table.xml xml/tab-obj.xml 2>/dev/null; echo $?
+xmlstarlet val -b -s xsd/table.xsd xml/table.xml xml/tab-obj.xml 2>/dev/null; echo $?
</pre><p>Output:</p><pre class="programlisting">xml/tab-obj.xml
1
-</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e543"></a>5. Formatting XML documents</h2></div></div><div></div></div><p>Here is synopsis for 'xml fo' command:</p><pre class="programlisting">XMLStarlet Toolkit: Format XML document
-Usage: xml fo [<options>] <xml-file>
+</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e543"></a>5. Formatting XML documents</h2></div></div><div></div></div><p>Here is synopsis for 'xmlstarlet fo' command:</p><pre class="programlisting">XMLStarlet Toolkit: Format XML document
+Usage: xmlstarlet fo [<options>] <xml-file>
where <options> are
-n or --noindent - do not indent
-t or --indent-tab - indent output with tabulation
@@ -526,7 +556,7 @@ where <options> are
XMLStarlet is a command line toolkit to query/edit/check/transform
XML documents (for more information see http://xmlstar.sourceforge.net/)
</pre><p>EXAMPLE</p><pre class="programlisting"># Format XML document disabling indent
-cat xml/tab-obj.xml | xml fo --noindent
+cat xml/tab-obj.xml | xmlstarlet fo --noindent
</pre><p>Output:</p><pre class="programlisting"><xml>
<table>
<rec id="1">
@@ -548,7 +578,7 @@ cat xml/tab-obj.xml | xml fo --noindent
</table>
</xml>
</pre><p>EXAMPLE</p><pre class="programlisting"># Recover malformed XML document
-xml fo -R xml/malformed.xml 2>/dev/null
+xmlstarlet fo -R xml/malformed.xml 2>/dev/null
</pre><p>Input:</p><pre class="programlisting"><test_output>
<test_name>foo</testname>
<subtest>...</subtest>
@@ -557,8 +587,8 @@ xml fo -R xml/malformed.xml 2>/dev/nu
<test_name>foo</test_name>
<subtest>...</subtest>
</test_output>
-</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e570"></a>6. Canonicalization of XML documents</h2></div></div><div></div></div><p>Here is synopsis for 'xml c14n' command:</p><pre class="programlisting">XMLStarlet Toolkit: XML canonicalization
-Usage: xml c14n <mode> <xml-file> [<xpath-file>] [<inclusive-ns-list>]
+</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e570"></a>6. Canonicalization of XML documents</h2></div></div><div></div></div><p>Here is synopsis for 'xmlstarlet c14n' command:</p><pre class="programlisting">XMLStarlet Toolkit: XML canonicalization
+Usage: xmlstarlet c14n <mode> <xml-file> [<xpath-file>] [<inclusive-ns-list>]
where
<xml-file> - input XML document file name (stdin is used if '-')
<xpath-file> - XML file containing XPath expression for
@@ -582,7 +612,7 @@ where
XMLStarlet is a command line toolkit to query/edit/check/transform
XML documents (for more information see http://xmlstar.sourceforge.net/)
</pre><p>EXAMPLE</p><pre class="programlisting"># XML canonicalization
-xml c14n --with-comments ../examples/xml/structure.xml ; echo $?
+xmlstarlet c14n --with-comments ../examples/xml/structure.xml ; echo $?
</pre><p>Input ../examples/xml/structure.xml</p><pre class="programlisting"><a1>
<a11>
<a111>
@@ -612,7 +642,7 @@ xml c14n --with-comments ../examples/xml
</a1>
0
</pre><p>EXAMPLE</p><pre class="programlisting"># XML exclusive canonicalization
-xml c14n --exc-with-comments ../examples/xml/c14n.xml ../examples/xml/c14n.xpath
+xmlstarlet c14n --exc-with-comments ../examples/xml/c14n.xml ../examples/xml/c14n.xpath
</pre><p>Input</p><pre class="programlisting">../examples/xml/c14n.xml
<n0:pdu xmlns:n0='http://a.example.com'>
@@ -630,8 +660,8 @@ content
</pre><p>Output</p><pre class="programlisting"><n1:elem1 xmlns:n1="http://b.example">
content
</n1:elem1>
-</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e601"></a>7. XML and PYX format</h2></div></div><div></div></div><p>Here is synopsis for 'xml pyx' command:</p><pre class="programlisting">XMLStarlet Toolkit: Convert XML into PYX format (based on ESIS - ISO 8879)
-Usage: xml pyx {<xml-file>}+</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e601"></a>7. XML and PYX format</h2></div></div><div></div></div><p>Here is synopsis for 'xmlstarlet pyx' command:</p><pre class="programlisting">XMLStarlet Toolkit: Convert XML into PYX format (based on ESIS - ISO 8879)
+Usage: xmlstarlet pyx {<xml-file>}where
<xml-file> - input XML document file name (stdin is used if missing)
@@ -646,7 +676,7 @@ ESIS Generation by Sean Mc Grath http://
XMLStarlet is a command line toolkit to query/edit/check/transform
XML documents (for more information see http://xmlstar.sourceforge.net/)
-</pre><p>EXAMPLE</p><pre class="programlisting">xml pyx input.xml
+</pre><p>EXAMPLE</p><pre class="programlisting">xmlstarlet pyx input.xml
</pre><p>Input (input.xml)</p><pre class="programlisting"><books>
<book type='hardback'>
<title>Atlas Shrugged</title>
@@ -673,15 +703,15 @@ Aid 1
-\n
)book
-\n
-)books</pre><p>PYX is a line oriented format for XML files which can be helpful (and very efficient) when used in combination with regular line oriented UNIX command such as sed, grep, awk.</p><p>'depyx' option is used for conversion back from PYX into XML.</p><p>EXAMPLE (Delete all attributes). This should work really fast for very large XML documents.</p><pre class="programlisting">xml pyx input.xml | grep -v "^A" | xml depyx</pre><p>Output</p><pre class="programlisting"><books>
+)books</pre><p>PYX is a line oriented format for XML files which can be helpful (and very efficient) when used in combination with regular line oriented UNIX command such as sed, grep, awk.</p><p>'depyx' option is used for conversion back from PYX into XML.</p><p>EXAMPLE (Delete all attributes). This should work really fast for very large XML documents.</p><pre class="programlisting">xmlstarlet pyx input.xml | grep -v "^A" | xmlstarlet depyx</pre><p>Output</p><pre class="programlisting"><books>
<book>
<title>Atlas Shrugged</title>
<author>Ayn Rand</author>
<isbn>0525934189</isbn>
</book>
-</books></pre><p>Here is an article which describes how PYX format can be used to grep XML. <a href="???" target="_top">http://www-106.ibm.com/developerworks/xml/library/x-matters17.html</a></p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e636"></a>8. Escape/Unescape special XML characters</h2></div></div><div></div></div><p>Here is synopsis for 'xml esc' command:</p><pre class="programlisting">xml esc --help
+</books></pre><p>Here is an article which describes how PYX format can be used to grep XML. <a href="???" target="_top">http://www-106.ibm.com/developerworks/xml/library/x-matters17.html</a></p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e636"></a>8. Escape/Unescape special XML characters</h2></div></div><div></div></div><p>Here is synopsis for 'xmlstarlet esc' command:</p><pre class="programlisting">xmlstarlet esc --help
XMLStarlet Toolkit: Escape special XML characters
-Usage: xml esc [<options>] [<string>]
+Usage: xmlstarlet esc [<options>] [<string>]
where <options> are
--help - print usage
(TODO: more to be added in future)
@@ -690,7 +720,7 @@ if <string> is missing stdin is us
XMLStarlet is a command line toolkit to query/edit/check/transform
XML documents (for more information see http://xmlstar.sourceforge.net/)
</pre><p>EXAMPLE</p><pre class="programlisting"># Escape special XML characters
-cat xml/structure.xml | xml esc
+cat xml/structure.xml | xmlstarlet esc
</pre><p>Input</p><pre class="programlisting"><a1>
<a11>
<a111>
@@ -718,13 +748,13 @@ cat xml/structure.xml | xml esc
&lt;a131/&gt;
&lt;/a13&gt;
&lt;/a1&gt;
-</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e655"></a>9. List directory as XML</h2></div></div><div></div></div><p>Here is synopsis for 'xml ls' command:</p><pre class="programlisting">XMLStarlet Toolkit: List directory as XML
-Usage: xml ls
+</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e655"></a>9. List directory as XML</h2></div></div><div></div></div><p>Here is synopsis for 'xmlstarlet ls' command:</p><pre class="programlisting">XMLStarlet Toolkit: List directory as XML
+Usage: xmlstarlet ls
Lists current directory in XML format.
XMLStarlet is a command line toolkit to query/edit/check/transform
XML documents (for more information see http://xmlstar.sourceforge.net/)
-</pre><p>EXAMPLE</p><pre class="programlisting">xml ls
+</pre><p>EXAMPLE</p><pre class="programlisting">xmlstarlet ls
</pre><p>Output</p><pre class="programlisting"><xml>
<d a="rwxr-xr-x" acc="2004.02.13 00:06:03" mod="2004.02.13 00:06:00" sz="4096" n="."/>
<d a="rwxr-xr-x" acc="2004.02.12 23:54:35" mod="2004.02.13 00:00:09" sz="4096" n=".."/>
@@ -744,19 +774,19 @@ XML documents (for more information see
...
</body>
</html>
-</pre><p>And the following (initially looking correct) query to print all links</p><pre class="programlisting">xml sel -t -m "//a" -c . -n </pre><p>would return nothing. The issue with this query is that it is not addressing element <a> in the right namespace. XPath requires all namespaces used in XPath expression be defined. So for declared namespace <html xmlns="http://www.w3.org/1999/xhtml"> in input XML, you have to do same for XPath (or XSLT). There is another important detail: namespace equivalency is determined not by namespace prefix, but by URI. See query below, which would return expected result</p><pre class="programlisting">xml sel -N x="http://www.w3.org/1999/xhtml" -t -m "//x:a" -c . -n</pre><p>Example of deleting namespace declarations.</p><p>Delete namespace declarations and all elements from non default namespace from the following XML document:</p><p>Input (file ns2.xml)</p><pre class="programlisting"><doc xmlns="http://www.a.com/xyz" xmlns:ns="http://www.c.com/xyz">
+</pre><p>And the following (initially looking correct) query to print all links</p><pre class="programlisting">xmlstarlet sel -t -m "//a" -c . -n </pre><p>would return nothing. The issue with this query is that it is not addressing element <a> in the right namespace. XPath requires all namespaces used in XPath expression be defined. So for declared namespace <html xmlns="http://www.w3.org/1999/xhtml"> in input XML, you have to do same for XPath (or XSLT). There is another important detail: namespace equivalency is determined not by namespace prefix, but by URI. See query below, which would return expected result</p><pre class="programlisting">xmlstarlet sel -N x="http://www.w3.org/1999/xhtml" -t -m "//x:a" -c . -n</pre><p>Example of deleting namespace declarations.</p><p>Delete namespace declarations and all elements from non default namespace from the following XML document:</p><p>Input (file ns2.xml)</p><pre class="programlisting"><doc xmlns="http://www.a.com/xyz" xmlns:ns="http://www.c.com/xyz">
<A>test</A>
<B>
<ns:C>xyz</ns:C>
</B>
</doc>
-</pre><p>Command:</p><pre class="programlisting">xml ed -N N="http://www.c.com/xyz" -d '//N:*' ns2.xml | sed -e 's/ xmlns.*=".*"//g'</pre><p>Output</p><pre class="programlisting"><doc>
+</pre><p>Command:</p><pre class="programlisting">xmlstarlet ed -N N="http://www.c.com/xyz" -d '//N:*' ns2.xml | sed -e 's/ xmlns.*=".*"//g'</pre><p>Output</p><pre class="programlisting"><doc>
<A>test</A>
<B/>
</doc>
-</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e709"></a>2. Special characters</h2></div></div><div></div></div><p>Sometimes issues appear with handling of special characters, where 'special' means in XML sence as well as in 'shell' terms. Examples below should clear at least some of the confusions.</p><p>You should not forget about the fact that your command lines are executed by shell and shell does substitutions of its special characters too. So for example, one may ask:</p><p>"Why does the following query return nothing?"</p><pre class="programlisting">echo '<X name="foo">EEE</X>' | xml sel -t -m /X[@name='foo'] -v .</pre><p>The answer lies in the way shell substitues 'foo', which simply becomes foo before the command is run. So the correct way to write that would be</p><pre class="programlisting">echo '<X name="foo">EEE</X>' | xml sel -t -m "/X[@name='foo']" -v .</pre><p>Another example involves XML special characters. Question: How to search for &apos; in text nodes?</p><p>The following should help</p><pre class="programlisting">xml sel -t -m "//line[contains(text(),&quot;'&quot;)]" -c .
-</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e731"></a>3. Sorting</h2></div></div><div></div></div><p>Let's take a look at XSLT produced by the following 'xml sel' command:</p><pre class="programlisting"># Query XML document and produce sorted text table
-xml sel -T -t -m /xml/table/rec -s D:N:- "@id" -v "concat(@id,'|',numField,'|',stringField)" -n xml/table.xml
+</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e709"></a>2. Special characters</h2></div></div><div></div></div><p>Sometimes issues appear with handling of special characters, where 'special' means in XML sence as well as in 'shell' terms. Examples below should clear at least some of the confusions.</p><p>You should not forget about the fact that your command lines are executed by shell and shell does substitutions of its special characters too. So for example, one may ask:</p><p>"Why does the following query return nothing?"</p><pre class="programlisting">echo '<X name="foo">EEE</X>' | xmlstarlet sel -t -m /X[@name='foo'] -v .</pre><p>The answer lies in the way shell substitues 'foo', which simply becomes foo before the command is run. So the correct way to write that would be</p><pre class="programlisting">echo '<X name="foo">EEE</X>' | xmlstarlet sel -t -m "/X[@name='foo']" -v .</pre><p>Another example involves XML special characters. Question: How to search for &apos; in text nodes?</p><p>The following should help</p><pre class="programlisting">xmlstarlet sel -t -m "//line[contains(text(),&quot;'&quot;)]" -c .
+</pre></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e731"></a>3. Sorting</h2></div></div><div></div></div><p>Let's take a look at XSLT produced by the following 'xmlstarlet sel' command:</p><pre class="programlisting"># Query XML document and produce sorted text table
+xmlstarlet sel -T -t -m /xml/table/rec -s D:N:- "@id" -v "concat(@id,'|',numField,'|',stringField)" -n xml/table.xml
</pre><pre class="programlisting"><xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:output omit-xml-declaration="yes" indent="no" method="text"/>
<xsl:param name="inputFile">-</xsl:param>
@@ -771,4 +801,4 @@ xml sel -T -t -m /xml/table/rec -s D:N:-
</xsl:for-each>
</xsl:template>
</xsl:stylesheet>
-</pre><p>-s option of 'xml sel' command controls 'order', 'data-type', and 'case-order' attributes of <xsl:sort/> element .</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e744"></a>4. Validation</h2></div></div><div></div></div><p>Many questions are asked about XSD (XML schema) validation. Well, XmlStarlet relies on libxml2 which has incomplete support for XML schemas. Untill it is done in libxml2 it will not be in XmlStarlet.</p><p></p><p></p></div></div></div></body></html>
\ В конце файла нет новой строки
+</pre><p>-s option of 'xmlstarlet sel' command controls 'order', 'data-type', and 'case-order' attributes of <xsl:sort/> element .</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="d0e744"></a>4. Validation</h2></div></div><div></div></div><p>Many questions are asked about XSD (XML schema) validation. Well, XmlStarlet relies on libxml2 which has incomplete support for XML schemas. Untill it is done in libxml2 it will not be in XmlStarlet.</p><p></p><p></p></div></div></div></body></html>
\ В конце файла нет новой строки