diff --git a/ChangeLog b/ChangeLog index 0b18e4f9..f211e069 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +Tue Jul 22 19:42:15 MDT 2003 John Fleck + + * doc/xmllint.html + include html version of the xmllint man page, so an + up-to-date version is visible on the Web + Mon Jul 21 21:53:43 IST 2003 Daniel Veillard * xinclude.c include/libxml/xinclude.h: added a new API diff --git a/doc/xmllint.html b/doc/xmllint.html new file mode 100644 index 00000000..4d26c6c5 --- /dev/null +++ b/doc/xmllint.html @@ -0,0 +1,143 @@ +xmllint

Name

xmllint — command line XML tool

Synopsis

xmllint [[--version] | [--debug] | [--shell] | [--debugent] | [--copy] | [--recover] | [--noent] | [--noout] | [--htmlout] | [--nowrap] | [--valid] | [--postvalid] | [--dtdvalid URL] | [--timing] | [--repeat] | [--insert] | [--compress] | [--sgml] | [--html] | [--push] | [--memory] | [--nowarning] | [--noblanks] | [--format] | [--testIO] | [--encode encoding] | [--catalogs] | [--nocatalogs] | [--auto] | [--xinclude] | [--loaddtd] | [--dtdattr] | [--dropdtd] | [--stream] | [--chkregister] | [--relaxng] | [--schema] | [--nonet]] [xmlfile]

Introduction

+ The xmllint program parses one or more XML files, specified on the + command line as xmlfile. 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. +

+ It is included in libxml2. +

Options

--version
+ Display the version of + libxml2 used. +
--debug
+ Parse a file and output an annotated tree of the + in-memory version of the document. +
--shell
+ Run a navigating shell. Details on available commands in shell mode + are below. +
--debugent
+ Debug the entities defined in the document. +
--copy
+ Test the internal copy implementation. +
--recover
+ Output any parsable portions of an invalid + document. +
--noent
+ Substitute entity values for entity + references. By default, xmllint leaves entity + references in place. +
--noout
+ Suppress output. By default, + xmllint outputs the result tree. +
--htmlout
+ 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. +
--nowrap
+ Do not output HTML doc wrapper. +
--valid
+ 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 --dtdvalid option. By default, + xmllint also checks to determine if the + document is well-formed. +
--postvalid
+ Validate after parsing is completed. +
--dtdvalid URL
+ Use the + DTD specified by URL for + validation. +
--timing
+ Output information about the time it takes + xmllint to perform the various steps. +
--repeat
+ Repeat 100 times, for timing or profiling. +
--insert
+ Test for valid insertions. +
--compress
+ Turn on gzip compression of output. +
--sgml
Use the DocBook SGML parser. This allows + documents written in SGML DocBook to be converted + into an in-memory tree and treated as if they were written in + XML.
--html
+ Use the HTML parser. +
--push
+ Use the push mode of the parser. +
--memory
+ Parse from memory. +
--nowarning
+ Do not emit warnings from the parser and/or validator. +
--noblanks
+ Drop ignorable blank spaces. +
--format
+ Reformat and reindent the output. The $XMLLINT_INDENT + environment variable controls the indentation (default + value is two spaces " "). +
--testIO
+ Test user input/output support. +
--encode encoding
+ Output in the given encoding. +
--catalogs
+ Use the catalogs from $SGML_CATALOG_FILES. Otherwise /etc/xml/catalog + is used by default. +
--nocatalogs
+ Do not use any catalogs. +
--auto
+ Generate a small document for testing purposes. +
--xinclude
+ Do XInclude processing. +
--loaddtd
+ Fetch external DTD. +
--dtdattr
+ Fetch external DTD and populate the tree with inherited attributes. +
--dropdtd
+ Remove DTD from output. +
--stream
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.
--chkregister
Turn on node registration. Useful for developeres testing + libxml2 node tracking code.
--relaxng schema
Use RelaxNG file named schema for + validation.
--schema schema
Use a W3C XML Schema file named schema for validation.
+ --nonet
Do not use the Internet to fetch DTD's or entities.

Shell

+ xmllint offers an interactive shell mode + invoked with the --shell command. Available commands in + shell mode include: +

base
+ display XML base of the node +
bye
+ leave shell +
cat node
+ Display node if given or current node. +
cd path
+ Change the current node to path (if given + and unique) or root if no argument given. +
dir path
+ Dumps information about the node (namespace, attributes, content). +
du path
+ Show the structure of the subtree under path or the current node. +
exit
+ Leave the shell. +
help
+ Show this help. +
free
+ Display memory usage. +
load name
+ Load a new document with the given name. +
ls path
+ List contents of path (if given) or the + current directory. +
pwd
+ Display the path to the current node. +
quit
+ Leave the shell. +
save name
+ Saves the current document to name if + given or to the original name. +
validate
+ Check the document for error. +
write name
+ Write the current node to the given filename. +

Debugging Catalogs

Setting the environment variable XML_DEBUG_CATALOG + using the command "export XML_DEBUG_CATALOG=" + outputs debugging information related to catalog operations.