xmlcatalog(1)

1XMLCATALOG(1)                                                    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, rewriteSystem, rewriteURI,
29              delegatePublic, delegateSystem, nextCatalog.  ORIG is the
30              original reference to be replaced, and REPLACE is the URI of the
31              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
34              of 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
39              name of a catalog file to an SGML supercatalog, a file that
40              contains 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
45              file filename.
46
47       --del VALUE(S)
48              Remove entries from CATALOGFILE matching VALUE(S). The --del
49              option will not overwrite CATALOGFILE, outputting to stdout,
50              unless --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 Uses SGML super catalogs for --add and --del options.
64
65       -v, --verbose
66              Output debugging information.
67

SHELL COMMANDS

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

ENVIRONMENT

108       XML_CATALOG_FILES
109              XML catalog behavior can be changed by redirecting queries to
110              the user's own set of catalogs. This can be done by setting the
111              XML_CATALOG_FILES environment variable to a list of catalogs. An
112              empty one should deactivate loading the default /etc/xml/catalog
113              catalog.
114

DIAGNOSTICS

116       xmlcatalog return codes provide information that can be used when
117       calling it from scripts.
118
119       0      No error
120
121       1      Failed to remove an entry from the catalog
122
123       2      Failed to save to the catalog, check file permissions
124
125       3      Failed to add an entry to the catalog
126
127       4      Failed to look up an entry in the catalog
128

AUTHOR

145       John Fleck <jfleck@inkstain.net>.
146
147
148
149libxml2                             $Date$                       XMLCATALOG(1)