path: root/README

Evolution is the integrated mail, calendar and address book
distributed suite from Ximian, Inc.

See http://www.ximian.com/apps/evolution.php3 for more information.

Note that Evolution is still beta. This means it may delete all of
your mail if you give it the chance.

If you are using Evolution, you should subscribe to the Evolution
mailing list. If you are interested in hacking on it, you should
subscribe to the Evolution Hackers mailing list. Send mail to
"evolution-request@ximian.com" or
"evolution-hackers-request@ximian.com" with the word "subscribe" in
the body of the message. If you are planning to work on any part of
Evolution, please send mail to the mailing list first, to avoid
duplicated effort (and to make sure that you aren't basing your work
on interfaces that are expected to change).

There are mailing list archives available at
http://lists.ximian.com/archives/public/evolution/     and
http://lists.ximian.com/archives/public/evolution-hackers/

There is also an #evolution IRC channel on irc.gnome.org.


IF IT DOESN'T WORK
------------------

Did you read the "How to build" section below? :-)

If you have built Evolution and it doesn't work, or you can't get it
or one of its dependencies to compile, try running the
"verify-evolution-install.sh" script in the tools/ subdirectory. It
may be able to figure out what went wrong.

If the configure script complains that you don't have a library that
you know you have installed, it usually means either that you've
installed things into multiple prefixes (see the bits on GNOME_PATH
below) or (if you're on Linux) that you installed the "foo" package
but forgot the "foo-devel" package.


HOW TO BUILD EVOLUTION
----------------------

    *** READ THIS BEFORE YOU START BUILDING ANYTHING! ***

Evolution depends on a large number of unreleased and rapidly-changing
libraries. Some of these libraries in turn depend on other unreleased
and rapidly-changing libraries.

Building Evolution is HARD, and it's going to stay hard until all of
the libraries it depends on stabilize, and there's nothing we can do
to make it any easier until then.


General Principles
------------------

First you have to decide whether you want to install Evolution (and
its dependencies) into the same prefix as the rest of your GNOME
install, or into a new prefix. Installing everything into the same
prefix as the rest of your GNOME install will make it much easier to
build and run programs, and easier to switch between using packages
and building it yourself, but it may also make it harder to uninstall
later.

If you want to install into the same prefix as the rest of GNOME,
type:

    gnome-config --prefix
    gnome-config --sysconfdir

and remember the answers, and pass them to "configure" or "autogen.sh"
when building the other packages you need. Eg:

    ./configure --prefix=/usr --sysconfdir=/etc


If you build in another prefix instead, you will need to set the
GNOME_PATH environment variable (and ACLOCAL_FLAGS as well if building
from CVS) to include the prefix you install into. Eg:

        export GNOME_PATH=/usr/local
    export ACLOCAL_FLAGS="-I /usr/local/share/aclocal"

(Assuming your shell is bash, and you installed into /usr/local.) You
need to set GNOME_PATH both during compiling AND when you run
evolution. Remember also that if you're installing into an odd prefix
such as /evolution, that you also need to make sure to put
${prefix}/bin in your PATH and ${prefix}/lib in your LD_LIBRARY_PATH.


Dependencies
------------

All of these libraries are available in GNOME CVS, under the given
names. Most (but not all) of them are also available as tarballs on
ftp.gnome.org. The (*)ed packages are available in Ximian GNOME
(http://www.ximian.com/desktop/) Other packages may be available from
the Ximian GNOME evolution preview mirror.

If installing from packages, remember that you need both the runtime
and -devel packages for each library.

 - xml-i18n-tools - lates from xml-i18n-tools-stable-1-x branch in
   GNOME CVS (0.8.2 is too old)

 - gnome-xml - 1.8.10 or later in the 1.0 series, but not from the 2.0
   series (If you get this from GNOME CVS, use the tag "LIB_XML_1_X".)
   (*)

 - gnome-print - 0.25 or later (*)

 - gdk-pixbuf - 0.8.0 or later (*)

 - ORBit - 0.5.6 or later (*) (If you get this from GNOME CVS, use the
   tag "orbit-stable-0-5".)

 - oaf - 0.6.2 or later (If you get this from GNOME CVS, use the tag
   "oaf-stable-0-6")

   *** If you are using oaf from CVS, you should use the flag
   *** "--disable-more-warnings" when configure, or it may fail to
   *** build.

 - gconf - 0.6 or later.

 - gnome-vfs - 0.4.2 or later (If you get this from GNOME CVS, use
   the tag "gnome-vfs-1-0")

   *** If you are using gnome-vfs from CVS, you should use the flag
   *** "--disable-more-warnings" when configuring, or it may fail to
   *** build.

 - libglade (*)

 - bonobo - 0.37 or later

   *** Note that bonobo must be installed with the same --prefix as
   *** either gnome-libs or evolution for the Makefiles to work
   *** properly.

 - libunicode - 0.4.gnome (*)

 - gal (GNOME Application Library) - 0.5.99.5 or later

 - gtkhtml - 0.8.2 or later

If you want support for PalmPilot syncing (currently experimental so
please back up your pilot) you will also need to do the following:

1) pilot-link
cvs -d :pserver:anonymous@cvs.gnu-designs.com:/cvs/pilot-link login
The password is just <ENTER>.
cvs -d :pserver:anonymous@cvs.gnu-designs.com:/cvs/pilot-link co pilot-link
./configure --prefix=<pilot-link-prefix> --with-perl=no --with-java=no
--with-tcl=no --with-python=no
make
make install

2) gnome-pilot
cvs -z3 co gnome-pilot
./autogen.sh --prefix=<gnome-pilot-prefix> --with-pisock=<pilot-link-prefix>
make
make install

