Index: doc/xmlcatalog_man.xml =================================================================== RCS file: /cvs/gnome/libxml2/doc/xmlcatalog_man.xml,v retrieving revision 1.11 diff -u -r1.11 xmlcatalog_man.xml --- doc/xmlcatalog_man.xml 24 Jun 2004 02:21:27 -0000 1.11 +++ doc/xmlcatalog_man.xml 5 Apr 2006 22:56:28 -0000 @@ -1,299 +1,434 @@ + href="http://docbook.sourceforge.net/snapshots/xsl/manpages/docbook.xsl"?> xmlcatalog"> ]> + - - xmlcatalog Manual - - 2001 - - - 2004 - - - John - Fleck - -
jfleck inkstain net
- - This is release 0.3 of the xmlcatalog Manual. - - - - xmlcatalog - 1 - - - xmlcatalog - Command line tool to parse and manipulate XML or - SGML catalog files. - - - - - xmlcatalog - - --shell - --create - --add type - orig replace - --del values - --noout - --verbose - - - - - - - - Introduction - - 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. - - - - - Command Line Options - - - filename - - - Run a shell - allowing interactive queries on catalog file - filename. - - - - - filename - - - Create a new - XML catalog. Outputs to stdout, ignoring - filename unless is - used, in which case it creates a new catalog file - filename. - - - - - - 'type' 'orig' 'replace' filename - - - Add an entry to catalog file - filename. type - indicates the type of entry. Possible types are 'public', 'system', - 'rewriteSystem', 'rewriteURI', 'delegatePublic', 'delegateSystem', - and 'nextCatalog'. 'orig' is the original - reference to be replaced, and 'replace' - is the URI of the replacement entity to be - used. The option will not overwrite - filename, outputting to stdout, unless - is used. The will - always take three parameters even if some of the - XML catalog constructs will have only a single - argument. - - - - If the option is used following the - 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. - - - - - 'values' filename - - - Remove entries from the catalog file - filename matching - 'values'. The option - will not overwrite filename, outputting to - stdout, unless is used. - - - - + + + xmlcatalog Manual + libxml2 + + 2001 + 2004 + + + John + Fleck + +
+ jfleck inkstain net +
+ + + + 2006-03-05 + + + + + + + xmlcatalog + 1 + + + + xmlcatalog + + Command line tool to parse and manipulate XML + or SGML catalog files. + + + + + + xmlcatalog + + + + + + + + + + + + + + + + + + + + + + + CATALOGFILE + ENTITIES + + + + + DESCRIPTION + + &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. + + More information can be found at + + + + libxml + 3 + web page + + + + + libxml + 3 + catalog support web page + at + + + + James Clark's SGML catalog + page + + + + OASIS XML catalog specification + + + + + + + + + OPTIONS + + &xmlcatalog; accepts the following options (in alphabetical order): + + + + + + + + + + + Add an entry to CATALOGFILE. TYPE + indicates the type of entry. Possible types are: + public + system + rewriteSystem + rewriteURI + delegatePublic + delegateSystem + nextCatalog + . ORIG is the original + reference to be replaced, and REPLACE + is the URI of the replacement entity to be + used. The option will not overwrite + CATALOGFILE, outputting + to stdout, unless + is used. The will + always take three parameters even if some of the XML + catalog constructs will have only a single argument. + + + + + + + + + + If the option is used following + the 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 a new XML catalog. Outputs + to stdout, + ignoring filename unless is + used, in which case it creates a new catalog + file filename. + + + + + + + + + Remove entries from CATALOGFILE + matching VALUE(S). The + option will not overwrite CATALOGFILE, + outputting to stdout, + unless is used. + + + + + - - Save output to the named file rather than - outputting to stdout. - - - - + + Save output to the named file rather than outputting + to stdout. + + + + + + + + + Do not update the SGML super catalog. + + + + + + + + + Run a shell allowing interactive queries on catalog + file CATALOGFILE. + + + + + - - Uses SGML Super catalogs for --add and --del options - - - - - or - - - output debugging - information. - - - - - - - - Shell Commands - Invoking xmlcatalog with the - 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. - - - - - 'PublicID' - - - Execute a - public identifier lookup of the catalog entry for - 'PublicID'. The corresponding entry will be - output to the command line. - - - - - - 'SystemID' - - - Execute a - public identifier lookup of the catalog entry for - 'SystemID'. The corresponding entry will be - output to the command line. - - - - - 'type' 'orig' 'replace' - - - Add an entry to the catalog - file. type indicates the type of - entry. Possible types are 'public', 'system', 'rewriteSystem', - 'rewriteURI', 'delegatePublic', 'delegateSystem', and - 'nextCatalog'. 'orig' - is the original reference to be replaced, and - 'replace' is the URI of the - replacement entity to be used. - - - - - 'values' - - - Remove the - catalog entry corresponding to 'values'. - + + Uses SGML super catalogs for + and options. + + + + + + + + + Output debugging information. + + + + + + + + SHELL COMMANDS + + Invoking &xmlcatalog; with + the option opens + a command line shell allowing interactive access to the catalog file + identified by CATALOGFILE. Invoking the shell + provides a command line prompt after which the following commands (described in + alphabetical order) can be entered. + + + + + + + + + + + Add an entry to the catalog file. TYPE + indicates the type of entry. Possible types are: + public + system + rewriteSystem + rewriteURI + delegatePublic + delegateSystem + nextCatalog + . ORIG is the original + reference to be replaced, and REPLACE + is the URI of the replacement entity to be + used. The option will not overwrite + CATALOGFILE, outputting + to stdout, unless + is used. The will + always take three parameters even if some of the XML + catalog constructs will have only a single argument. + - + - - + + - - Print the current catalog. - + + Print debugging statements showing the steps &xmlcatalog; is executing. + - + - - + + - - Print debugging statements showing the steps - xmlcatalog is executing. - - - - - - + + Remove the catalog entry corresponding to VALUE(S). + + + + + + - - Stop printing debugging statements. - - - - - + Print the current catalog. + + + + - - Quit the shell. - - - - - - - - - Return values - 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 - - - Catalogs - 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. - - - References - libxml web page - - libxml - catalog support web page - - James Clark's - SGML catalog page - - OASIS - XML catalog specification + Quit the shell. + + + + + + + + Execute a public identifier lookup of the catalog entry + for PUBLIC-ID. The corresponding entry will be + output to the command line. + + + + + + + + Stop printing debugging statements. + + + + + + + + Execute a public identifier lookup of the catalog entry + for SYSTEM-ID. The corresponding entry will be + output to the command line. + + + + + + + + + ENVIRONMENT + + + + XML_CATALOG_FILES + + + 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. + + + + + + + + + DIAGNOSTICS + + &xmlcatalog;'s return codes provide information that can be used when + calling it from scripts. + + + + + Errorcode + Error + + 0 + No error + + + 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 + + + + SEE ALSO + + + libxml + 3 + + +