===============================================================================
 Mail Notification installation instructions
===============================================================================

Index

	0. About this document
	1. Dependencies
	2. Instructions
	3. Configure options

0. About this document

	$Id: INSTALL,v 1.19 2006/05/15 04:31:14 jylefort Exp $

	Copyright (C) 2003-2006 Jean-Yves Lefort.

	This document is part of Mail Notification.
	It may be distributed under the same terms as Mail Notification.

1. Dependencies

	Mandatory:

		* GTK+ (version 2.6.0 or superior)
		  http://www.gtk.org/

		* GNOME (version 2.6.0 or superior)
		  http://www.gnome.org/

	Optional:

		* for mbox, MH, Maildir, POP3, IMAP and Sylpheed support:

		  GMime (version 2.1.0 or superior)
		  http://spruce.sourceforge.net/gmime/

		* for SSL/TLS support:

		  OpenSSL (version 0.9.5b or superior)
		  http://www.openssl.org/

		* for SASL authentication support:

		  Cyrus SASL (version 2.0 or superior)
		  http://asg.web.cmu.edu/sasl/sasl-library.html

		* for Evolution support:

		  Evolution (version 2.2 or superior)
		  http://www.gnome.org/projects/evolution/

2. Instructions

	Mail Notification uses the GNU build system. Hence, the
	following usual sequence will probably satisfy most users:

		$ ./configure
		$ make
		<get root privileges, if needed>
		$ make install

	IMPORTANT:

		* Due to a bug in bonobo-activation
		  (http://bugzilla.gnome.org/show_bug.cgi?id=151082),
		  your session must be restarted after installing Mail
		  Notification.

		* Evolution 2.2.x only: for building Evolution
		  support, you must specify the path to the Evolution
		  source directory, for instance:

			$ ./configure \
			    --with-evolution-source-dir=$HOME/evolution-2.2.3

		  This is not necessary with Evolution >= 2.3.

	The configure script options which are specific to Mail
	Notification are documented below.

3. Configure options

	--enable-mbox (default: yes)

		Enable mbox mailbox support.

		Requirements: GMime version 2.1.0 or superior.

	--enable-mh (default: yes)

		Enable MH mailbox support.

		Requirements: GMime version 2.1.0 or superior.

	--enable-maildir (default: yes)

		Enable Maildir mailbox support.

		Requirements: GMime version 2.1.0 or superior.

	--enable-pop3 (default: yes)

		Enable POP3 mailbox support.

		Requirements: GMime version 2.1.0 or superior.

	--enable-imap (default: yes)

		Enable IMAP mailbox support.

		Requirements: GMime version 2.1.0 or superior.

	--enable-ssl (default: yes)

		Enable SSL/TLS support.

		Requirements: OpenSSL version 0.9.5b or superior.
		Applies to: POP3, IMAP.

	--enable-sasl (default: yes)

		Enable SASL authentication support.

		Requirements: Cyrus SASL version 2.0 or superior.
		Applies to: POP3, IMAP.

	--enable-ipv6 (default: yes)

		Enable IPv6 support.

		Applies to: POP3, IMAP.

	--enable-gmail (default: yes)

		Enable Gmail mailbox support.

	--enable-evolution (default: yes)

		Enable Evolution mailbox support.

		Requirements: Evolution version 2.2 or superior.

		With Evolution 2.2.x, you must also specify the path
		to the Evolution source directory, for instance:

			$ ./configure \
			    --with-evolution-source-dir=$HOME/evolution-2.2.3

	--with-evolution-source-dir=DIR (default: no)

		Specify the path to the Evolution source directory,
		which is required for building Evolution mailbox
		support (Evolution 2.2.x only, not necessary with
		Evolution >= 2.3).

		Requirements: the source directory corresponding to
			      the version of Evolution 2.2.x installed
			      on your system.
		Applies to: Evolution.

	--enable-sylpheed (default: yes)

		Enable Sylpheed mailbox support.

		Requirements: GMime version 2.1.0 or superior.

	--enable-sylpheed-locking (default: no)

		Enable .sylpheed_mark locking. This option allows Mail
		Notification to reliably avoid race conditions which
		can occur when Sylpheed is running, but it requires a
		patched version of Sylpheed (the Sylpheed patch,
		sylpheed-locking.diff, is included in this archive).

		Requirements: Sylpheed patched with sylpheed-locking.diff
