This commit was manufactured by cvs2svn to create tagEVOLUTION_1_2_4

'EVOLUTION_1_2_4'.

svn path=/tags/EVOLUTION_1_2_4/; revision=20614

1 files changed, 178 insertions, 167 deletions

diff --git a/README b/README
index 4413d468a6..4760b20572 100644
--- a/README
+++ b/README
@@ -1,23 +1,23 @@
-Evolution is the integrated mail, calendar and address book suite from
-Ximian, Inc.
+Evolution is the integrated mail, calendar and address book
+distributed suite from Ximian, Inc.
 
 See http://www.ximian.com/products/evolution for more information.
 
 If you are using Evolution, you may wish to subscribe to the Evolution
-users mailing list.  If you are interested in contributing to
+users mailing list. If you are interested in contributing to
 development on it, you should certainly subscribe to the Evolution
-Hackers mailing list.  Visit
+Hackers mailing list. Visit
+http://developer.ximian.com/community/lists.html to subscribe to
+Ximian mailing lists. 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).
 
-	http://developer.ximian.com/community/lists.html
+There are mailing list archives available at
+http://lists.ximian.com/archives/public/evolution/ and
+http://lists.ximian.com/archives/public/evolution-hackers/
 
-to subscribe or view archives of the Ximian mailing lists.
-
-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 is also a #evolution IRC channel on irc.gnome.org.
+There is also an #evolution IRC channel on irc.gnome.org.
 
 Help for Evolution is available in the user manual (select "Help" from
 the menu after running the application), at the Ximian knowledge base
@@ -28,229 +28,240 @@ evolution" at the command line), and in the --help strings (run
 The rest of this file is dedicated to building Evolution.
 
 
-DEPENDENCIES
-------------
+PROBLEMS BUILDING EVOLUTION
+---------------------------
 
-In order to build Evolution you need to have the full set of GNOME 2
-or GNOME 2.2 development libraries installed.
+Did you read the "How to build" section below?
 
-GNOME 2 comes with most of the modern distributions, so in most cases
-it should be enough to just install all the devel packages from your
-distribution.  If, on the other hand, you want to build GNOME 2 from
-source, please refer to this page:
+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" or "foo-dev" packages.
 
-	http://gnome.org/start/2.2/notes/rninstallation.html
 
-Please make sure you have the most recent versions of the libraries
-installed, since bugs in the libraries can cause bugs in Evolution.
+HOW TO BUILD EVOLUTION
+----------------------
 
-Additional dependencies, besides the stock GNOME libraries (the
-dependencies should be compiled in the order they are listed here):
+	*** READ THIS BEFORE YOU START BUILDING ANYTHING! ***
 
-	* [If compiling against GNOME 2.0] libgnomeprint and
-          libgnomeprintui 2.2.0 or later
+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.
 
-	  These library come with GNOME 2.2 installations, but not
-	  with GNOME 2.0 ones.  The source code can be downloaded from
-	  the following locations:
+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.
 
-	     ftp://ftp.gnome.org/pub/gnome/sources/libgnomeprint
-	     ftp://ftp.gnome.org/pub/gnome/sources/libgnomeprintui
 
-	* [If compiling against GNOME 2.2] libgnomecanvas 2.2.0.2 or
-          later
+GENERAL PRINCIPLES
+------------------
 
-	  If you have a GNOME 2.2 installation, you need to upgrade
-	  libgnomecanvas to this version (or a later one), since
-	  Evolution exposes a bug in the older versions of the library
-	  which causes a crash.
+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 have a GNOME 2.0 installation, libgnomecanvas 2.0 is
-	  safe to use.
+If you want to install into the same prefix as the rest of GNOME,
+type:
 
-	* libsoup 1.99.12 or later
+	gnome-config --prefix
+	gnome-config --sysconfdir
 
-	     ftp://ftp.gnome.org/pub/gnome/sources/libsoup
+and remember the answers, and pass them to "configure" or "autogen.sh"
+when building the other packages you need. For example:
 
