xmlcatalog(1)

1XMLCATALOG(1)                  xmlcatalog Manual                 XMLCATALOG(1)
2
3
4

NAME

6       xmlcatalog - Command line tool to parse and manipulate XML or SGML
7       catalog files.
8

SYNOPSIS

10       xmlcatalog [--sgml | --shell | --create | --del VALUE(S) |
11                  [ --add TYPE ORIG REPLACE  | --add FILENAME] | --noout |
12                  --no-super-update | [-v | --verbose]] {CATALOGFILE}
13                  {ENTITIES...}
14

DESCRIPTION

16       xmlcatalog is a command line application allowing users to monitor and
17       manipulate XML and SGML catalogs. It is included in libxml(3).
18
19       Its functions can be invoked from a single command from the command
20       line, or it can perform multiple functions in interactive mode. It can
21       operate on both XML and SGML files.
22

OPTIONS

24       xmlcatalog accepts the following options (in alphabetical order):
25
26       --add TYPE ORIG REPLACE
27           Add an entry to CATALOGFILE.  TYPE indicates the type of entry.
28           Possible types are: public, system, uri, rewriteSystem, rewriteURI,
29           delegatePublic, delegateSystem, delegateURI, nextCatalog.  ORIG is
30           the original reference to be replaced, and REPLACE is the URI of
31           the replacement entity to be used. The --add option will not
32           overwrite CATALOGFILE, outputting to stdout, unless --noout is
33           used. The --add will always take three parameters even if some of
34           the XML catalog constructs will have only a single argument.
35
36       --add FILENAME
37           If the --add option is used following the --sgml option, only a
38           single argument, a FILENAME, is used. This is used to add the name
39           of a catalog file to an SGML supercatalog, a file that contains
40           references to other included SGML catalog files.
41
42       --create
43           Create a new XML catalog. Outputs to stdout, ignoring filename
44           unless --noout is used, in which case it creates a new catalog file
45           filename.
46
47       --del VALUE(S)
48           Remove entries from CATALOGFILE matching VALUE(S). The --del option
49           will not overwrite CATALOGFILE, outputting to stdout, unless
50           --noout is used.
51
52       --noout
53           Save output to the named file rather than outputting to stdout.
54
55       --no-super-update
56           Do not update the SGML super catalog.
57
58       --shell
59           Run a shell allowing interactive queries on catalog file
60           CATALOGFILE. For the set of available commands see the section
61           called “SHELL COMMANDS”.
62
63       --sgml
64           Uses SGML super catalogs for --add and --del options.
65
66       -v, --verbose
67           Output debugging information.
68

SHELL COMMANDS

70       Invoking xmlcatalog with the --shell CATALOGFILE option opens a command
71       line shell allowing interactive access to the catalog file identified
72       by CATALOGFILE. Invoking the shell provides a command line prompt after
73       which the following commands (described in alphabetical order) can be
74       entered.
75
76       add TYPE ORIG REPLACE
77           Add an entry to the catalog file.  TYPE indicates the type of
78           entry. Possible types are: public, system, uri, rewriteSystem,
79           rewriteURI, delegatePublic, delegateSystem, delegateURI,
80           nextCatalog.  ORIG is the original reference to be replaced, and
81           REPLACE is the URI of the replacement entity to be used. The --add
82           option will not overwrite CATALOGFILE, outputting to stdout, unless
83           --noout is used. The --add will always take three parameters even
84           if some of the XML catalog constructs will have only a single
85           argument.
86
87       debug
88           Print debugging statements showing the steps xmlcatalog is
89           executing.
90
91       del VALUE(S)
92           Remove the catalog entry corresponding to VALUE(S).
93
94       dump
95           Print the current catalog.
96
97       exit
98           Quit the shell.
99
100       public PUBLIC-ID
101           Execute a Formal Public Identifier look-up of the catalog entry for
102           PUBLIC-ID. The corresponding entry will be output to the command
103           line.
104
105       quiet
106           Stop printing debugging statements.
107
108       system SYSTEM-ID
109           Execute a Formal Public Identifier look-up of the catalog entry for
110           SYSTEM-ID. The corresponding entry will be output to the command
111           line.
112

ENVIRONMENT

114       XML_CATALOG_FILES
115           XML catalog behavior can be changed by redirecting queries to the
116           user's own set of catalogs. This can be done by setting the
117           XML_CATALOG_FILES environment variable to a list of catalogs. An
118           empty one should deactivate loading the default /etc/xml/catalog
119           catalog.
120

DIAGNOSTICS

122       xmlcatalog return codes provide information that can be used when
123       calling it from scripts.
124
125       0
126           No error
127
128       1
129           Failed to remove an entry from the catalog
130
131       2
132           Failed to save to the catalog, check file permissions
133
134       3
135           Failed to add an entry to the catalog
136
137       4
138           Failed to look up an entry in the catalog
139

AUTHOR

158       John Fleck <jfleck@inkstain.net>
159           Author.
160

COPYRIGHT

162       Copyright © 2001, 2004
163
164
165
166libxml2                             $Date$                       XMLCATALOG(1)