/** \page install Installation


\section install_basic Basic Installation

These are generic installation instructions.

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 at some point `config.cache' contains results you don't want to keep, you
may remove or edit it.

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

The simplest way to compile this package is:

  -# `cd' to the directory containing the library's source code 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.<br>
     Running `configure' takes awhile.  While running, it prints some
     messages telling which features it is checking for.
  -# Type `make' to compile the library.
  -# Optionally, cd to the directory 'docs' and type 'doxygen' to generate
     documentation. This assumes that doxygen is installed.
  -# Type `make install' to install the library and it's header files
  -# You can remove the library 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.


\section install_compilers 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:
\code
     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
\endcode

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


\section install_names Installation Names

By default, `make install' will install the package's files in
`/usr/local/lib', `/usr/local/include', 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.  


\section install_opt_feat Optional Features

`configure' recognizes the following optional features to control how library
is compiled:

-   `--enable-debug'<br>
    Use `-ggdb' flag during compilation and also enables using of `assert'
    macros to check internal state of library functions. Generated library's
    name has `d' at end.


\section install_oper_control Operation Controls

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

-   `--cache-file=FILE'<br>
     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'<br>
     Print a summary of the options to `configure', and exit.

-   `--quiet'<br>
-   `--silent'<br>
-   `-q'<br>
     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'<br>
     Look for the package's source code in directory DIR.  Usually
     `configure' can determine that directory automatically.

-   `--version'<br>
     Print the version of Autoconf used to generate the `configure'
     script, and exit.
*/
