summaryrefslogtreecommitdiff
path: root/doc/xmlstarlet-man.xml
blob: 9299b59551bc820baf324997b6c51ce779dca9ed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
<?xml version="1.0" encoding="UTF-8"?>
<refentry xmlns="http://docbook.org/ns/docbook"
          xmlns:db="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          version="5.0">
  <info>
    <copyright><year>2012</year></copyright>

    <author>
      <personname>
        <firstname>Mikhail</firstname>
        <surname>Grushinskiy</surname>
      </personname>
      <contrib>XMLStarlet creator.</contrib>
    </author>

    <releaseinfo>Version <phrase role="VERSION"/></releaseinfo>
  </info>

  <refmeta>
    <refentrytitle>xmlstarlet</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo class="manual">XMLStarlet Manual</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>xmlstarlet</refname>

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

  <refsynopsisdiv>
    <cmdsynopsis>
      <command><phrase role="PROG"/></command>
      <arg choice="opt" rep="repeat"><replaceable>options</replaceable></arg>
      <arg choice="req"><replaceable>command</replaceable></arg>
      <arg choice="opt" rep="repeat"><replaceable>cmd-options</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 xml: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 xml: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 xml:id="shell">
    <title>Commands</title>

    <para><command><phrase role="PROG"/></command>
    <replaceable>command</replaceable> <option>--help</option>
    for command specific 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>

  <refsect1>
    <title>Bugs</title>
    <para> Report bugs to the mailing list,
    <email>xmlstar-devel@lists.sourceforge.net</email> or the bug tracker: <link
    xlink:href="http://sourceforge.net/tracker/?group_id=66612&amp;atid=515106"/>.
    </para>
  </refsect1>
</refentry>