UPDATE-CATALOG(8) Debian UPDATE-CATALOG(8)NAME
update-catalog - create or update entry in SGML catalog file
SYNOPSIS
update-catalog [options] --add centralized_catalog ordinary_catalog
update-catalog [options] --remove centralized_catalog ordinary_catalog
update-catalog [options] --update-super
DESCRIPTION
update-catalog inserts, updates or removes entries in the SGML centralized catalogs located in /etc/sgml. To change the SGML super catalog
located in /etc/sgml/catalog modify the directory contents of /etc/sgml to contain new files or symbolic links having a .cat extension or
remove (or move) existing centralized catalogs and regenerate the super catalog using the --update-super option. See section SUPER CATALOG
for details on the generation process.
OPTIONS --add Adds an entry for the ordinary_catalog in the centralized_catalog.
--remove
Removes the entry for the ordinary_catalog from the centralized_catalog.
--update-super
Regenerates the SGML super catalog from the contents of the /etc/sgml directory. See section SUPER CATALOG for details on the super
catalog generation.
--quiet
Prevents the usual diagnostic output.
--test Prevents the update of the catalog and writes the resulting SGML catalog to standard output.
--version
Displays the version information and exits.
--help Display the usage information and exits.
SUPER CATALOG
The super-catalog located in /etc/sgml/catalog cannot be directly modified. It is generated by the update-catalog --update-super command.
The generation considers files in the /etc/sgml directory that have a .cat extension. For instance files ending in .old or .disabled are
not considered. Before adding a catalog to the super catalog it is parsed and verified in order to not corrupt the super catalog. All
referenced catalogs are verified to actually exist. If the check fails, a message is printed and the complete catalog is ignored. This
check ensures that a catalog from a package, which is removed but not purged, is removed from the super catalog.
AUTHOR
Ardo van Rangelrooij <ardo@debian.org>
COPYRIGHT
Copyright (C) 2001-2004 Ardo van Rangelrooij Copyright (C) 2012 Helmut Grohne
This is free software; see the GNU General Public Licence version 2 or later for copying conditions. There is no warranty.
Debian Project June 2004 UPDATE-CATALOG(8)
Check Out this Related Man Page
XMLCATALOG(1) xmlcatalog Manual XMLCATALOG(1)NAME
xmlcatalog - Command line tool to parse and manipulate XML or SGML catalog files.
SYNOPSIS
xmlcatalog [--sgml | --shell | --create | --del VALUE(S) | [ --add TYPE ORIG REPLACE | --add FILENAME] | --noout | --no-super-update |
[-v | --verbose]] {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.
OPTIONS
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, --verbose
Output debugging information.
SHELL COMMANDS
Invoking xmlcatalog with the --shell CATALOGFILE 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 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).
dump
Print the current catalog.
exit
Quit the shell.
public PUBLIC-ID
Execute a Formal Public Identifier look-up of the catalog entry for PUBLIC-ID. The corresponding entry will be output to the command
line.
quiet
Stop printing debugging statements.
system SYSTEM-ID
Execute a Formal Public Identifier look-up of the catalog entry for SYSTEM-ID. The corresponding entry will be output to the command
line.
ENVIRONMENT
XML_CATALOG_FILES
XML 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.
DIAGNOSTICS
xmlcatalog return codes provide information that can be used when calling it from scripts.
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 look up an entry in the catalog
SEE ALSO libxml(3)
More information can be found at
o libxml(3) web page http://www.xmlsoft.org/
o libxml(3) catalog support web page at http://www.xmlsoft.org/catalog.html
o James Clark's SGML catalog page http://www.jclark.com/sp/catalog.htm
o OASIS XML catalog specification http://www.oasis-open.org/committees/entity/spec.html
AUTHOR
John Fleck <jfleck@inkstain.net>
Author.
COPYRIGHT
Copyright (C) 2001, 2004
libxml2 $Date$ XMLCATALOG(1)