-	* gtkhtml 3.0.1 or later
+	./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var/lib
 
-	     ftp://ftp.gnome.org/pub/gnome/sources/gtkhtml
+    --localstatedir is needed to make the docs integrate with scrollkeeper
+    and needs to point to the directory containing the scrollkeeper indices
+    which are in: gnome-config --localstatedir
 
-	* gal 1.99.2 or later
+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. For example:
 
-	     ftp://ftp.gnome.org/pub/gnome/sources/gal
+        export GNOME_PATH=/usr/local
+	export ACLOCAL_FLAGS="-I /usr/local/share/aclocal"
 
-	* Berkeley's libdb 3.1.17
+(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.
 
-	  It is important to use *exactly* this version, and not a
-	  later one, to compile Evolution.  Please check the "Building
-	  Berkeley DB" section below for more information.
 
-   	     ftp://ftp.ximian.com/pub/ximian-evolution-beta/source/
+DEPENDENCIES
+------------
 
-	* [Optional] Mozilla NSPR/NSS libraries
+The following required 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 or one of the Ximian mirrors listed at
+http://ximian.com/mirrors.html. 
 
-	  These are needed if you want to compile Evolution with SSL
-	  support.
+If installing from packages, remember that you need both the runtime
+and -devel packages for each library.
 
-	     http://www.mozilla.org/
+ - GNU intltool 0.18 
 
-          Many distributions ship these as Mozilla development
-          packages.
+ - scrollkeeper - 0.1.4 or later 
 
-	* [Optional] gnome-pilot 2.0 or later
+ - gnome-xml - 1.8.17 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_BRANCH".)
 
-	  This is only necessary if you want to be able to synchronize
-	  your Palm device with Evolution.
+ - gnome-print - 0.35 or later 
 
-	     ftp://ftp.gnome.org/pub/gnome/sources/gnome-pilot
-	     ftp://ftp.gnome.org/pub/gnome/sources/gnome-pilot-conduits
+ - gdk-pixbuf - 0.18.0 or later 
 
-	* [Optional] gnome-spell 1.0.1 or later
+ - ORBit - 0.5.8 or later  (If you get this from GNOME CVS, use the
+   tag "orbit-stable-0-5".)
 
-	  This is only necessary if you want to have the spell
-	  checking functionality in Evolution's message composer.
+ - oaf - 0.6.10 or later (If you get this from GNOME CVS, use the tag
+   "oaf-stable-0-6")
 
-	     ftp://ftp.gnome.org/pub/gnome/sources/gnome-spell
+   *** If you are using oaf from CVS, you should use the flag
+   *** "--disable-more-warnings" when you configure, or it may fail to
+   *** build.
 
+ - gnome-vfs - 1.0.5 or later (If you get this from GNOME CVS, use
+   the tag "gnome-vfs-1-0")
 
-COMPILING BERKELEY DB
----------------------
+   *** If you are using gnome-vfs from CVS, you should use the flag
+   *** "--disable-more-warnings" when configuring, or it may fail to
+   *** build.
 
-    --- IMPORTANT WARNING ---
+ - libglade - 0.14 or later 
 
-    The on-disk format of DB files has been changing between versions 2, 3
-    and 4.  Also, because of the libdb API, there is no way to easily
-    handle the different formats from within the application.  For this
-    reason, Evolution has chosen to use one specific version of the
-    library (version 3) and stick to it, so that users do not need to
-    convert their addressbook files to use them with different version of
-    Evolution.
+ - bonobo - 1.0.3 or later 
 
-    That's why Evolution REQUIRES libdb 3.1.17, and NO OTHER VERSION.
+   *** Note that bonobo must be installed with the same --prefix as
+   *** either gnome-libs or evolution for the Makefiles to work
+   *** properly.
 
-    If you force the check to accept a version different from 3.1.17, your
-    binary of Evolution will be using a different format from the chosen
-    one; this means that it will not be able to read addressbook databases
-    created by other versions of Evolution which were compiled in the
-    standard way.  Also, we DO NOT GUARRANTEE that Evolution will work
-    with different versions of libdb at all, even if it can be trivially
-    made to compile against them.
+ - bonobo-conf - 1.0.16 or later 
 
-    SPECIAL NOTE FOR BINARY PACKAGERS:
+ - gal (GNOME Application Library) - 0.21 or later 
 
-    If you are making binary packages for end-users (e.g. if you are a
-    distribution vendor), please statically link Evolution to Berkeley
-    DB 3.1.17, as mandated by the configure.in check.  DO NOT patch
-    configure.in to work around the check.  Forcing the check to link
-    to a different version of the library will only give headaches and
-    pain to your users, who will see their addressbook disappear and
-    will complain to us (the Evolution team) about losing their data.
+ - gtkhtml - 1.1.5 or later 
 
-    Besides, libdb will be linked statically, which means that your
-    distribution doesn't actually need to ship DB 3.1.17 itself
-    separately.
+ - SOUP - 0.7.x 
 
-    The Evolution team will be infinitely grateful for your
-    co-operation.  Thanks!
+   *** If you are compiling from CVS, grab the soup-0-7 branch.
 
-If you don't have version 3.1.17 installed on your system or Evolution
-doesn't detect it for some reason, here is a way to get Evolution to
-link to it without messing up your system installation.
+Other non-GNOME Dependencies:
 
-  * Install the content of the tarball somewhere *other* than the
-    evolution source tree, e.g: NOT evolution/db-3.1.17 .
+ - Berkeley's libdb - 3.1.17
 
-  * Compile according to instructions, but installing into some custom
-    prefix, for example:
+   db3 is available from http://www.sleepycat.com. Make sure to get
+   3.1.17, which isn't the latest version.
 
-      ../dist/configure --prefix=/home/user/berkeleydb-3.1.17
+     --- IMPORTANT WARNING ---
 
-  * Configure Evolution specifying that it has to look for the DB
-    library there, for example:
+     The on-disk format of DB files has been changing between versions
+     2, 3 and 4.  Also, because of the libdb API, there is no way to
+     easily handle the different formats from within the application.
+     For this reason, Evolution has chosen to use one specific version
+     of the library (version 3) and stick to it, so that users do not
+     need to convert their addressbook files to use them with
+     different version of Evolution.
 
-      ./configure --prefix=/opt/gnome
-      --with-db3-includes=/home/user/berkeleydb-3.1.17/include
-      --with-db3-libs=/home/user/berkeleydb-3.1.17/lib
+     That's why Evolution REQUIRES libdb 3.1.17, and NO OTHER VERSION.
 
-Evolution links statically to the library, so after you have compiled
-Evolution you can remove the installed library from your system.
+     If you force the check to accept a version different from 3.1.17,
+     your binary of Evolution will be using a different format from
+     the chosen one; this means that it will not be able to read
+     addressbook databases created by other versions of Evolution
+     which were compiled in the standard way.  Also, we DO NOT
+     GUARRANTEE that Evolution will work with different versions of
+     libdb at all, even if it can be trivially made to compile against
+     them.
 
+     SPECIAL NOTE FOR BINARY PACKAGERS:
 
-CONFIGURING EVOLUTION
----------------------
+     If you are making binary packages for end-users (e.g. if you are
+     a distribution vendor), please statically link Evolution to
+     Berkeley DB 3.1.17, as mandated by the configure.in check.  DO
+     NOT patch configure.in to work around the check.  Forcing the
+     check to link to a different version of the library will only
+     give headaches and pain to your users, who will see their
+     addressbook disappear and will complain to us (the Evolution
+     team) about losing their data.
 
-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.
+     Besides, libdb will be linked statically, which means that your
+     distribution doesn't actually need to ship DB 3.1.17 itself
+     separately.
 
-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.  Also, it increases the chance
-that something goes wrong and your GNOME installation gets ruined.
+     The Evolution team will be infinitely grateful for your
+     co-operation. Thanks.
 
-If you want to install in a different prefix, you need to do the
-following things:
 
-	* Set the PKG_CONFIG_PATH environment variable to contain a
-          colon-separated list of all the pkg-config directories that
-          will be involved in the build.  This basically means a list
-          of $prefix/lib/pkgconfig directory names, where $prefix is
-          the prefix where a library is installed.
+COMPILING BERKELEY DB
+---------------------
 
-	  For example, if you have GNOME installed in /usr and you
-          are installing Evolution and its dependencies in
-          /opt/evolution, you want to do something like the following
-          (assuming you are using Bash):
+If you don't have 3.1.17 installed on your system or Evolution doesn't
+detect it for some reason, here is a way to get Evolution to link to
+it without messing up your system installation.
 
-	      export PKG_CONFIG_PATH=/usr/lib/pkgconfig:/opt/evolution/lib/pkgconfig
+  * Get the Sleepycat tarball from:
 
-	* Edit the bonobo-activation-config.xml file (which is
-          normally found in /etc/bonobo-activation/) to include the
-          location where you are installing Evolution.
+      http://www.sleepycat.com/update/snapshot/db-3.1.17.tar.gz
 
-	  In the example given above (GNOME in /usr, Evolution and
-          dependencies in /opt/evolution), your
-          bonobo-activation-config.xml will have to look like this:
+  * Install the content somewhere _other_ than the evolution source tree.
+     e.g: NOT evolution/db-3.1.17
 
-	      <?xml version="1.0"?>
-	      <oafconfig>
-	        <searchpath>
-	          <item>/usr/lib/bonobo/servers</item>
-	          <item>/opt/evolution/lib/bonobo/servers</item>
-	        </searchpath>
-	      </oafconfig>
+  * Compile according to instructions, but installing into some custom
+    prefix, for example:
+
+      ../dist/configure --prefix=/home/user/berkeleydb-3.1.17
+
+  * Autogen Evolution specifying that it has to look for the DB
+    library there, for example:
+
+      ./autogen.sh --prefix=/opt/gnome
+      --with-db3-includes=/home/user/berkeleydb-3.1.17/include
+      --with-db3-libs=/home/user/berkeleydb-3.1.17/lib
 
-	* Pass an appropriate --prefix parameter to the configure
-          scripts of Evolution and its dependencies, eg:
 
-	      ./configure --prefix=/opt/evolution
+COMPILING PALM PILOT SUPPORT
+----------------------------
 
-More information on how to use the configure script is available in
-the INSTALL file which is part of the Evolution tarball.
+If you want support for PalmPilot syncing you will also need recent
+versions of:
 
+1) pilot-link 
+http://www.pilot-link.org
 
