                    The Aegypten Crypto Distribution
                    ---------------------------------
                             Version 1.0
		            
Installation
============

It is possible (and suggested) to install the Aegypten software from a
normal user account.  To do this you have to create the directory
"/usr/local/aegypten" and chown it accordingly.

Make sure that all required libraries are installed. Note that you need the
development packages of these libraries.  The top level configure tries to
warn you when it detects a missing library.

Run:

 ./configure
 
from the top level directory and if it does not complain, do a:

 make
 make install
 
This should build and install the whole bunch of software.  There is one
step you should do manually:  Mutt needs a setgid utility to locak
mailbozes, this can only be done from the roo account.  So you should do the
following if you intend to use mutt:

  chgrp mail /usr/local/aegypten/bin/mutt_dotlock 
  chmod 2755 /usr/local/aegypten/bin/mutt_dotlock 


Running:
========

You should modify your path to include the aegypten directory.  In your
login profile add the line:

  PATH=/usr/local/aegypten/bin:$PATH
  LD_LIBRARY_PATH=/usr/local/aegypten/lib:$LD_LIBRARY_PATH

It is best to create a few configuration files now.  As a starting point,
create a directory ~./gnupg and copy the examples from the examples
directory.

You need to start the gpg-agent before any other program if you want to use
OpenPGP or enable the PIN caching.  The gpg-agent manual (info gnupg) tells
you how to do this.  In short you can type this line:

  eval `gpg-agent --daemon`


Documentation
=============

Documentation is available as online help for KMail and Mutt.  The manuals
of the backend can be browsed using the info command:

info --directory /usr/local/aegypten/info

you may also choose to set an INFOPATH to include this directory, see the
documentation of info (1).

If you prefer standard man pages, you can easily build them using the
info2man tool available with Debian GNU/Linux (apt-get install info2man) or
direct at: http://www.zip.com.au/~cs/css/index.html#s-text-info2x .
Cd to the info directory and do a "info2man foo.info >foo.1".

If you need printable documentation, go to the appropriate doc directory of
the package and run the command "make foo.ps" where foo is the info manual
you want to print.



Notes about Mutt
================

The Mutt version included is an enhanced for the use with Sphinx; to not
confuse it with a regular mutt version, the program has been renamed to
"mutts" and the configuration file is "~/.muttsrc".



Help
====

We have created a German speaking mailing list "aegypten-anwender@gnupg.org"
(send mail with subject "subscribe" to "aegypten-anwender-request@gnupg.org"
to subscribe to this list). Please ask on this list if you have problems.

An English speaking mailing list is "gpa-dev@gnupg.org" but this is more
a technical orientated one.



Updating modules
================

This software is a collection of modules; you can use newer version of these
modules if you follow these instructions:


to update backend modules:

  cd backend
  tar xzvf foo-x.y.z.tar.gz
  rm -r foo
  mv foo-z.y.z kdefoo

to update KDE frontend modules:

  cd frontends/kde
  tar xzvf kdefoo-x.y.z.tar.gz
  rm -r kdefoo
  mv kdefoo-z.y.z kdefoo

to update other frontend modules:

  cd frontends
  tar xzvf foo-x.y.z.tar.gz
  rm -r foo
  mv foo-z.y.z foo

Then cd back to the top directory and do:

  rm backend/*.stamp
  rm frontends/*.stamp
  make
  
The purpose of the stamp files is to avoid running configure too often
because this takes quite some time.  If you update a frontend module it is
often sufficient to remove just the appropriate stamp file.


Version Info
============

The modules included in this package are of these versions:

frontends/kde : 20021009
frontends/mutt : 1.5.0-gpgme-020926
frontends/pinentry: 0.6.6 + patches to include the manual
backend/libgcrypt: 1.1.10
backend/gpgme: 0.3.11
backend/libksba: 0.4.5
backend/newpg: 0.9.2
backend/opensc: 0.7.0wk1
backend/dirmngr: 0.4.2



Happy Sphinxing,

  The Aegypten team

