<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl"
   href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry>
  <refentryinfo>
    <title>xmlstarlet Manual</title>

    <copyright>
      <year>2004</year>
    </copyright>

    <author>
      <firstname>Mikhail</firstname>

      <surname>Grushinskiy</surname>
    </author>

    <address><email>mgrouch@users.sourceforge.net</email></address>

    <releaseinfo>This is release 0.9.1 of the xmlstarlet Manual.</releaseinfo>
  </refentryinfo>

  <refmeta>
    <refentrytitle>xmlstarlet</refentrytitle>

    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>xmlstarlet</refname>

    <refpurpose>command line <acronym>XML/XSLT</acronym> toolkit</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>xmlstarlet</command>

      <arg><option><replaceable>&lt;options&gt;</replaceable></option></arg>

      <arg><option><replaceable>&lt;command&gt;</replaceable></option></arg>

      <arg><option><replaceable>&lt;cmd-options&gt;</replaceable></option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="introduction">
    <title>Introduction</title>

    <para>XMLStarlet 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. 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.</para>
  </refsect1>

  <refsect1 id="options">
    <title>Options</title>

    <variablelist>
      <varlistentry>
        <term><option>--version</option></term>

        <listitem>
          <simpara>Display the version of
          <application>xmlstarlet</application>.</simpara>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--help</option></term>

        <listitem>
          <simpara>Display help.</simpara>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id="shell">
    <title>Commands</title>

    <para>Type: xml &lt;command&gt; --help &lt;ENTER&gt; for command
    help</para>

    <para>Available commands include:</para>

    <variablelist>
      <varlistentry>
        <term><option>ed (or edit)</option></term>

        <listitem>
          <simpara>Edit/update XML document(s).</simpara>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>sel (or select)</option></term>

        <listitem>
          <simpara>Select data or query XML document(s) (XPATH,
          etc).</simpara>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>tr (or transform)</option></term>

        <listitem>
          <simpara>Transform XML documents(s) using XSLT.</simpara>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>val (or validate)</option></term>

        <listitem>
          <simpara>Validate XML document(s)
          (well-formed/DTD/XSD/RelaxNG).</simpara>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>fo (or format)</option></term>

        <listitem>
          <simpara>Format XML document(s).</simpara>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>el (or elements)</option></term>

        <listitem>
          <simpara>Display element structure of XML document.</simpara>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>c14n (or canonic)</option></term>

        <listitem>
          <simpara>XML canonicalization.</simpara>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>ls (or list)</option></term>

        <listitem>
          <simpara>List directory as XML.</simpara>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>esc (or escape)</option></term>

        <listitem>
          <simpara>Escape special XML characters.</simpara>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>unesc (or unescape)</option></term>

        <listitem>
          <simpara>Unescape special XML characters.</simpara>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>pyx (or xmln)</option></term>

        <listitem>
          <simpara>Convert XML into PYX format (based on ESIS - ISO
          8879).</simpara>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>p2x (or depyx)</option></term>

        <listitem>
          <simpara>Convert PYX into XML.</simpara>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>References</title>

    <para>XMLStarlet is a command line toolkit to query/edit/check/transform
    XML documents (for more information see
    http://xmlstar.sourceforge.net/).</para>
  </refsect1>
</refentry>
