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 |
MDT 2004 John Fleck | 774a3bd | 2004-08-15 00:54:21 +0000 | [diff] [blame^] | 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\-\-noout\fR | \fB\-\-nonet\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\-\-output\ \fIfile\fR\fR | \fB\-\-repeat\fR | \fB\-\-insert\fR | \fB\-\-compress\fR | \fB\-\-html\fR | \fB\-\-xmlout\fR | \fB\-\-push\fR | \fB\-\-memory\fR | \fB\-\-maxmem\ \fInbbytes\fR\fR | \fB\-\-nowarning\fR | \fB\-\-noblanks\fR | \fB\-\-nocdata\fR | \fB\-\-format\fR | \fB\-\-encode\ \fIencoding\fR\fR | \fB\-\-dropdtd\fR | \fB\-\-nsclean\fR | \fB\-\-testIO\fR | \fB\-\-catalogs\fR | \fB\-\-nocatalogs\fR | \fB\-\-auto\fR | \fB\-\-xinclude\fR | \fB\-\-loaddtd\fR | \fB\-\-dtdattr\fR | \fB\-\-stream\fR | \fB\-\-walker\fR | \fB\-\-pattern\ \fIpatternvalue\fR\fR | \fB\-\-chkregister\fR | \fB\-\-relaxng\fR | \fB\-\-schema\fR | \fB\-\-c14n\fR] [\fB\fIxmlfile\fR\fR] |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 28 | .ad |
| 29 | .hy |
MST 2002 John Fleck | 6647aed | 2002-12-26 02:23:24 +0000 | [diff] [blame] | 30 | |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 31 | .SH "INTRODUCTION" |
| 32 | |
| 33 | .PP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 34 | The 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 Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 35 | |
| 36 | .PP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 37 | It is included in libxml2\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 38 | |
| 39 | .SH "OPTIONS" |
| 40 | |
| 41 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 42 | \fB\-\-version\fR |
| 43 | Display the version of libxml2 used\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 44 | |
| 45 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 46 | \fB\-\-debug\fR |
| 47 | 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] | 48 | |
| 49 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 50 | \fB\-\-shell\fR |
| 51 | 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] | 52 | |
| 53 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 54 | \fB\-\-debugent\fR |
| 55 | Debug the entities defined in the document\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 56 | |
| 57 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 58 | \fB\-\-copy\fR |
| 59 | Test the internal copy implementation\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 60 | |
| 61 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 62 | \fB\-\-recover\fR |
| 63 | Output any parsable portions of an invalid document\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 64 | |
| 65 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 66 | \fB\-\-noent\fR |
| 67 | Substitute entity values for entity references\&. By default, xmllint leaves entity references in place\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 68 | |
| 69 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 70 | \fB\-\-nocdata\fR |
| 71 | Substitute CDATA section by equivalent text nodes\&. |
Daniel Veillard | dca8cc7 | 2003-09-26 13:53:14 +0000 | [diff] [blame] | 72 | |
| 73 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 74 | \fB\-\-nsclean\fR |
| 75 | Remove redundant namespace declarations\&. |
Daniel Veillard | dca8cc7 | 2003-09-26 13:53:14 +0000 | [diff] [blame] | 76 | |
| 77 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 78 | \fB\-\-noout\fR |
| 79 | Suppress output\&. By default, xmllint outputs the result tree\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 80 | |
| 81 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 82 | \fB\-\-htmlout\fR |
| 83 | Output 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 Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 84 | |
| 85 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 86 | \fB\-\-nowrap \fR |
| 87 | Do not output HTML doc wrapper\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 88 | |
| 89 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 90 | \fB\-\-valid \fR |
| 91 | 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, xmllint also checks to determine if the document is well\-formed\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 92 | |
| 93 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 94 | \fB\-\-postvalid\fR |
| 95 | Validate after parsing is completed\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 96 | |
| 97 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 98 | \fB\-\-dtdvalid\fR \fIURL\fR |
| 99 | Use the DTD specified by \fIURL\fR for validation\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 100 | |
| 101 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 102 | \fB\-\-dtdvalidfpi\fR \fIFPI\fR |
| 103 | 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] | 104 | |
| 105 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 106 | \fB\-\-timing\fR |
| 107 | Output information about the time it takes xmllint to perform the various steps\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 108 | |
| 109 | .TP |
John Fleck | 3cbaa6d | 2004-08-15 00:47:45 +0000 | [diff] [blame] | 110 | \fB\-\-output\fR \fIfile\fR |
| 111 | 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\&. |
| 112 | |
| 113 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 114 | \fB\-\-repeat\fR |
| 115 | Repeat 100 times, for timing or profiling\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 116 | |
| 117 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 118 | \fB\-\-insert\fR |
| 119 | Test for valid insertions\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 120 | |
| 121 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 122 | \fB\-\-compress\fR |
| 123 | Turn on gzip compression of output\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 124 | |
| 125 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 126 | \fB\-\-html\fR |
| 127 | Use the HTML parser\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 128 | |
| 129 | .TP |
John Fleck | 3cbaa6d | 2004-08-15 00:47:45 +0000 | [diff] [blame] | 130 | \fB\-\-xmlout\fR |
| 131 | Used in conjusntion 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\&. |
| 132 | |
| 133 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 134 | \fB\-\-push\fR |
| 135 | Use the push mode of the parser\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 136 | |
| 137 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 138 | \fB\-\-memory\fR |
| 139 | Parse from memory\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 140 | |
| 141 | .TP |
John Fleck | 3cbaa6d | 2004-08-15 00:47:45 +0000 | [diff] [blame] | 142 | \fB\-\-maxmem\fR \fInnbytes\fR |
| 143 | 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\&. |
| 144 | |
| 145 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 146 | \fB\-\-nowarning\fR |
| 147 | Do not emit warnings from the parser and/or validator\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 148 | |
| 149 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 150 | \fB\-\-noblanks\fR |
| 151 | Drop ignorable blank spaces\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 152 | |
| 153 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 154 | \fB\-\-format\fR |
| 155 | Reformat and reindent the output\&. The $XMLLINT_INDENT environment variable controls the indentation (default value is two spaces " ")\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 156 | |
| 157 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 158 | \fB\-\-testIO\fR |
| 159 | Test user input/output support\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 160 | |
| 161 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 162 | \fB\-\-encode\fR \fIencoding\fR |
| 163 | Output in the given encoding\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 164 | |
| 165 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 166 | \fB\-\-catalogs\fR |
| 167 | Use the catalogs from $SGML_CATALOG_FILES\&. Otherwise /etc/xml/catalog is used by default\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 168 | |
| 169 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 170 | \fB\-\-nocatalogs\fR |
| 171 | Do not use any catalogs\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 172 | |
| 173 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 174 | \fB\-\-auto\fR |
| 175 | Generate a small document for testing purposes\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 176 | |
| 177 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 178 | \fB\-\-xinclude\fR |
| 179 | Do XInclude processing\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 180 | |
| 181 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 182 | \fB\-\-loaddtd\fR |
| 183 | Fetch external DTD\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 184 | |
| 185 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 186 | \fB\-\-dtdattr\fR |
| 187 | Fetch external DTD and populate the tree with inherited attributes\&. |
MDT 2001 John Fleck | fd32de6 | 2001-10-27 20:14:01 +0000 | [diff] [blame] | 188 | |
MST 2001 John Fleck | 2323ac2 | 2001-12-14 04:24:50 +0000 | [diff] [blame] | 189 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 190 | \fB\-\-dropdtd\fR |
| 191 | Remove DTD from output\&. |
MST 2001 John Fleck | 2323ac2 | 2001-12-14 04:24:50 +0000 | [diff] [blame] | 192 | |
MST 2003 John Fleck | 7e54be1 | 2003-01-07 03:54:25 +0000 | [diff] [blame] | 193 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 194 | \fB\-\-stream\fR |
| 195 | Use 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 Fleck | 7e54be1 | 2003-01-07 03:54:25 +0000 | [diff] [blame] | 196 | |
| 197 | .TP |
John Fleck | 3cbaa6d | 2004-08-15 00:47:45 +0000 | [diff] [blame] | 198 | \fB\-\-walker\fR |
| 199 | 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\&. |
| 200 | |
| 201 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 202 | \fB\-\-chkregister\fR |
Daniel Veillard | b9ded82 | 2004-08-14 13:53:13 +0000 | [diff] [blame] | 203 | 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] | 204 | |
MST 2003 John Fleck | da27174 | 2003-03-25 14:05:17 +0000 | [diff] [blame] | 205 | .TP |
John Fleck | 3cbaa6d | 2004-08-15 00:47:45 +0000 | [diff] [blame] | 206 | \fB\-\-pattern\fR \fIpatternvalue\fR |
| 207 | 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\&. |
| 208 | |
| 209 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 210 | \fB\-\-relaxng\fR \fIschema\fR |
| 211 | Use RelaxNG file named \fIschema\fR for validation\&. |
MST 2003 John Fleck | da27174 | 2003-03-25 14:05:17 +0000 | [diff] [blame] | 212 | |
Daniel Veillard | e8b09e4 | 2003-05-13 22:14:13 +0000 | [diff] [blame] | 213 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 214 | \fB\-\-schema\fR \fIschema\fR |
| 215 | Use a W3C XML Schema file named \fIschema\fR for validation\&. |
Daniel Veillard | e8b09e4 | 2003-05-13 22:14:13 +0000 | [diff] [blame] | 216 | |
| 217 | .TP |
MDT 2004 John Fleck | 774a3bd | 2004-08-15 00:54:21 +0000 | [diff] [blame^] | 218 | \fB\-\-c14n\fR |
| 219 | Output canonical XML\&. |
| 220 | |
| 221 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 222 | \fB\-\-nonet\fR |
| 223 | Do not use the Internet to fetch DTD's or entities\&. |
Daniel Veillard | e8b09e4 | 2003-05-13 22:14:13 +0000 | [diff] [blame] | 224 | |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 225 | .SH "SHELL" |
| 226 | |
| 227 | .PP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 228 | xmllint 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] | 229 | |
| 230 | .TP |
| 231 | \fBbase\fR |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 232 | display XML base of the node |
| 233 | |
| 234 | .TP |
| 235 | \fBbye\fR |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 236 | leave shell |
| 237 | |
| 238 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 239 | \fBcat \fInode\fR\fR |
| 240 | Display node if given or current node\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 241 | |
| 242 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 243 | \fBcd \fIpath\fR\fR |
| 244 | 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] | 245 | |
| 246 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 247 | \fBdir \fIpath\fR\fR |
| 248 | Dumps information about the node (namespace, attributes, content)\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 249 | |
| 250 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 251 | \fBdu \fIpath\fR\fR |
| 252 | 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] | 253 | |
| 254 | .TP |
| 255 | \fBexit\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 256 | Leave the shell\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 257 | |
| 258 | .TP |
| 259 | \fBhelp\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 260 | Show this help\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 261 | |
| 262 | .TP |
| 263 | \fBfree\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 264 | Display memory usage\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 265 | |
| 266 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 267 | \fBload \fIname\fR\fR |
| 268 | Load a new document with the given name\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 269 | |
| 270 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 271 | \fBls \fIpath\fR\fR |
| 272 | 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] | 273 | |
| 274 | .TP |
| 275 | \fBpwd\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 276 | Display the path to the current node\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 277 | |
| 278 | .TP |
| 279 | \fBquit\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 280 | Leave the shell\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 281 | |
| 282 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 283 | \fBsave \fIname\fR\fR |
| 284 | Saves the current document to \fIname\fR if given or to the original name\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 285 | |
| 286 | .TP |
| 287 | \fBvalidate\fR |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 288 | Check the document for error\&. |
MST 2001 John Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 289 | |
| 290 | .TP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 291 | \fBwrite \fIname\fR\fR |
| 292 | Write the current node to the given filename\&. |
| 293 | |
| 294 | .SH "CATALOGS" |
| 295 | |
| 296 | .PP |
| 297 | Catalog 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 Fleck | 4230404 | 2001-11-18 00:18:06 +0000 | [diff] [blame] | 298 | |
MST 2002 John Fleck | 6647aed | 2002-12-26 02:23:24 +0000 | [diff] [blame] | 299 | .SH "DEBUGGING CATALOGS" |
| 300 | |
| 301 | .PP |
MST 2004 John Fleck | e42ae6f | 2004-02-27 03:26:30 +0000 | [diff] [blame] | 302 | Setting 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 Fleck | 6647aed | 2002-12-26 02:23:24 +0000 | [diff] [blame] | 303 | |
MDT 2004 John Fleck | 4c76c4f | 2004-06-20 00:36:06 +0000 | [diff] [blame] | 304 | .SH "ERROR RETURN CODES" |
| 305 | |
| 306 | .PP |
| 307 | On the completion of execution, Xmllint returns the following error codes: |
| 308 | |
| 309 | .TP |
| 310 | 0 |
| 311 | No error |
| 312 | |
| 313 | .TP |
| 314 | 1 |
| 315 | Unclassified |
| 316 | |
| 317 | .TP |
| 318 | 2 |
| 319 | Error in DTD |
| 320 | |
| 321 | .TP |
| 322 | 3 |
| 323 | Validation error |
| 324 | |
| 325 | .TP |
| 326 | 4 |
| 327 | Validation error |
| 328 | |
| 329 | .TP |
| 330 | 5 |
| 331 | Error in schema compilation |
| 332 | |
| 333 | .TP |
| 334 | 6 |
| 335 | Error writing output |
| 336 | |
| 337 | .TP |
| 338 | 7 |
| 339 | Error in pattern (generated when [\-\-pattern] option is used) |
| 340 | |
| 341 | .TP |
| 342 | 8 |
| 343 | Error in Reader registration (generated when [\-\-chkregister] option is used) |
| 344 | |
| 345 | .TP |
| 346 | 9 |
| 347 | Out of memory error |
| 348 | |
MST 2002 John Fleck | 6647aed | 2002-12-26 02:23:24 +0000 | [diff] [blame] | 349 | .SH AUTHORS |
| 350 | John Fleck, Ziying Sherwin, Heiko Rupp. |