xmlcatalog(1)          xmlcatalog Manual          xmlcatalog(1)




NAME
       xmlcatalog  -  Command line tool to parse and manipulate
       XML or
             SGML catalog files.

SYNOPSIS
       xmlcatalog [--shell  |  --create  |  --add   type
       orig    replace  | --del  values  | --noout | --verbose]
       [catalogfile] [entities]

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
       --shell filename

              Run a shell allowing interactive queries on cata-
              log file filename.


       --create filename

              Create a new  XML  catalog.  Outputs  to  stdout,
              ignoring  filename  unless  --noout  is  used, in
              which case it creates a new  catalog  file  file-
              name.


       --add 'type' 'orig' 'replace' filename

              Add an entry to catalog file filename. type indi-
              cates the type of entry. Possible types are 'pub-
              lic', 'system', 'rewriteSystem', 'delegatePublic'
              and 'delegateSystem'. 'orig' is the original ref-
              erence  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  con-
              tains  references  to other included SGML catalog
              files.


       --del 'values' filename

              Remove entries from  the  catalog  file  filename
              matching  'values'.  The  --del  option  will not
              overwrite filename, outputing to  stdout,  unless
              --noout is used.


       --noout

              Save output to the named file rather than output-
              ing to stdout.


       -v or --verbose

              output debugging information.


SHELL COMMANDS
       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 com-
       mands can be entered.


       public 'PublicID'

              Execute a public identifier lookup of the catalog
              entry  for  'PublicID'.  The  corresponding entry
              will be output to the command line.


       system 'SystemID'

              Execute a public identifier lookup of the catalog
              entry  for  'SystemID'.  The  corresponding entry
              will be output to the command line.


       add  'type' 'orig' 'replace'

              Add an entry to the catalog file. type  indicates
              the  type  of entry. Possible types are 'public',
              'system', 'rewriteSystem',  'delegatePublic'  and
              'delegateSystem'.  'orig'  is the original refer-
              ence to be replaced, and 'replace' is the URI  of
              the replacement entity to be used.


       del 'values'

              Remove  the  catalog entry corresponding to 'val-
              ues'.


       dump    Print the current catalog.


       debug   Print debugging  statements  showing  the  steps
              xmlcatalog is executing.


       quiet   Stop printing debugging statements.


       exit    Quit the shell.


REFERENCES
       libxml web page:

              http://www.xmlsoft.org/: http://www.xmlsoft.org/


       libxml catalog support web page:

              http://www.xmlsoft.org/catalog.html:
              http://www.xmlsoft.org/catalog.html


       James Clark's SGML catalog page:

              http://www.jclark.com/sp/catalog.htm:
              http://www.jclark.com/sp/catalog.htm


       OASIS XML catalog specification:

              http://www.oasis-open.org/commit-
              tees/entity/spec.html:          http://www.oasis-
              open.org/committees/entity/spec.html


AUTHOR
       Copyright 2001

       John Fleck  <jfleck@inkstain.net>

       Permission  is granted to copy, distribute and/or modify
       this document under the terms of the GNU Free Documenta-
       tion License, Version 1.1 or any later version published
       by the Free Software Foundation with no  Invariant  Sec-
       tions, no Front-Cover Texts, and no Back-Cover Texts.


       Many of the names used by companies to distinguish their
       products and services are claimed as  trademarks.  Where
       those names appear in any GNOME documentation, and those
       trademarks are made aware to the members  of  the  GNOME
       Documentation  Project,  the  names have been printed in
       caps or initial caps.  This is release 0.1 of  the  xml-
       catalog Manual.



                                                  xmlcatalog(1)