3) evolution
in your evo source dir do ./autogen.sh --prefix=<evo-prefix> 
--with-pisock=<pilot-link-prefix> --enable-pilot-conduits=yes
make
make install


If you want support SSL (and someday S/MIME), you will also need libnspr4 and
libnss3 which can be found at http://www.mozilla.org.

Once you have libnspr4 and libnss3 (and their respective includes) installed,
in your evolution source dir do:
./autogen.sh --prefix=<evo-prefix> --with-nspr-includes=<nspr-includes-prefix>
--with-nspr-libs=<nspr-libs-prefix> --with-nss-includes=<nss-includes-prefix>
--with-nss-libs=<nss-libs-prefix>

You'll need to `cp ~/.mozilla/default/*.db ~/evolution` on you've
installed Evolution in order to get a functional SSL-enabled
Evolution.

The layout of the source tree is:

addressbook:    the Address Book UI
art:        graphics used by evolution
calendar:   the Calendar UI
camel:      libcamel, a messaging library used by the mailer.
        Camel is inspired by Sun's JavaMail
        (http://java.sun.com/products/javamail/) and the
        IMAPv4 spec (RFC 2060).
composer:   the message composer UI
data:       the .desktop file for Evolution
default_user:   initial Evolution config files for new users
devel-docs: entirely inadequate documentation
doc:        more adequate documentation
e-util:     utility code used by various parts of Evolution
filter:     libfilter, a mail filtering library
libibex:    an indexing library used by the mailer
libical:    a library for the iCalendar format (RFC 2445-2446)
libversit:  a library for the vCard (RFC 2425-2426) and vCalendar
        (http://www.imc.org/pdi/vcal-10.txt) formats
mail:       the mail display UI
shell:      the Evolution shell (the main program that launches
        the other components)
tests:      some test programs
tools:      utilities, notably "killev", a script to kill of all
        of the Evolution components
widgets:    widgets used by Evolution, including the shortcut bar
wombat:     Has source code that will load in the addressbook
        and calendar backend, and will form the server
        process we'll be using