Pygmy is distributed under the terms of the GNU General Public
License.  See the file 'COPYING' for details.

Warning: Pygmy is under development, and you should take backup of
your mail before trying it.  The authors take no responsibility of
bugs/features causing loss of mail.  Use at own risk!


1. Installing Pygmy

Prerequisites:
	Python 1.5.2		(http://www.python.org/)
	GTK+ 1.2.7		(http://www.gtk.org/)
	gnome-libs		(http://www.gnome.org/)
	gnome-python		(http://www.gnome.org/)

Most of this stuff is available as RPMS for Linux users and included
in the ports collection for FreeBSD.  Pygmy has currently only been
tested on Linux and FreeBSD, but should be able to run on Unix hosts
supporting Python and GNOME.  Please note that Pygmy will NOT work
with Python versions below 1.5.2 and has not been tested with Python
1.6/2.0.  Also note that some distributions, among them RedHat 6.1+
and Mandrake 7.0+, include all the prerequisite tools necessary to
run Pygmy.

Unpack the distribution.  Modify the PREFIX value in the Makefile and
type 'make install' on the command line.  Pygmy will be installed in
PREFIX/pygmy. A soft-link will be created from PREFIX/pygmy/pygmy to
PREFIX/bin/pygmy.  Assuming PREFIX/bin is in your path, you should be
able to run the 'pygmy' executable after issuing 'make install'.


2. Fetching and processing mail

The first time you start Pygmy, it will automatically look for four
default folders called 'inbox', 'outbox', 'sent-mail' and 'trash'.  As
of now, the presence these folders is necessary for Pygmy to operate
properly.  If they do not exist, Pygmy will automatically create them
at startup.  By default, all new mail is put in the 'inbox' folder
file.  Pygmy only supports the Unix mailbox format and this is
unlikely to change for a while.

Pygmy relies on external tools like fetchmail for fetching mail from
remote servers.  fetchmail can be configured (using, for instance,
fetchmailconf) to fetch mail using IMAP or POP variations.  If your
computer does not have fetchmail installed, you may get it from:

	http://www.tuxedo.org/~esr/fetchmail/


3. Cooperation with other mail clients

Pygmy is able to cooperate (i.e. share folders) with other mailbox
mail clients such as mutt, elm and pine.  However, when other mail
clients modify the folder files, Pygmy will regenerate the index file
for that folder.  Regenerating the index file will cause the 'Status'
header information contained in the email messages to be lost.  We are
working on improving this.

If you have existing mail folders in mailbox format and want to
_import_ a folder to Pygmy, copy the folder to the Pygmy mail folder
directory and add the folder to Pygmy through the user interface
(Folder->New).  Type the file name of the folder you want to add
(i.e. the folder you copied to the Pygmy mail folder directory).  The
new folder should now be visible in the Pygmy folderview.

If you want to _share_ folders with another mail client, you need not
copy the folder file to the Pygmy mail folder directory.  Instead,
just ensure that other mail clients and Pygmy share the same mail
folder directory.

NOTE: Please do not run other mail clients _concurrently_ with Pygmy
      as this may cause your mail folders to get corrupted.


4. Contact and feedback

Please send feedback, bug reports or whatever to the authors:

	Kjetil Jacobsen <kjetilja@cs.uit.no>
	Dag Brattli <dag@brattli.net>

Pygmy on the web:
	
	http://pygmy.sourceforge.net/
