          Copyright (c) mjh-EDV Beratung, 1996-1999
     mjh-EDV Beratung - 63263 Neu-Isenburg - Rosenstrasse 12
          Tel +49 6102 328279 - Fax +49 6102 328278
                Email info@mjh.teddy-net.com

    Author: Jordan Hrycaj <jordan@mjh.teddy-net.com>

   $Id: INSTALL,v 1.3 2000/08/06 18:50:18 jordan Exp $

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

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

Express Installation
====================

  Run the script

    ./configure

  without any arguments, and wait until it has finished. After that do

    make

    make install 
    
      or
 
    make install-all

  where install-all also installs the documentation. After you have
  finished with the installation, do

    make clean

      or
   
    make distclean

  where the latter command removes the configuration setting created
  by the ./configure script, as well.
    

Custom Installation
===================

  The configure script accepts a bunch of option, where not all
  of the options supported make sense, in gerneral. Try

    ./configure --help

  to get an idea what is available. Among all the possible options,
  the following make sense for a custom installation:

    --prefix=PREFIX      By default, the installation directory will
                         be /usr/local, setting PREFIX allows you to
                         install somewhere else

    --enable-cipher[=NN] Set the client/server encryption to NN bits
                         key length (suitable for US export), see the
	                 file README.RESTRICTED-KEY-LENGTHS for details

    --enable-release     Set the compiler flags to -O6
    --enable-debug       Set the compiler flags to -g

    --host=HOST          Configure for HOST type with a particular
                         architecture, in some rare cases, this may help
                         guessing how to configure the package.  HOST can
                         either be a short name for the system type, such
                         as `sun4', or a canonical name with the three 
                         fields: CPU-COMPANY-SYSTEM.  See the file
                         config.sub for the possible values of each field. 

    --enable-shared      Build shared library, if possible

    --disable-shared     Do not build shared library

    --enable-pthreads    Use the pthreads for the thread management
                         (this is experimental)

    --disable-zlib       Disable data stream compression

    --enable-zlib=peks   Explicitely configure and compile the data stream
			 compression package against the source fragment that
			 comes with peks, even if the operating system
			 provides it as a library.

    --enable-gmp=peks	 Explicitely configure and compile the maths package
			 against the source fragment that comes with peks,
			 even if the operating system provides it as a library.

    --enable-splitgmp    Split off the gmp library that comes with the peks
			 sources from the cipher lib, and provide a sepatate
			 library instance: this flag is needed only if the
			 assembler part of the gmp lib should not be used as a
			 shared library, while the libpeks, is.

  Some more elaborate options allow you to control whether to compile and
  link against the packages that come with peks, or to use resources from
  your operating system.

    --enable-zlib[=/path]  Do not use the package provided with peks, but the
                           one already installed.

    --enable-gmp[=/path]   Do not use the package provided with peks, but the
                           one already installed.

    --enable-random[=/dev] use this device as an additional random
                           source; you may need to set this explicitlely
		           on systems other than Linux and BSD where
                           there is a character device /dev/urandom
                           available (other device names will not be 
			   auto-detected.)

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 ./configure

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


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

  The ./configure script 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 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).

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


Thanks to the GNU and other peole for providing
such tools as autoconf and automeke.
jordan
