***************************************************************************** 
* $RCSfile: INSTALL,v $
* 
* $Author: jekholm $
* $Revision: 1.11 $
* $Date: 2000/03/14 07:40:31 $
*
*****************************************************************************
*
* This file describes how Zombie is installed.
*
*****************************************************************************


To install Zombie on your system you need to follow these steps and
make the necessary modifications depending on your configuration. If you read
this file you apparently have not downloaded the prebuilt binary packages.


1. Make sure you have the newest release

Do this by checking the page http://www.infa.abo.fi/~chakie/zombie/. Always
use the newest version! If you use the RPM:s or Debian packages you don't need
to read this file, everything is prebuilt and ready to use. Depending on how
you intend to get Zombie use either the a) or b) approach in section 2.


2a. Unpack and untar the package

Zombie comes as a gzipped tar-file. Move the file 'zombie-xxx.tar.gz', where
xxx is the current version, to the directory of your choice, preferably
/usr/local. Then unpack the archive :

		% gunzip zombie-xx.yy-zz.tar.gz

After that you need to untar the file to create the 'zombie' directory and
extract all files. Do this with :

		% tar xvf zombie-xx.yy-zz.tar

You now should have a 'zombie' directory.


2b. Check out the sources from the Zombie CVS


This gives you access to the bleeding edge. The version here may not always
work, nor even compile, so use at your own risk! Currently the only way to
access the Zombie CVS is anonymously.

Access the CVS with the access string: 

       csh: setenv CVSROOT :pserver:anonymous@mowgli.btk.utu.fi:/usr/local/cvsroot
       sh:  export CVSROOT=:pserver:anonymous@mowgli.btk.utu.fi:/usr/local/cvsroot 

First you need to log in to the server. The password is 'anonymous'. 

		% cvs login 

Now you can check out the sources for Zombie with the command: 

		% cvs co zombie 

You can also check out one of the stable(r) releases if you don't want to get
the bleeding edge versions. The sources are tagged in the repository for each
public RPM-release. The tags are named 'zombie-MAJOR_MINOR-BUILD'. If you for
instance want to check out the version 0.70-2 you should issue the command:

		% cvs co -jzombie-0_70-2 zombie 


3. Change to the created directory.

		% cd zombie


4. Check the toplevel Makefile.in for paths, tools etc. The file
'Makefile.common' contains the installation paths as well as variables for
all tools used in the compilation process. 


5. Make sure all old files are removed properly :

		% make clean

This will remove all old object-files and possibly old libraries etc. in order
to make sure everything is cleanly rebuilt. 


6. Configure Zombie using 'autoconf'.

		% ./configure [options]
		
or
		
		% ./configure --help
	
to list all available options for 'configure'. The options currently supported
except the normal autoconf options are:

  --with-qtdir=VALUE        basedirectory of Qt headers and libraries
  --with-kdedir=VALUE       basedirectory of KDE headers and libraries
  --with-logdir=VALUE       directory for logs (default: /var/log/zombie)
  --with-docdir=VALUE       directory for docs (default: /usr/doc)
  --with-samplesdir=VALUE   directory for samples (default: the above docdir)
  --with-scriptdir=VALUE    directory for start/stop script (default: /etc/rc.d/init.d)
  --with-user=VALUE         user that should own all installed files (default: root)
  --with-group=VALUE        group that should own all installed files (default: root)
  --enable-namespace
  --disable-namespace
  --enable-namespace=VALUE  enable/disable the use of a namespace for all code
  --with-port=VALUE         use a custom port (default: 6823)

Before building and installing Zombie please verify that the directories are
correct. The configure-script prints a summary of the directories that will
actually be used/created for the installation. This should reduce errors
where stuff just 'vanishes' somewhere.

It is recommended to manually set the --includedir variable to something else
than the defaul 'PREFIX/include' in order to reduce clutter in the directory. 
It is best to put all the files in a subdirectory, such as 'zombie'. The 
variable would the be given as '--includedir=/usr/include/zombie', assuming
that /usr is the wanted prefix.


7. Build the package with:

		% make

If all seems to have succeeded you can install Zombie with :

		% make install	


8. If you want the samples built and installed you need to build them
too. Remain in the toplevel directory and issue the commands:

		% make examples
		% make examples-install


9. Where are all files?

After a successful compilation you now should have everything ready to be
used. See 'README' for a description of the normal directory layout. Also see
the output of './configure' for a summary of the used directories. Make sure
you know where all files will go before you install anything. Especially the
config-file 'zombie.conf' uses 'sysconfdir' and will end up in 'PREFIX/etc',
which may not always be desirable. Use '--sysconfdir=VALUE' to alter this
behaviour. 


10. Running Zombie

To run Zombie you generally don't need to do so much. Read through the
documentation under 'doc' to see if there are any special switches
you might want to give to Zombie or something special you should put in the
configuration file. By default the config-file is installed as /etc/zombie.conf.
You can specify you own file if you want. 

To start Zombie and have it run in the background issue the command (Red Hat):

		% /etc/rc.d/init.d/zombie start

The location above may be different depending on your distribution and wether
you had a special install prefix.


11. More information?

For more information see the 'doc' directory. It should contain some
documents in PostScript, PDF and HTML about the Zombie system and how
to write Zombie-aware applications. If no Postscript is available you
can make it manually by issuing a 'make' in the directory. This should
build the reference manual from the SGML source. Requires SGMLtools
and the DocBook DTD. Prebuilt manuals are available from the Zombie
homepage at http://www.infa.abo.fi/~chakie/zombie/ or in the binary
packages also available from the address above.


Have fun!
-- Chakie

