xmlcatalog — Command line tool to parse and manipulate XML or - SGML catalog files.
xmlcatalog [[--shell] | [--create] | [--add type - orig replace] | [--del values] | [--noout] | [--verbose]] [catalogfile] [entities]
- xmlcatalog is a command line application - allowing users to monitor and manipulate XML and - SGML catalogs. It is included in - libxml2. -
- Its functions can be invoked from a single command from the command line, - or it can perform multiple functions in interactive mode. It can operate - on both XML and SGML files. -
- Add an entry to catalog file - filename. type - indicates the type of entry. Possible types are 'public', 'system', 'uri', - 'rewriteSystem', 'rewriteURI', 'delegatePublic', 'delegateSystem', - 'delegateURI' and 'nextCatalog'. 'orig' is the original - reference to be replaced, and 'replace' - is the URI of the replacement entity to be - used. The --add option will not overwrite - filename, outputing to stdout, unless - --noout is used. The --add will - always take three parameters even if some of the - XML catalog constructs will have only a single - argument. - -
- If the --add option is used following the - --sgml option, only a single argument, a - filename, is used. This is used to add - the name of a catalog file to an SGML - supercatalog, a file that contains references to other included - SGML catalog files. -
Invoking xmlcatalog with the - --shell filename option opens - a command line shell allowing interactive access to the catalog file - identified by filename. Invoking the shell - provides a command line prompt after which commands can be entered. -
xmlcatalog's return codes provide - information that can be used when calling it from scripts.
0: normal
1: Failed to remove an entry from the catalog
2: Failed to save to the catalog, check file permissions
3: Failed to add an entry to the catalog
4: Failed to lookup and entry in the catalog
Catalog behavior can be changed by redirecting - queries to the user's own set of catalogs. This can be done by setting the - XML_CATALOG_FILES environment variable to a list of - catalogs. An empty one should deactivate loading the default - /etc/xml/catalog default catalog.
xmlcatalog — + Command line tool to parse and manipulate XML + or SGML catalog files. +
xmlcatalog [ --sgml | --shell | --create | --del |
+ [
+ VALUE(S)--add
+
+ | TYPE
+ ORIG
+ REPLACE
+ --add ]
+ | FILENAME--noout | --no-super-update |
+ [ -v | --verbose ]
+ ] {CATALOGFILE} {ENTITIES...}
+ xmlcatalog is a command line application allowing users to monitor and + manipulate XML and SGML catalogs. It + is included in libxml(3). +
+ Its functions can be invoked from a single command from the command line, + or it can perform multiple functions in interactive mode. It can operate + on both XML and SGML files. +
+ xmlcatalog accepts the following options (in alphabetical order): +
--add
+ TYPE
+ ORIG
+ REPLACE
+
+
+ Add an entry to CATALOGFILE. TYPE
+ indicates the type of entry. Possible types are: public, system, uri, rewriteSystem, rewriteURI, delegatePublic, delegateSystem, delegateURI, nextCatalog. ORIG is the original
+ reference to be replaced, and REPLACE
+ is the URI of the replacement entity to be
+ used. The --add option will not overwrite
+ CATALOGFILE, outputting
+ to stdout, unless
+ --noout is used. The --add will
+ always take three parameters even if some of the XML
+ catalog constructs will have only a single argument.
+
--add FILENAME
+ If the --add option is used following
+ the --sgml option, only a single argument,
+ a FILENAME, is used. This is used to add
+ the name of a catalog file to an SGML supercatalog,
+ a file that contains references to other included SGML
+ catalog files.
+
--create
+ Create a new XML catalog. Outputs
+ to stdout,
+ ignoring filename unless --noout is
+ used, in which case it creates a new catalog
+ file filename.
+
--del VALUE(S)
+ Remove entries from CATALOGFILE
+ matching VALUE(S). The --del
+ option will not overwrite CATALOGFILE,
+ outputting to stdout,
+ unless --noout is used.
+
--noout
+ Save output to the named file rather than outputting
+ to stdout.
+
--no-super-update+ Do not update the SGML super catalog. +
--shell
+ Run a shell allowing interactive queries on catalog
+ file CATALOGFILE. For the set of available
+ commands see the section called “SHELL COMMANDS”.
+
--sgml
+ Uses SGML super catalogs for --add
+ and --del options.
+
-v, --verboseOutput debugging information.
+ Invoking xmlcatalog non-interactively without a designated action
+ (imposed with options like --add) will result in a lookup
+ of the catalog entry for ENTITIES in the
+ catalog denoted with CATALOGFILE. The
+ corresponding entries will be output to the command line. This mode of
+ operation, together with --shell mode and non-modifying
+ (i.e. without --noout) direct actions, allows for
+ a special shortcut of the void CATALOGFILE
+ specification (possibly expressed as "" in the shell
+ environment) appointing the default system catalog. That simplifies the
+ handling when its exact location is irrelevant but the respective built-in
+ still needs to be consulted.
+
+ Invoking xmlcatalog with
+ the --shell option opens
+ a command line shell allowing interactive access to the catalog file
+ identified by CATALOGFILECATALOGFILE. Invoking the shell
+ provides a command line prompt after which the following commands (described in
+ alphabetical order) can be entered.
+
add
+ TYPE
+ ORIG
+ REPLACE
+
+
+ Add an entry to the catalog file. TYPE
+ indicates the type of entry. Possible types are: public, system, uri, rewriteSystem, rewriteURI, delegatePublic, delegateSystem, delegateURI, nextCatalog. ORIG is the original
+ reference to be replaced, and REPLACE
+ is the URI of the replacement entity to be
+ used. The --add option will not overwrite
+ CATALOGFILE, outputting
+ to stdout, unless
+ --noout is used. The --add will
+ always take three parameters even if some of the XML
+ catalog constructs will have only a single argument.
+
debug+ Print debugging statements showing the steps xmlcatalog is executing. +
del VALUE(S)
+ Remove the catalog entry corresponding to VALUE(S).
+
dumpPrint the current catalog.
exitQuit the shell.
public PUBLIC-ID
+ Execute a Formal Public Identifier lookup of the catalog entry
+ for PUBLIC-ID. The corresponding entry will be
+ output to the command line.
+
quietStop printing debugging statements.
system SYSTEM-ID
+ Execute a Formal Public Identifier lookup of the catalog entry
+ for SYSTEM-ID. The corresponding entry will be
+ output to the command line.
+
XML_CATALOG_FILESXML catalog behavior can be changed by redirecting
+ queries to the user's own set of catalogs. This can be done by setting
+ the XML_CATALOG_FILES environment variable to a list
+ of catalogs. An empty one should deactivate loading the
+ default /etc/xml/catalog catalog.
+
+ xmlcatalog return codes provide information that can be used when + calling it from scripts. +
No error
Failed to remove an entry from the catalog
Failed to save to the catalog, check file permissions
Failed to add an entry to the catalog
Failed to look up an entry in the catalog
libxml(3) +
+ More information can be found at +
libxml(3) web page http://www.xmlsoft.org/ +
libxml(3) catalog support web page + at http://www.xmlsoft.org/catalog.html +
James Clark's SGML catalog + page http://www.jclark.com/sp/catalog.htm +
OASIS XML catalog specification + http://www.oasis-open.org/committees/entity/spec.html +
+
xmllint — command line XML tool
xmllint [[--version] | [--debug] | [--shell] | [--debugent] | [--copy] | [--recover] | [--noent] | [--noout] | [--nonet] | [--htmlout] | [--nowrap] | [--valid] | [--postvalid] | [--dtdvalid URL] | [--dtdvalidfpi FPI] | [--timing] | [--output file] | [--repeat] | [--insert] | [--compress] | [--html] | [--xmlout] | [--push] | [--memory] | [--maxmem nbbytes] | [--nowarning] | [--noblanks] | [--nocdata] | [--format] | [--encode encoding] | [--dropdtd] | [--nsclean] | [--testIO] | [--catalogs] | [--nocatalogs] | [--auto] | [--xinclude] | [--noxincludenode] | [--loaddtd] | [--dtdattr] | [--stream] | [--walker] | [--pattern patternvalue] | [--chkregister] | [--relaxng] | [--schema] | [--c14n]] [xmlfile]
- 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. -
- xmllint offers an interactive shell mode - invoked with the --shell command. Available commands in - shell mode include: -
Catalog behavior can be changed by redirecting - queries to the user's own set of catalogs. This can be done by setting the - XML_CATALOG_FILES environment variable to a list of - catalogs. An empty one should deactivate loading the default - /etc/xml/catalog default catalog.
Setting the environment variable XML_DEBUG_CATALOG - using the command "export XML_DEBUG_CATALOG=" - outputs debugging information related to catalog operations.
On the completion of execution, Xmllint - returns the following error codes:
xmllint — command line XML tool
xmllint [ --version | --debug | --shell | --xpath " | XPath_expression"--debugent | --copy | --recover | --noent | --noout | --nonet | --path " | PATH(S)"--load-trace | --htmlout | --nowrap | --valid | --postvalid | --dtdvalid | URL--dtdvalidfpi | FPI--timing | --output | FILE--repeat | --insert | --compress | --html | --xmlout | --push | --memory | --maxmem | NBBYTES--nowarning | --noblanks | --nocdata | --format | --encode | ENCODING--dropdtd | --nsclean | --testIO | --catalogs | --nocatalogs | --auto | --xinclude | --noxincludenode | --loaddtd | --dtdattr | --stream | --walker | --pattern | PATTERNVALUE--chkregister | --relaxng | SCHEMA--schema | SCHEMA--c14n ] { XML-FILE(S)... | - }
xmllint --help
+ The xmllint program parses one or more XML files,
+ specified on the command line as XML-FILE
+ (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.
+
xmllint is included in libxml(3).
+ xmllint accepts the following options (in alphabetical order): +
--autoGenerate a small document for testing purposes.
--catalogs
+ Use the SGML catalog(s) from SGML_CATALOG_FILES.
+ Otherwise XML catalogs starting
+ from /etc/xml/catalog are used by default.
+
--chkregister+ Turn on node registration. Useful for developers testing libxml(3) node tracking code. +
--compress+ Turn on gzip(1) compression of output. +
--copyTest the internal copy implementation.
--c14n
+ Use the W3C XML Canonicalisation (C14N) to
+ serialize the result of parsing to stdout.
+ It keeps comments in the result.
+
--dtdvalid URL
+ Use the DTD specified by
+ an URL for validation.
+
--dtdvalidfpi FPI
+ Use the DTD specified by a Formal Public
+ Identifier FPI for validation, note that this
+ will require a catalog exporting that Formal Public Identifier to work.
+
--debug+ Parse a file and output an annotated tree of the + in-memory version of the document. +
--debugentDebug the entities defined in the document.
--dropdtdRemove DTD from output.
--dtdattr+ Fetch external DTD and populate the tree with + inherited attributes. +
--encode ENCODINGOutput in the given encoding. Note that this works for full document not fragments or result from XPath queries.
--format
+ Reformat and reindent the output. The XMLLINT_INDENT
+ environment variable controls the indentation. The default value is two
+ spaces " ").
+
--helpPrint out a short usage summary for xmllint.
--htmlUse the HTML parser.
--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/viewed in a browser. +
--insertTest for valid insertions.
--loaddtdFetch an external DTD.
--load-trace
+ Display all the documents loaded during the processing
+ to stderr.
+
--maxmem NNBYTES
+ Test the parser memory support. NNBYTES
+ 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.
+
--memoryParse from memory.
--noblanksDrop ignorable blank spaces.
--nocatalogsDo not use any catalogs.
--nocdataSubstitute CDATA section by equivalent text nodes.
--noent+ Substitute entity values for entity references. By default, xmllint + leaves entity references in place. +
--nonet+ Do not use the Internet to fetch DTDs or entities. +
--noout+ Suppress output. By default, xmllint outputs the result tree. +
--nowarningDo not emit warnings from the parser and/or validator.
--nowrapDo not output HTML doc wrapper.
--noxincludenode+ Do XInclude processing but do not generate XInclude start and end nodes. +
--nscleanRemove redundant namespace declarations.
--output FILE
+ 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.
+
--path "PATH(S)"
+ Use the (space- or colon-separated) list of filesystem paths specified
+ by PATHS to load DTDs or
+ entities. Enclose space-separated lists by quotation marks.
+
--pattern PATTERNVALUE+ 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. +
--postvalidValidate after parsing has completed.
--pushUse the push mode of the parser.
--recoverOutput any parsable portions of an invalid document.
--relaxng SCHEMA
+ Use RelaxNG file named SCHEMA
+ for validation.
+
--repeatRepeat 100 times, for timing or profiling.
--schema SCHEMA
+ Use a W3C XML Schema file
+ named SCHEMA for validation.
+
--shell+ Run a navigating shell. Details on available commands in shell mode + are below (see the section called “SHELL COMMANDS”). +
--xpath "XPath_expression"+ Run an XPath expression given as argument and print the + result. In case of a nodeset result, each node in the + node set is serialized in full in the output. In case + of an empty node set the "XPath set is empty" result + will be shown and an error exit code will be returned. +
--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.
+
--testIOTest user input/output support.
--timing+ Output information about the time it takes xmllint to perform the + various steps. +
--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.
+
--version+ Display the version of libxml(3) used. +
--walker+ 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 an existing in-memory tree. Used for + debugging. +
--xincludeDo XInclude processing.
--xmlout
+ Used in conjunction with --html. 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.
+
+ xmllint offers an interactive shell mode invoked with
+ the --shell command. Available commands in shell mode
+ include (in alphabetical order):
+
Display XML base of the node.
Leave the shell.
NODEDisplay the given node or the current one.
PATH+ Change the current node to the given path (if unique) or root if no + argument is given. +
PATH+ Dumps information about the node (namespace, attributes, content). +
PATH+ Show the structure of the subtree under the given path or the current node. +
Leave the shell.
Show this help.
Display memory usage.
FILENAMELoad a new document with the given filename.
PATHList contents of the given path or the current directory.
Display the path to the current node.
Leave the shell.
FILENAME+ Save the current document to the given filename or to the original name. +
validateCheck the document for errors.
FILENAMEWrite the current node to the given filename.
SGML_CATALOG_FILESSGML catalog behavior can be changed by redirecting
+ queries to the user's own set of catalogs. This can be done by setting
+ the SGML_CATALOG_FILES environment variable to a list
+ of catalogs. An empty one should deactivate loading the
+ default /etc/sgml/catalog catalog.
+
XML_CATALOG_FILESXML catalog behavior can be changed by redirecting
+ queries to the user's own set of catalogs. This can be done by setting
+ the XML_CATALOG_FILES environment variable to a list
+ of catalogs. An empty one should deactivate loading the
+ default /etc/xml/catalog catalog.
+
XML_DEBUG_CATALOGSetting the environment variable XML_DEBUG_CATALOG
+ to non-zero using the export
+ command outputs debugging information related to catalog operations.
+
XMLLINT_INDENTSetting the environment variable XMLLINT_INDENT
+ controls the indentation. The default value is two spaces " ".
+
+ xmllint return codes provide information that can be used when + calling it from scripts. +
No error
Unclassified
Error in DTD
Validation error
Validation error
Error in schema compilation
Error writing output
+ Error in pattern (generated when --pattern option is used)
+
+ Error in Reader registration (generated
+ when --chkregister option is used)
+
Out of memory error
libxml(3) +
+ More information can be found at +
libxml(3) web page http://www.xmlsoft.org/ +
W3C XSLT page http://www.w3.org/TR/xslt +
+