MST 2002 John Fleck | 6647aed | 2002-12-26 02:23:24 +0000 | [diff] [blame] | 1 | .\"Generated by db2man.xsl. Don't modify this, modify the source. |
MDT 2001 John Fleck | fd32de6 | 2001-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 Fleck | 6647aed | 2002-12-26 02:23:24 +0000 | [diff] [blame] | 20 | .TH "XMLLINT" 1 "" "" "xmllint Manual" |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 21 | .SH NAME |
| 22 | xmllint \- command line XML tool |
| 23 | .SH "SYNOPSIS" |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 24 | .ad l |
| 25 | .hy 0 |
| 26 | .HP 8 |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 27 | \fBxmllint\fR [\fB\fB\-\-version\fR\fR | \fB\fB\-\-debug\fR\fR | \fB\fB\-\-shell\fR\fR | \fB\fB\-\-debugent\fR\fR | \fB\fB\-\-copy\fR\fR | \fB\fB\-\-recover\fR\fR | \fB\fB\-\-noent\fR\fR | \fB\fB\-\-noout\fR\fR | \fB\fB\-\-nonet\fR\fR | \fB\fB\-\-path\ "\fIPATHS\fR"\fR\fR | \fB\fB\-\-load\-trace\fR\fR | \fB\fB\-\-htmlout\fR\fR | \fB\fB\-\-nowrap\fR\fR | \fB\fB\-\-valid\fR\fR | \fB\fB\-\-postvalid\fR\fR | \fB\fB\-\-dtdvalid\ \fIURL\fR\fR\fR | \fB\fB\-\-dtdvalidfpi\ \fIFPI\fR\fR\fR | \fB\fB\-\-timing\fR\fR | \fB\fB\-\-output\ \fIFILE\fR\fR\fR | \fB\fB\-\-repeat\fR\fR | \fB\fB\-\-insert\fR\fR | \fB\fB\-\-compress\fR\fR | \fB\fB\-\-html\fR\fR | \fB\fB\-\-xmlout\fR\fR | \fB\fB\-\-push\fR\fR | \fB\fB\-\-memory\fR\fR | \fB\fB\-\-maxmem\ \fINBBYTES\fR\fR\fR | \fB\fB\-\-nowarning\fR\fR | \fB\fB\-\-noblanks\fR\fR | \fB\fB\-\-nocdata\fR\fR | \fB\fB\-\-format\fR\fR | \fB\fB\-\-encode\ \fIENCODING\fR\fR\fR | \fB\fB\-\-dropdtd\fR\fR | \fB\fB\-\-nsclean\fR\fR | \fB\fB\-\-testIO\fR\fR | \fB\fB\-\-catalogs\fR\fR | \fB\fB\-\-nocatalogs\fR\fR | \fB\fB\-\-auto\fR\fR | \fB\fB\-\-xinclude\fR\fR | \fB\fB\-\-noxincludenode\fR\fR | \fB\fB\-\-loaddtd\fR\fR | \fB\fB\-\-dtdattr\fR\fR | \fB\fB\-\-stream\fR\fR | \fB\fB\-\-walker\fR\fR | \fB\fB\-\-pattern\ \fIPATTERNVALUE\fR\fR\fR | \fB\fB\-\-chkregister\fR\fR | \fB\fB\-\-relaxng\ \fISCHEMA\fR\fR\fR | \fB\fB\-\-schema\ \fISCHEMA\fR\fR\fR | \fB\fB\-\-c14n\fR\fR] {\fIXML\-FILE(S)\fR...} |
| 28 | .ad |
| 29 | .hy |
| 30 | .ad l |
| 31 | .hy 0 |
| 32 | .HP 8 |
| 33 | \fBxmllint\fR \fB\-\-help\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 34 | .ad |
| 35 | .hy |
MST 2002 John Fleck | 6647aed | 2002-12-26 02:23:24 +0000 | [diff] [blame] | 36 | |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 37 | .SH "DESCRIPTION" |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 38 | |
| 39 | .PP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 40 | The \fBxmllint\fR program parses one or more XML files, specified on the command line as \fIXML\-FILE\fR (or the standard input if the filename provided is \- )\&. 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 Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 41 | |
| 42 | .PP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 43 | It is included in libxml2\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 44 | |
| 45 | .SH "OPTIONS" |
| 46 | |
| 47 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 48 | \fB\-\-help\fR |
| 49 | Print out a a short usage summary for \fBxmllint\fR\&. |
| 50 | |
| 51 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 52 | \fB\-\-version\fR |
| 53 | Display the version of libxml2 used\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 54 | |
| 55 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 56 | \fB\-\-debug\fR |
| 57 | Parse a file and output an annotated tree of the in\-memory version of the document\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 58 | |
| 59 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 60 | \fB\-\-shell\fR |
| 61 | Run a navigating shell\&. Details on available commands in shell mode are below\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 62 | |
| 63 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 64 | \fB\-\-debugent\fR |
| 65 | Debug the entities defined in the document\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 66 | |
| 67 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 68 | \fB\-\-copy\fR |
| 69 | Test the internal copy implementation\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 70 | |
| 71 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 72 | \fB\-\-recover\fR |
| 73 | Output any parsable portions of an invalid document\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 74 | |
| 75 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 76 | \fB\-\-noent\fR |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 77 | Substitute entity values for entity references\&. By default, \fBxmllint\fR leaves entity references in place\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 78 | |
| 79 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 80 | \fB\-\-nocdata\fR |
| 81 | Substitute CDATA section by equivalent text nodes\&. |
Daniel Veillard | dca8cc7 | 2003-09-26 13:53:14 +0000 | [diff] [blame] | 82 | |
| 83 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 84 | \fB\-\-nsclean\fR |
| 85 | Remove redundant namespace declarations\&. |
Daniel Veillard | dca8cc7 | 2003-09-26 13:53:14 +0000 | [diff] [blame] | 86 | |
| 87 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 88 | \fB\-\-noout\fR |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 89 | Suppress output\&. By default, \fBxmllint\fR outputs the result tree\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 90 | |
| 91 | .TP |
Daniel Veillard | 0bff36d | 2004-08-31 09:37:03 +0000 | [diff] [blame] | 92 | \fB\-\-nonet\fR |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 93 | Do not use the Internet to fetch DTDs or entities\&. |
Daniel Veillard | 0bff36d | 2004-08-31 09:37:03 +0000 | [diff] [blame] | 94 | |
| 95 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 96 | \fB\-\-path\fR "\fIPATHS\fR" |
| 97 | Use the list (separated by space or colon) of filesystem path specified by \fIPATHS\fR to load DTDs or entities \&. |
Daniel Veillard | 0bff36d | 2004-08-31 09:37:03 +0000 | [diff] [blame] | 98 | |
| 99 | .TP |
| 100 | \fB\-\-load\-trace\fR |
| 101 | Display to stderr all the documents loaded during the processing\&. |
| 102 | |
| 103 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 104 | \fB\-\-htmlout\fR |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 105 | Output results as an HTML file\&. This causes \fBxmllint\fR to output the necessary HTML tags surrounding the result tree output so the results can be displayed in a browser\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 106 | |
| 107 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 108 | \fB\-\-nowrap \fR |
| 109 | Do not output HTML doc wrapper\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 110 | |
| 111 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 112 | \fB\-\-valid\fR |
| 113 | Determine 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, \fBxmllint\fR also checks to determine if the document is well\-formed\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 114 | |
| 115 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 116 | \fB\-\-postvalid\fR |
| 117 | Validate after parsing is completed\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 118 | |
| 119 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 120 | \fB\-\-dtdvalid\fR \fIURL\fR |
| 121 | Use the DTD specified by \fIURL\fR for validation\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 122 | |
| 123 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 124 | \fB\-\-dtdvalidfpi\fR \fIFPI\fR |
| 125 | Use 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 Veillard | 66f68e7 | 2003-08-18 16:39:51 +0000 | [diff] [blame] | 126 | |
| 127 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 128 | \fB\-\-timing\fR |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 129 | Output information about the time it takes \fBxmllint\fR to perform the various steps\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 130 | |
| 131 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 132 | \fB\-\-output\fR \fIFILE\fR |
John Fleck | 3cbaa6d | 2004-08-15 00:47:45 +0000 | [diff] [blame] | 133 | Define a file path where xmllint will save the result of parsing\&. Usually the programs build a tree and save it on stdout, with this option the result XML instance will be saved onto a file\&. |
| 134 | |
| 135 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 136 | \fB\-\-repeat\fR |
| 137 | Repeat 100 times, for timing or profiling\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 138 | |
| 139 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 140 | \fB\-\-insert\fR |
| 141 | Test for valid insertions\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 142 | |
| 143 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 144 | \fB\-\-compress\fR |
| 145 | Turn on gzip compression of output\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 146 | |
| 147 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 148 | \fB\-\-html\fR |
| 149 | Use the HTML parser\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 150 | |
| 151 | .TP |
John Fleck | 3cbaa6d | 2004-08-15 00:47:45 +0000 | [diff] [blame] | 152 | \fB\-\-xmlout\fR |
Daniel Veillard | f10ae12 | 2005-07-10 19:03:16 +0000 | [diff] [blame] | 153 | Used in conjunction with \fB\-\-html\fR\&. Usually when HTML is parsed the document is saved with the HTML serializer, but with this option the resulting document is saved with the XML serializer\&. This is primarily used to generate XHTML from HTML input\&. |
John Fleck | 3cbaa6d | 2004-08-15 00:47:45 +0000 | [diff] [blame] | 154 | |
| 155 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 156 | \fB\-\-push\fR |
| 157 | Use the push mode of the parser\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 158 | |
| 159 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 160 | \fB\-\-memory\fR |
| 161 | Parse from memory\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 162 | |
| 163 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 164 | \fB\-\-maxmem\fR \fINNBYTES\fR |
| 165 | Test the parser memory support\&. \fINNBYTES\fR is the maximum number of bytes the library is allowed to allocate\&. This can also be used to make sure batch processing of XML files will not exhaust the virtual memory of the server running them\&. |
John Fleck | 3cbaa6d | 2004-08-15 00:47:45 +0000 | [diff] [blame] | 166 | |
| 167 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 168 | \fB\-\-nowarning\fR |
| 169 | Do not emit warnings from the parser and/or validator\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 170 | |
| 171 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 172 | \fB\-\-noblanks\fR |
| 173 | Drop ignorable blank spaces\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 174 | |
| 175 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 176 | \fB\-\-format\fR |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 177 | Reformat and reindent the output\&. The \fBXMLLINT_INDENT\fR environment variable controls the indentation (default value is two spaces " ")\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 178 | |
| 179 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 180 | \fB\-\-testIO\fR |
| 181 | Test user input/output support\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 182 | |
| 183 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 184 | \fB\-\-encode\fR \fIENCODING\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 185 | Output in the given encoding\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 186 | |
| 187 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 188 | \fB\-\-catalogs\fR |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 189 | Use the catalogs from \fBSGML_CATALOG_FILES\fR\&. Otherwise \fI/etc/xml/catalog\fR is used by default\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 190 | |
| 191 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 192 | \fB\-\-nocatalogs\fR |
| 193 | Do not use any catalogs\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 194 | |
| 195 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 196 | \fB\-\-auto\fR |
| 197 | Generate a small document for testing purposes\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 198 | |
| 199 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 200 | \fB\-\-xinclude\fR |
| 201 | Do XInclude processing\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 202 | |
| 203 | .TP |
Daniel Veillard | c14c389 | 2004-08-16 12:34:50 +0000 | [diff] [blame] | 204 | \fB\-\-noxincludenode\fR |
| 205 | Do XInclude processing but do not generate XInclude start and end nodes\&. |
| 206 | |
| 207 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 208 | \fB\-\-loaddtd\fR |
| 209 | Fetch external DTD\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 210 | |
| 211 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 212 | \fB\-\-dtdattr\fR |
| 213 | Fetch external DTD and populate the tree with inherited attributes\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 214 | |
MST 2001 John Fleck | 2323ac2 | 2001-12-14 04:24:50 +0000 | [diff] [blame] | 215 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 216 | \fB\-\-dropdtd\fR |
| 217 | Remove DTD from output\&. |
MST 2001 John Fleck | 2323ac2 | 2001-12-14 04:24:50 +0000 | [diff] [blame] | 218 | |
MST 2003 John Fleck | 7e54be1 | 2003-01-07 03:54:25 +0000 | [diff] [blame] | 219 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 220 | \fB\-\-stream\fR |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 221 | Use streaming API \- useful when used in combination with \fB\-\-relaxng\fR or \fB\-\-valid\fR options for validation of files that are too large to be held in memory\&. |
MST 2003 John Fleck | 7e54be1 | 2003-01-07 03:54:25 +0000 | [diff] [blame] | 222 | |
| 223 | .TP |
John Fleck | 3cbaa6d | 2004-08-15 00:47:45 +0000 | [diff] [blame] | 224 | \fB\-\-walker\fR |
| 225 | Test the walker module, which is a reader interface but for a document tree, instead of using the reader API on an unparsed document it works on a existing in\-memory tree\&. Used in debugging\&. |
| 226 | |
| 227 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 228 | \fB\-\-chkregister\fR |
Daniel Veillard | b9ded82 | 2004-08-14 13:53:13 +0000 | [diff] [blame] | 229 | Turn on node registration\&. Useful for developers testing libxml2 node tracking code\&. |
MST 2003 John Fleck | 7e54be1 | 2003-01-07 03:54:25 +0000 | [diff] [blame] | 230 | |
MST 2003 John Fleck | da27174 | 2003-03-25 14:05:17 +0000 | [diff] [blame] | 231 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 232 | \fB\-\-pattern\fR \fIPATTERNVALUE\fR |
John Fleck | 3cbaa6d | 2004-08-15 00:47:45 +0000 | [diff] [blame] | 233 | Used to exercise the pattern recognition engine, which can be used with the reader interface to the parser\&. It allows to select some nodes in the document based on an XPath (subset) expression\&. Used for debugging\&. |
| 234 | |
| 235 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 236 | \fB\-\-relaxng\fR \fISCHEMA\fR |
| 237 | Use RelaxNG file named \fISCHEMA\fR for validation\&. |
MST 2003 John Fleck | da27174 | 2003-03-25 14:05:17 +0000 | [diff] [blame] | 238 | |
Daniel Veillard | e8b09e4 | 2003-05-13 22:14:13 +0000 | [diff] [blame] | 239 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 240 | \fB\-\-schema\fR \fISCHEMA\fR |
| 241 | Use a W3C XML Schema file named \fISCHEMA\fR for validation\&. |
Daniel Veillard | e8b09e4 | 2003-05-13 22:14:13 +0000 | [diff] [blame] | 242 | |
| 243 | .TP |
MDT 2004 John Fleck | 774a3bd | 2004-08-15 00:54:21 +0000 | [diff] [blame] | 244 | \fB\-\-c14n\fR |
MDT 2004 John Fleck | b1b3a77 | 2004-08-19 13:45:47 +0000 | [diff] [blame] | 245 | Use the W3C XML Canonicalisation (C14N) to serialize the result of parsing to stdout\&. It keeps comments in the result\&. |
Daniel Veillard | e8b09e4 | 2003-05-13 22:14:13 +0000 | [diff] [blame] | 246 | |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 247 | .SH "SHELL COMMANDS" |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 248 | |
| 249 | .PP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 250 | \fBxmllint\fR offers an interactive shell mode invoked with the \fB\-\-shell\fR command\&. Available commands in shell mode include: |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 251 | |
| 252 | .TP |
| 253 | \fBbase\fR |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 254 | display XML base of the node |
| 255 | |
| 256 | .TP |
| 257 | \fBbye\fR |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 258 | leave shell |
| 259 | |
| 260 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 261 | \fBcat \fINODE\fR\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 262 | Display node if given or current node\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 263 | |
| 264 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 265 | \fBcd \fIPATH\fR\fR |
| 266 | Change the current node to \fIPATH\fR (if given and unique) or root if no argument given\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 267 | |
| 268 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 269 | \fBdir \fIPATH\fR\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 270 | Dumps information about the node (namespace, attributes, content)\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 271 | |
| 272 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 273 | \fBdu \fIPATH\fR\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 274 | Show the structure of the subtree under path or the current node\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 275 | |
| 276 | .TP |
| 277 | \fBexit\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 278 | Leave the shell\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 279 | |
| 280 | .TP |
| 281 | \fBhelp\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 282 | Show this help\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 283 | |
| 284 | .TP |
| 285 | \fBfree\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 286 | Display memory usage\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 287 | |
| 288 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 289 | \fBload \fIFILENAME\fR\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 290 | Load a new document with the given name\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 291 | |
| 292 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 293 | \fBls \fIPATH\fR\fR |
| 294 | List contents of \fIPATH\fR (if given) or the current directory\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 295 | |
| 296 | .TP |
| 297 | \fBpwd\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 298 | Display the path to the current node\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 299 | |
| 300 | .TP |
| 301 | \fBquit\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 302 | Leave the shell\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 303 | |
| 304 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 305 | \fBsave \fIFILENAME\fR\fR |
| 306 | Saves the current document to \fIFILENAME\fR if given or to the original name\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 307 | |
| 308 | .TP |
| 309 | \fBvalidate\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 310 | Check the document for error\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 311 | |
| 312 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 313 | \fBwrite \fIFILENAME\fR\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 314 | Write the current node to the given filename\&. |
| 315 | |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 316 | .SH "ENVIRONMENT" |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 317 | |
| 318 | .PP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 319 | On the completion of execution, \fBxmllint\fR returns the following error codes: |
MDT 2004 John Fleck | 4c76c4f | 2004-06-20 00:36:06 +0000 | [diff] [blame] | 320 | |
| 321 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 322 | \fBSGML_CATALOG_FILES\fR |
| 323 | \&.\&.\&. |
| 324 | |
| 325 | .TP |
| 326 | \fBXML_CATALOG_FILES\fR |
| 327 | Catalog behavior can be changed by redirecting queries to the user's own set of catalogs\&. This can be done by setting the \fBXML_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\&. |
| 328 | |
| 329 | .TP |
| 330 | \fBXML_DEBUG_CATALOG\fR |
| 331 | Setting the environment variable \fBXML_DEBUG_CATALOG\fR using the command \fB"export XML_DEBUG_CATALOG="\fR outputs debugging information related to catalog operations\&. |
| 332 | |
| 333 | .TP |
| 334 | \fBXMLLINT_INDENT\fR |
| 335 | \&.\&.\&. |
| 336 | |
| 337 | .SH "DIAGNOSTICS" |
| 338 | |
| 339 | .PP |
| 340 | On the completion of execution, \fBxmllint\fR returns the following error codes: |
| 341 | |
| 342 | .TP |
| 343 | \fB0\fR |
MDT 2004 John Fleck | 4c76c4f | 2004-06-20 00:36:06 +0000 | [diff] [blame] | 344 | No error |
| 345 | |
| 346 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 347 | \fB1\fR |
MDT 2004 John Fleck | 4c76c4f | 2004-06-20 00:36:06 +0000 | [diff] [blame] | 348 | Unclassified |
| 349 | |
| 350 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 351 | \fB2\fR |
MDT 2004 John Fleck | 4c76c4f | 2004-06-20 00:36:06 +0000 | [diff] [blame] | 352 | Error in DTD |
| 353 | |
| 354 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 355 | \fB3\fR |
MDT 2004 John Fleck | 4c76c4f | 2004-06-20 00:36:06 +0000 | [diff] [blame] | 356 | Validation error |
| 357 | |
| 358 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 359 | \fB4\fR |
MDT 2004 John Fleck | 4c76c4f | 2004-06-20 00:36:06 +0000 | [diff] [blame] | 360 | Validation error |
| 361 | |
| 362 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 363 | \fB5\fR |
MDT 2004 John Fleck | 4c76c4f | 2004-06-20 00:36:06 +0000 | [diff] [blame] | 364 | Error in schema compilation |
| 365 | |
| 366 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 367 | \fB6\fR |
MDT 2004 John Fleck | 4c76c4f | 2004-06-20 00:36:06 +0000 | [diff] [blame] | 368 | Error writing output |
| 369 | |
| 370 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 371 | \fB7\fR |
| 372 | Error in pattern (generated when \fB\-\-pattern\fR option is used) |
MDT 2004 John Fleck | 4c76c4f | 2004-06-20 00:36:06 +0000 | [diff] [blame] | 373 | |
| 374 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 375 | \fB8\fR |
| 376 | Error in Reader registration (generated when \fB\-\-chkregister\fR option is used) |
MDT 2004 John Fleck | 4c76c4f | 2004-06-20 00:36:06 +0000 | [diff] [blame] | 377 | |
| 378 | .TP |
Daniel Veillard | 6464d6a | 2006-02-19 21:35:39 +0000 | [diff] [blame^] | 379 | \fB9\fR |
MDT 2004 John Fleck | 4c76c4f | 2004-06-20 00:36:06 +0000 | [diff] [blame] | 380 | Out of memory error |
| 381 | |
MST 2002 John Fleck | 6647aed | 2002-12-26 02:23:24 +0000 | [diff] [blame] | 382 | .SH AUTHORS |
| 383 | John Fleck, Ziying Sherwin, Heiko Rupp. |