******************************************************************************
INSTALL - Shell
******************************************************************************


==============================================================================
The "Shell" package
==============================================================================

------------------------------------------------------------------------------
Prerequisites
------------------------------------------------------------------------------

Shell does not need any other packages besides the O'Caml core. Shell needs at 
least O'Caml 3.00. The installation procedure defined in the Makefile requires 
findlib [1] to work [2]. 

Shell works only in true POSIX environments.

------------------------------------------------------------------------------
Configuration
------------------------------------------------------------------------------

It is not necessary to configure "Shell". 

------------------------------------------------------------------------------
Compilation
------------------------------------------------------------------------------

The Makefile defines the following goals: 

-  make all
   compiles with the bytecode compiler and creates shell.cma, and libshell.a.
   
-  make opt
   compiles with the native compiler and creates shell.cmxa, and libshell.a.
   
-  make
   creates the bytecode library, and only if possible, the native library, too.
   
------------------------------------------------------------------------------
Installation
------------------------------------------------------------------------------

The Makefile defines the following goals:

-  make findlib-install
   installs the bytecode archive, the interface definitions, and if present, 
   the native archive in the default location of findlib 
   
-  make conventional-install
   installs the bytecode archive, the interface definitions, and if present, 
   the native archive into the directory configured by the INSTALLDIR variable 
   of the Makefile 
   
-  make findlib-uninstall
   removes the package
   
-  make conventional-uninstall
   removes the files installed by conventional-install
   
------------------------------------------------------------------------------
Linking Shell with findlib
------------------------------------------------------------------------------

The command 

ocamlfind ocamlc ... -package shell ... -linkpkg ...

links the shell library into your program.


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

[1]   see http://www.ocaml-programming.de/packages/documentation/findlib/

[2]   Findlib is a package manager, see the file ABOUT-FINDLIB.



