Updated Traditional Chinese translation.
[evolution.git] / README
blob42f9923fea41f3092d1025fdf25ca9f92abe49c0
1 Evolution is the integrated mail, calendar and address book suite from
2 the Evolution Team.
4 See http://www.gnome.org/projects/evolution for more information.
6 If you are using Evolution, you may wish to subscribe to the Evolution
7 users mailing list.  If you are interested in contributing to
8 development on it, you should certainly subscribe to the Evolution
9 Hackers mailing list.  Visit
11         http://lists.ximian.com
13 to subscribe or view archives of the Ximian mailing lists.
15 If you are planning to work on any part of Evolution, please send mail
16 to the mailing list first, to avoid duplicated effort (and to make
17 sure that you aren't basing your work on interfaces that are expected
18 to change).
20 There is also a #evolution IRC channel on irc.gnome.org.
22 Help for Evolution is available in the user manual (select "Help" from
23 the menu after running the application), at the Novell knowledge base
24 (http://support.novell.com), in the Evolution man page (run "man
25 evolution" at the command line), and in the --help strings (run
26 "evolution --help" at the command line).
28 The rest of this file is dedicated to building Evolution.
31 DEPENDENCIES
32 ------------
34 In order to build Evolution you need to have the full set of GNOME 2.6
35 (or greater) development libraries installed.
37 GNOME 2.6 or greater comes with most of the modern distributions, so
38 in most cases it should be enough to just install all the devel
39 packages from your distribution.
41 Please make sure you have the most recent versions of the libraries
42 installed, since bugs in the libraries can cause bugs in Evolution.
44 Additional dependencies, besides the stock GNOME libraries (the
45 dependencies should be compiled in the order they are listed here):
47         * gnome-icon-theme 1.2.0 or later
49         * ORBit 2.9.8 or later
51              ftp://ftp.gnome.org/pub/gnome/sources/libsoup
52         
53         * libsoup 2.2.1 or later
55              ftp://ftp.gnome.org/pub/gnome/sources/libsoup
57         * evolution-data-server 1.1.1 or later
59              ftp://ftp.gnome.org/pub/gnome/sources/evolution-data-server
61         * gtkhtml 3.5.0 or later
63              ftp://ftp.gnome.org/pub/gnome/sources/gtkhtml
65         * gal 2.4.0 or later
67              ftp://ftp.gnome.org/pub/gnome/sources/gal
69         * [Optional] Mozilla NSPR/NSS libraries
71           These are needed if you want to compile Evolution with SSL and S/MIME
72           support.
74              http://www.mozilla.org/
76           Many distributions ship these as Mozilla development
77           packages.
79         * [Optional] gnome-pilot 2.0 or later
81           This is only necessary if you want to be able to synchronize
82           your Palm device with Evolution.
84              ftp://ftp.gnome.org/pub/gnome/sources/gnome-pilot
85              ftp://ftp.gnome.org/pub/gnome/sources/gnome-pilot-conduits
87         * [Optional] gnome-spell 1.0.1 or later
89           This is only necessary if you want to have the spell
90           checking functionality in Evolution's message composer.
92              ftp://ftp.gnome.org/pub/gnome/sources/gnome-spell
94 CONFIGURING EVOLUTION
95 ---------------------
97 First you have to decide whether you want to install Evolution (and
98 its dependencies) into the same prefix as the rest of your GNOME
99 install, or into a new prefix.
101 Installing everything into the same prefix as the rest of your GNOME
102 install will make it much easier to build and run programs, and easier
103 to switch between using packages and building it yourself, but it may
104 also make it harder to uninstall later.  Also, it increases the chance
105 that something goes wrong and your GNOME installation gets ruined.
107 If you want to install in a different prefix, you need to do the
108 following things:
110         * Set the PKG_CONFIG_PATH environment variable to contain a
111           colon-separated list of all the pkg-config directories that
112           will be involved in the build.  This basically means a list
113           of $prefix/lib/pkgconfig directory names, where $prefix is
114           the prefix where a library is installed.
116           For example, if you have GNOME installed in /usr and you
117           are installing Evolution and its dependencies in
118           /opt/evolution, you want to do something like the following
119           (assuming you are using Bash):
121               export PKG_CONFIG_PATH=/usr/lib/pkgconfig:/opt/evolution/lib/pkgconfig
123         * Edit the bonobo-activation-config.xml file (which is
124           normally found in /etc/bonobo-activation/) to include the
125           location where you are installing Evolution.
127           In the example given above (GNOME in /usr, Evolution and
128           dependencies in /opt/evolution), your
129           bonobo-activation-config.xml will have to look like this:
131               <?xml version="1.0"?>
132               <oafconfig>
133                 <searchpath>
134                   <item>/usr/lib/bonobo/servers</item>
135                   <item>/opt/evolution/lib/bonobo/servers</item>
136                 </searchpath>
137               </oafconfig>
139         * Pass an appropriate --prefix parameter to the configure
140           scripts of Evolution and its dependencies, eg:
142               ./configure --prefix=/opt/evolution
144 More information on how to use the configure script is available in
145 the INSTALL file which is part of the Evolution tarball.
148 OPTIONAL FEATURES
149 -----------------
151 Some optional features can be enabled at compilation time by passing
152 appropriate flags to the configure script:
154         * GNOME Pilot support.
156           Assuming you have installed gnome-pilot, add the following
157           options:
159             --with-pisock=<prefix> --enable-pilot-conduits=yes
161           Where <prefix> is the location where pilot-link (a package
162           that gnome-pilot depends on) was installed.
164         * SSL support.
166           Make sure you have Mozilla's NSS nad NSPR libraries
167           installed and pass the following flag:
169             --enable-nss