XMLCATMGR                                                            README
===========================================================================


1 Introduction
--------------

xmlcatmgr is a utility used to manipulate SGML and XML catalogs.  It is
designed with simplicity in mind: it does not depend on external programs
nor libraries.


2 License
---------

See the COPYING file included in the distribution file for more
information about the BSD license.


3 Building
----------

The build process is quite straightforward.  It is described in this
section.  Read it carefully as this may be a bit different from what
you are used to.

1) Configure the sources.

   The `configure.sh' script is used to automatically configure the source
   tree to build on your system, based on several checks to detect system
   features.  It will also generate a Makefile, used during the build
   stage.

   The most common way to launch this script is:

       $ ./configure.sh

   This will assume several defaults, specially a /usr/local installation
   prefix.  All files will be placed under it.  If the default prefix is
   not what you want, the `-p' option can be used to change it, like in:

       $ ./configure.sh -p ~/opt

   Other parameters you will likely want to change are default catalog
   files; their default values are based on the prefix, and are:
   PREFIX/etc/xml/catalog and PREFIX/etc/sgml/catalog.  To change them,
   use the `-c' and `-C' options, like in:

       $ ./configure.sh -c /etc/xml/catalog -C /etc/sgml/catalog

   Several other options are recognized by the script, but are rarely
   used.  The `-h' option will show you a help message, which includes a
   list of them.

   Note that the source tree is not touched at all during compilation.
   A work directory is used instead, which defaults to `work', and can
   be adjusted with the `-w' option.  If you want to change it, be sure
   you specify a directory that does not exist yet.

2) Building the sources.

   After a successful configuration, you can build the sources.  This is
   done with the `make.sh' script.  To build the program, simply execute:

       $ ./make.sh

   Alternatively you can enter the work directory manually and execute
   the regular make(1) utility there.

3) Installing the results.

   Just like the build, the program is installed using the `make.sh'
   script.  Only do this after a successful build.  This is the only
   stage which may require root privileges, depending on the installation
   directories you selected during configuration.  To install, issue:

       $ ./make.sh install

   Note that staged installs are supported by setting the DESTDIR variable
   before running the installation command.

   Alternatively you can enter the work directory manually and execute
   the regular make(1) utility there to build the `install' target.


4 More information
------------------

For more information, read the xmlcatmgr(1) manpage after installing
the program.

For a list of authors, read the PEOPLE file.

For a list of changes, read the CHANGES file.


5 Feedback
----------

Comments, criticisms, oppinions, suggestions... everything should be
directed to: Julio M. Merino Vidal <jmmv@users.sourceforge.net>.

Thanks for using this program.


===========================================================================
$Id: README,v 1.11 2004/01/21 22:18:34 jmmv Exp $