-OPTIONAL FEATURES
------------------
+2) gnome-pilot
+http://www.eskil.org/gnome-pilot/
 
-Some optional features can be enabled at compilation time by passing
-appropriate flags to the configure script:
+3) evolution
+In your evolution source directory do ./autogen.sh --prefix=<evo-prefix> 
+--with-pisock=<pilot-link-prefix> --enable-pilot-conduits=yes
+make
+make install
 
-	* GNOME Pilot support.
 
-	  Assuming you have installed gnome-pilot, add the following
-	  options:
+SSL SUPPORT
+-----------
 
-	    --with-pisock=<prefix> --enable-pilot-conduits=yes
+If you want SSL support (and someday S/MIME), you will also need
+mozilla-nspr and mozilla-nss, which can be found at
+http://www.mozilla.org.
 
-	  Where <prefix> is the location where pilot-link (a package
-	  that gnome-pilot depends on) was installed.
+Once you have those libraries (and their respective includes)
+installed, in your evolution source directory do:
 
-	* SSL support.
+./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>
 
-	  Make sure you have Mozilla's NSS nad NSPR libraries
-	  installed and pass the following flag:
 
-	    --enable-nss
+NEWSGROUP (NNTP) SUPPORT
+------------------------
 
+Experimental support for NNTP is enabled if you use the --enable-nntp
+configure option, but it's currently unmaintained and highly unstable
+and experimental.