---------------------------------------------------------------------------

                                  INSTALL

---------------------------------------------------------------------------

  1) Download and install Phil Hazel's PCRE-library:

       http://www.pcre.org

     Your OS-distribution may already have a pre-compiled package, too.

     If the library is installed in a non-standard place, you may need
     to set the paths to the include file "pcre.h" and to the static or
     shared libraries in Makefile.conf (variables INCDIRS and LIBDIRS).

  2) If there is anything non-standard about your OCaml-installation,
     look at the default settings in "OCamlMakefile" and set them to
     the values that are valid on your system, you can do this also by
     setting environment variables. This is greatly simplified if you
     normally use "OCamlMakefile" and have already configured your shell
     environment in startup files appropriately.

     It normally suffices to set the following variables:

       OCAMLLIBPATH  -  default is where your OCaml-installation resides
                        (e.g. "/usr/local/lib/ocaml")

     and

       OCAML_LIB_INSTALL  -  default is "$(OCAMLLIBPATH)/contrib"

     where you want this library to be installed.

     On some platforms (e.g. Solaris) it may be necessary to use gcc as
     C-compiler instead of the vendor one, i.e. "CC=gcc".

     If you want to compile the byte-code library without the
     "-custom"-switch, you will have to supply "NO_CUSTOM=y" to "make".

  3) Don't forget: you will need GNU-make!

     Enter "make" in the top directory to compile the library to
     byte-code.

     By default, the library will be compiled to support dynamic
     linking. This may not necessarily work on all platforms. In case
     you encounter problems in the following steps, you may uncomment
     the corresponding line in Makefile.conf or pass "STATIC=1" to "make"
     on the command line. This will only build and install a statically
     linkable library.

     If you want to compile to native-code (too or separately), enter
     "make opt" before "make install".

  4) Enter "make install" to install the library, be it byte-code,
     native-code or both depending on what target(s) you have built in
     the preceeding step.

     If dynamic linking was allowed, make sure that the file "ld.conf"
     in your OCaml-directory (OCAMLLIBPATH) contains an entry referring
     to the installation directory of this library. Otherwise OCaml will
     not be able to find shared libraries for byte-code.

  x) If you want to compile the examples, enter "make examples".

     If dynamic linking was allowed, you may only be able to run the
     examples after installation of this library (step 4 above)!

---------------------------------------------------------------------------

                                 UNINSTALL

---------------------------------------------------------------------------

  1) Easy: just enter "make uninstall". This will remove all files
     installed by "make install".

---------------------------------------------------------------------------

Enjoy!

Vienna, 2002-07-31
Markus Mottl

email: markus@oefai.at
WWW:   http://www.oefai.at/~markus
