Very Fast Install
=================
cd open-amulet-X.Y.Z/
mkdir build
cd build
../configure --prefix=/usr/local/openamulet
make
make check
make install

OpenAmulet Specific Notes
=========================

  By default, the build system will create two versions of the OpenAmulet
library (shared libraries) named: libamulet.so, libamulet-develop.so.

The develop-ment version contains some special debugging code that
allows the developper to inspect a graphical interface while it runs.
In the release (normal) version, this code is not activated and
the resulting programs usually run faster (but no dynamic inspection
is allowed).
You can disable or enable the build of the `-develop' version by giving
options --disable-develop or --enable-develop (the default) to the
configure script.

  By default, only the shared version(s) of the library(ies) will be built.
You can compile and install a static version by adding --enable-static
to the configure command line. (This is a feature of libtool.) However,
be warned that the static version is rather big.

  On Unix, we recommend to install the library in /usr/local/openamulet
with --prefix=/usr/local/openamulet for the moment.

  Finally, if you want to help with the development of OpenAmulet, or
if you fall on hard bugs while using the library, you can compile a
real debugging version of the libraries by passing the option CXXFLAGS=-g 
to the build system when running make. E.g. I usually use:
 make CXXFLAGS='-g -O'
In this case, the resulting libraries will be huge, but you can follow
the execution of your program closely and step inside the library.

Several test programs are available in the Unix standard distribution.
You can compile them with:
  make check
They will be linked with the local version of the library (from the
development tree). The 'check' target will also run some of the test
programs if you installed the DejaGNU testing framework. However, most
of the test programs still must be run interactively. (Help would be
greatly appreciated on this point: regression testing is, IMHO, very
important for OpenAmulet.)

Finally, if you want to contribute to the Unix version and, especially,
if you understand the meaning of '--enable-maintainer-mode', please
note that, since 4.2.2, the OpenAmulet Unix build system relies on:
 autoconf v.2.13, automake v.1.4, and libtool v.1.2e
The 1.2e version of libtool is rather stable but is a _development_
version (coming directly from a CVS snapshot). And this seems
mandatory.

Amicalement,

Rodolphe Ortalo, <ortalo@cert.fr>


Basic Installation
==================

Note: These are generic installation instructions extracted from the
autoconf-2.13 'INSTALL' file.

   The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation.  It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions.  Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, a file
`config.cache' that saves the results of its tests to speed up
reconfiguring, and a file `config.log' containing compiler output
(useful mainly for debugging `configure').

   If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release.  If at some point `config.cache'
contains results you don't want to keep, you may remove or edit it.

   The file `configure.in' is used to create `configure' by a program
called `autoconf'.  You only need `configure.in' if you want to change
it or regenerate `configure' using a newer version of `autoconf'.

The safest way to compile this package is:

  0. `cd' to the directory containing the package's source code and
     create a special build directory (that you may easily remove
     afterwards if you want) with `mkdir build'. You can also directly
     build the library in the original source code directly if you want
     or need it (go directly to step 1). See `Compiling for Multiple
     Architectures' below.
     If your 'make' program is not GNU-make, and lacks the 'vpath'
     feature, you may need to cancel step 0, and run 'configure'
     directly from the main source code directory. Or you may consider
     installing GNU make (and maybe a complete GNU system while you are
     at it, no?).  -- ortalo

  1. `cd' to the newly created build directory and type `../configure'
     to configure the package for your system. If you're using `csh' on
     an old version of System V, you might need to type
     `sh ../configure' instead to prevent `csh' from trying to execute
     `configure' itself.

     Running `configure' takes awhile.  While running, it prints some
     messages telling which features it is checking for.

  2. Type `make' to compile the package.

  3. Optionally, type `make check' to run any self-tests that come with
     the package. In the case of OpenAmulet, these self-tests provide
     interesting examples of the functionality of the library. Some of
     them are run automatically if you have installed the DejaGNU testing
     framework on your machine.

  4. Type `make install' to install the libraries and any data files and
     documentation. By default, this will go to the following directories:
     /usr/local/{lib,include,share/open-amulet}. No program is installed.

  5. You can remove the program binaries and object files from the
     source code directory by typing `make clean'.  To also remove the
     files that `configure' created (so you can compile the package for
     a different kind of computer), type `make distclean'.  There is
     also a `make maintainer-clean' target, but that is intended mainly
     for the package's developers.  If you use it, you may have to get
     all sorts of other programs in order to regenerate files that came
     with the distribution.

Compilers and Options
=====================

   Some systems require unusual options for compilation or linking that
the `configure' script does not know about.  You can give `configure'
initial values for variables by setting them in the environment.  Using
a Bourne-compatible shell, you can do that on the command line like
this:
     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure

Or on systems that have the `env' program, you can do it like this:
     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure

Compiling For Multiple Architectures
====================================

   You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory.  To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
directory where you want the object files and executables to go and run
the `configure' script.  `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.

   If you have to use a `make' that does not supports the `VPATH'
variable, you have to compile the package for one architecture at a time
in the source code directory.  After you have installed the package for
one architecture, use `make distclean' before reconfiguring for another
architecture.

Installation Names
==================

   By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PATH'.

   You can specify separate installation prefixes for
architecture-specific files and architecture-independent files.  If you
give `configure' the option `--exec-prefix=PATH', the package will use
PATH as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.

   In addition, if you use an unusual directory layout you can give
options like `--bindir=PATH' to specify different values for particular
kinds of files.  Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.

   If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.

Optional Features
=================

   For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.

OpenAmulet currently specifically recognizes several options:
* due to automake or autoconf standard libs:
 --enable-maintainer-mode enable make rules and dependencies not useful
                         (and sometimes confusing) to the casual installer
 --with-gnu-ld           assume the C compiler uses GNU ld [default=no]
 --with-x                use the X Window System
* due to libtool:
 --enable-static[=PKGS]  build static libraries [default=no]
 --enable-shared[=PKGS]  build shared libraries [default=yes]
 --disable-libtool-lock  force libtool not to do file locking
* due to a specific need:
 --disable-develop       build the development version (default=enable)

Specifying the System Type
==========================

   There may be some features `configure' can not figure out
automatically, but needs to determine by the type of host the package
will run on.  Usually `configure' can figure that out, but if it prints
a message saying it can not guess the host type, give it the
`--host=TYPE' option.  TYPE can either be a short name for the system
type, such as `sun4', or a canonical name with three fields:
     CPU-COMPANY-SYSTEM

See the file `config.sub' for the possible values of each field.  If
`config.sub' isn't included in this package, then this package doesn't
need to know the host type.

   If you are building compiler tools for cross-compiling, you can also
use the `--target=TYPE' option to select the type of system they will
produce code for and the `--build=TYPE' option to select the type of
system on which you are compiling the package.

Sharing Defaults
================

   If you want to set default values for `configure' scripts to share,
you can create a site shell script called `config.site' that gives
default values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists.  Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.

Operation Controls
==================

   `configure' recognizes the following options to control how it
operates.

`--cache-file=FILE'
     Use and save the results of the tests in FILE instead of
     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
     debugging `configure'.

`--help'
     Print a summary of the options to `configure', and exit.

`--quiet'
`--silent'
`-q'
     Do not print messages saying which checks are being made.  To
     suppress all normal output, redirect it to `/dev/null' (any error
     messages will still be shown).

`--srcdir=DIR'
     Look for the package's source code in directory DIR.  Usually
     `configure' can determine that directory automatically.

`--version'
     Print the version of Autoconf used to generate the `configure'
     script, and exit.

`configure' also accepts some other, not widely useful, options.

