Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / b9ded8275051c45dff2ab9260cba107d78a41e07 / . / doc / xmllint.1
blob: 852d7b7947d5314c326726fc7da6343eca1d98f8 [file] [log] [blame]
MST 2002 John Fleck6647aed2002-12-26 02:23:24 +0000[diff] [blame]1.\"Generated by db2man.xsl. Don't modify this, modify the source.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]2.de Sh \" Subsection
3.br
4.if t .Sp
5.ne 5
6.PP
7\fB\\$1\fR
8.PP
9..
10.de Sp \" Vertical space (when we can't use .PP)
11.if t .sp .5v
12.if n .sp
13..
14.de Ip \" List item
15.br
16.ie \\n(.$>=3 .ne \\$3
17.el .ne 3
18.IP "\\$1" \\$2
19..
MST 2002 John Fleck6647aed2002-12-26 02:23:24 +0000[diff] [blame]20.TH "XMLLINT" 1 "" "" "xmllint Manual"
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]21.SH NAME
22xmllint \- command line XML tool
23.SH "SYNOPSIS"
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]24.ad l
25.hy 0
26.HP 8
27\fBxmllint\fR [\fB\-\-version\fR | \fB\-\-debug\fR | \fB\-\-shell\fR | \fB\-\-debugent\fR | \fB\-\-copy\fR | \fB\-\-recover\fR | \fB\-\-noent\fR | \fB\-\-nocdata\fR | \fB\-\-nsclean\fR | \fB\-\-noout\fR | \fB\-\-htmlout\fR | \fB\-\-nowrap\fR | \fB\-\-valid\fR | \fB\-\-postvalid\fR | \fB\-\-dtdvalid\ \fIURL\fR\fR | \fB\-\-dtdvalidfpi\ \fIFPI\fR\fR | \fB\-\-timing\fR | \fB\-\-repeat\fR | \fB\-\-insert\fR | \fB\-\-compress\fR | \fB\-\-html\fR | \fB\-\-push\fR | \fB\-\-memory\fR | \fB\-\-nowarning\fR | \fB\-\-noblanks\fR | \fB\-\-format\fR | \fB\-\-testIO\fR | \fB\-\-encode\ \fIencoding\fR\fR | \fB\-\-catalogs\fR | \fB\-\-nocatalogs\fR | \fB\-\-auto\fR | \fB\-\-xinclude\fR | \fB\-\-loaddtd\fR | \fB\-\-dtdattr\fR | \fB\-\-dropdtd\fR | \fB\-\-stream\fR | \fB\-\-chkregister\fR | \fB\-\-relaxng\fR | \fB\-\-schema\fR | \fB\-\-nonet\fR] [\fB\fIxmlfile\fR\fR]
28.ad
29.hy
MST 2002 John Fleck6647aed2002-12-26 02:23:24 +0000[diff] [blame]30
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]31.SH "INTRODUCTION"
32
33.PP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]34The xmllint program parses one or more XML files, specified on the command line as \fIxmlfile\fR\&. It prints various types of output, depending upon the options selected\&. It is useful for detecting errors both in XML code and in the XML parser itself\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]35
36.PP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]37It is included in libxml2\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]38
39.SH "OPTIONS"
40
41.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]42\fB\-\-version\fR
43Display the version of libxml2 used\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]44
45.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]46\fB\-\-debug\fR
47Parse a file and output an annotated tree of the in\-memory version of the document\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]48
49.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]50\fB\-\-shell\fR
51Run a navigating shell\&. Details on available commands in shell mode are below\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]52
53.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]54\fB\-\-debugent\fR
55Debug the entities defined in the document\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]56
57.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]58\fB\-\-copy\fR
59Test the internal copy implementation\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]60
61.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]62\fB\-\-recover\fR
63Output any parsable portions of an invalid document\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]64
65.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]66\fB\-\-noent\fR
67Substitute entity values for entity references\&. By default, xmllint leaves entity references in place\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]68
69.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]70\fB\-\-nocdata\fR
71Substitute CDATA section by equivalent text nodes\&.
Daniel Veillarddca8cc72003-09-26 13:53:14 +0000[diff] [blame]72
73.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]74\fB\-\-nsclean\fR
75Remove redundant namespace declarations\&.
Daniel Veillarddca8cc72003-09-26 13:53:14 +0000[diff] [blame]76
77.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]78\fB\-\-noout\fR
79Suppress output\&. By default, xmllint outputs the result tree\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]80
81.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]82\fB\-\-htmlout\fR
83Output results as an HTML file\&. This causes xmllint to output the necessary HTML tags surrounding the result tree output so the results can be displayed in a browser\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]84
85.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]86\fB\-\-nowrap \fR
87Do not output HTML doc wrapper\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]88
89.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]90\fB\-\-valid \fR
91Determine if the document is a valid instance of the included Document Type Definition (DTD)\&. A DTD to be validated against also can be specified at the command line using the \fB\-\-dtdvalid\fR option\&. By default, xmllint also checks to determine if the document is well\-formed\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]92
93.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]94\fB\-\-postvalid\fR
95Validate after parsing is completed\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]96
97.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]98\fB\-\-dtdvalid\fR \fIURL\fR
99Use the DTD specified by \fIURL\fR for validation\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]100
101.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]102\fB\-\-dtdvalidfpi\fR \fIFPI\fR
103Use the DTD specified by the Public Identifier \fIFPI\fR for validation, note that this will require a Catalog exporting that Public Identifier to work\&.
Daniel Veillard66f68e72003-08-18 16:39:51 +0000[diff] [blame]104
105.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]106\fB\-\-timing\fR
107Output information about the time it takes xmllint to perform the various steps\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]108
109.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]110\fB\-\-repeat\fR
111Repeat 100 times, for timing or profiling\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]112
113.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]114\fB\-\-insert\fR
115Test for valid insertions\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]116
117.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]118\fB\-\-compress\fR
119Turn on gzip compression of output\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]120
121.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]122\fB\-\-html\fR
123Use the HTML parser\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]124
125.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]126\fB\-\-push\fR
127Use the push mode of the parser\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]128
129.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]130\fB\-\-memory\fR
131Parse from memory\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]132
133.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]134\fB\-\-nowarning\fR
135Do not emit warnings from the parser and/or validator\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]136
137.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]138\fB\-\-noblanks\fR
139Drop ignorable blank spaces\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]140
141.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]142\fB\-\-format\fR
143Reformat and reindent the output\&. The $XMLLINT_INDENT environment variable controls the indentation (default value is two spaces " ")\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]144
145.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]146\fB\-\-testIO\fR
147Test user input/output support\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]148
149.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]150\fB\-\-encode\fR \fIencoding\fR
151Output in the given encoding\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]152
153.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]154\fB\-\-catalogs\fR
155Use the catalogs from $SGML_CATALOG_FILES\&. Otherwise /etc/xml/catalog is used by default\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]156
157.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]158\fB\-\-nocatalogs\fR
159Do not use any catalogs\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]160
161.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]162\fB\-\-auto\fR
163Generate a small document for testing purposes\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]164
165.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]166\fB\-\-xinclude\fR
167Do XInclude processing\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]168
169.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]170\fB\-\-loaddtd\fR
171Fetch external DTD\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]172
173.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]174\fB\-\-dtdattr\fR
175Fetch external DTD and populate the tree with inherited attributes\&.
MDT 2001 John Fleckfd32de62001-10-27 20:14:01 +0000[diff] [blame]176
MST 2001 John Fleck2323ac22001-12-14 04:24:50 +0000[diff] [blame]177.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]178\fB\-\-dropdtd\fR
179Remove DTD from output\&.
MST 2001 John Fleck2323ac22001-12-14 04:24:50 +0000[diff] [blame]180
MST 2003 John Fleck7e54be12003-01-07 03:54:25 +0000[diff] [blame]181.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]182\fB\-\-stream\fR
183Use streaming API \- useful when used in combination with \-\-relaxng or \-\-valid options for validation of files that are too large to be held in memory\&.
MST 2003 John Fleck7e54be12003-01-07 03:54:25 +0000[diff] [blame]184
185.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]186\fB\-\-chkregister\fR
Daniel Veillardb9ded822004-08-14 13:53:13 +0000[diff] [blame^]187Turn on node registration\&. Useful for developers testing libxml2 node tracking code\&.
MST 2003 John Fleck7e54be12003-01-07 03:54:25 +0000[diff] [blame]188
MST 2003 John Fleckda271742003-03-25 14:05:17 +0000[diff] [blame]189.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]190\fB\-\-relaxng\fR \fIschema\fR
191Use RelaxNG file named \fIschema\fR for validation\&.
MST 2003 John Fleckda271742003-03-25 14:05:17 +0000[diff] [blame]192
Daniel Veillarde8b09e42003-05-13 22:14:13 +0000[diff] [blame]193.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]194\fB\-\-schema\fR \fIschema\fR
195Use a W3C XML Schema file named \fIschema\fR for validation\&.
Daniel Veillarde8b09e42003-05-13 22:14:13 +0000[diff] [blame]196
197.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]198\fB\-\-nonet\fR
199Do not use the Internet to fetch DTD's or entities\&.
Daniel Veillarde8b09e42003-05-13 22:14:13 +0000[diff] [blame]200
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]201.SH "SHELL"
202
203.PP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]204 xmllint offers an interactive shell mode invoked with the \fB\-\-shell\fR command\&. Available commands in shell mode include:
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]205
206.TP
207\fBbase\fR
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]208display XML base of the node
209
210.TP
211\fBbye\fR
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]212leave shell
213
214.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]215\fBcat \fInode\fR\fR
216Display node if given or current node\&.
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]217
218.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]219\fBcd \fIpath\fR\fR
220Change the current node to \fIpath\fR (if given and unique) or root if no argument given\&.
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]221
222.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]223\fBdir \fIpath\fR\fR
224Dumps information about the node (namespace, attributes, content)\&.
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]225
226.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]227\fBdu \fIpath\fR\fR
228Show the structure of the subtree under path or the current node\&.
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]229
230.TP
231\fBexit\fR
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]232Leave the shell\&.
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]233
234.TP
235\fBhelp\fR
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]236Show this help\&.
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]237
238.TP
239\fBfree\fR
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]240Display memory usage\&.
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]241
242.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]243\fBload \fIname\fR\fR
244Load a new document with the given name\&.
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]245
246.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]247\fBls \fIpath\fR\fR
248List contents of \fIpath\fR (if given) or the current directory\&.
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]249
250.TP
251\fBpwd\fR
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]252Display the path to the current node\&.
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]253
254.TP
255\fBquit\fR
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]256Leave the shell\&.
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]257
258.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]259\fBsave \fIname\fR\fR
260Saves the current document to \fIname\fR if given or to the original name\&.
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]261
262.TP
263\fBvalidate\fR
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]264Check the document for error\&.
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]265
266.TP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]267\fBwrite \fIname\fR\fR
268Write the current node to the given filename\&.
269
270.SH "CATALOGS"
271
272.PP
273Catalog behavior can be changed by redirecting queries to the user's own set of catalogs\&. This can be done by setting the \fIXML_CATALOG_FILES\fR environment variable to a list of catalogs\&. An empty one should deactivate loading the default \fI/etc/xml/catalog\fR default catalog\&.
MST 2001 John Fleck42304042001-11-18 00:18:06 +0000[diff] [blame]274
MST 2002 John Fleck6647aed2002-12-26 02:23:24 +0000[diff] [blame]275.SH "DEBUGGING CATALOGS"
276
277.PP
MST 2004 John Flecke42ae6f2004-02-27 03:26:30 +0000[diff] [blame]278Setting the environment variable \fIXML_DEBUG_CATALOG\fR using the command \fB"export XML_DEBUG_CATALOG="\fR outputs debugging information related to catalog operations\&.
MST 2002 John Fleck6647aed2002-12-26 02:23:24 +0000[diff] [blame]279
MDT 2004 John Fleck4c76c4f2004-06-20 00:36:06 +0000[diff] [blame]280.SH "ERROR RETURN CODES"
281
282.PP
283On the completion of execution, Xmllint returns the following error codes:
284
285.TP
2860
287No error
288
289.TP
2901
291Unclassified
292
293.TP
2942
295Error in DTD
296
297.TP
2983
299Validation error
300
301.TP
3024
303Validation error
304
305.TP
3065
307Error in schema compilation
308
309.TP
3106
311Error writing output
312
313.TP
3147
315Error in pattern (generated when [\-\-pattern] option is used)
316
317.TP
3188
319Error in Reader registration (generated when [\-\-chkregister] option is used)
320
321.TP
3229
323Out of memory error
324
MST 2002 John Fleck6647aed2002-12-26 02:23:24 +0000[diff] [blame]325.SH AUTHORS
326John Fleck, Ziying Sherwin, Heiko Rupp.