make release day a little easier
[claws.git] / INSTALL
blob5290407d3e16fa9d283c0b6e881349e1823055a7
1 Installation
2 ============
4 This program requires GTK+ 2.10.0 or higher to be compiled.
6 Build it
7 ========
9 Please make sure that gtk-devel and glib-devel (or similar) packages are
10 installed before the compilation (you may also require flex (lex) and bison
11 (yacc)).
13 To compile and install, just type:
15 % ./configure
16 % make
17 % su
18 Password: [Enter password]
19 # make install
21 To run, just type:
23 % claws-mail
25 Additional libraries
26 ====================
27 only needed if you require the additional functionality
29 Bogofilter
30     for Bogofilter plugin support
31     http://bogofilter.sourceforge.net/
32 compface
33     for X-Face support
34     http://freshmeat.net/projects/compface/
35 D-Bus
36     for interprocess communication support
37     http://www.freedesktop.org/wiki/Software/dbus
38 Dillo (>= 0.7.0)
39     for Dillo HTML viewer plugin support
40     http://www.dillo.org/
41 Enchant (and dictionaries)
42     for spell-checker support
43     http://www.abisource.com/enchant/
44 GnuPG (>= 1.2.1) and GPGME (>=  0.4.5)
45     for GnuPG and S/MIME plugin support
46     http://www.gnupg.org/
47     ftp://ftp.gnupg.org/gcrypt/gpgme/
48 J-Pilot
49     for J-Pilot support
50     http://www.jpilot.org/
51 libEtPan! (>= 0.57)
52     for IMAP4 and NNTP support
53     http://www.etpan.org
54 Network Manager
55     for support for detection of network connection changes
56     http://www.gnome.org/projects/NetworkManager/
57 OpenLDAP (>= 2.0.7)
58     for LDAP support
59     http://www.openldap.org/
60 GnuTLS (>= 0.4.2)
61     for SSL support
62     http://www.gnu.org/software/gnutls/
63 SpamAssassin
64     for SpamAssassin plugin support
65     http://spamassassin.apache.org/
67 Options for configure script
68 ============================
69 Most options are automatically enabled if the dependencies
70 are matched.
72   --with-config-dir=RCDIR           local config dir (default: ~/.claws-mail)
73   --disable-compface                disable compface (X-Face) support
74   --disable-ipv6                    disable IPv6 support
75   --disable-gnutls                  disable GnuTLS support
76   --disable-libetpan                disable IMAP4 and NNTP support
77   --disable-gnomeprint              disable libgnomeprint support
78   --disable-enchant                 disable Enchant support
79   --disable-ldap                    disable LDAP support
80   --disable-jpilot                  disable JPilot support
81   --disable-startup-notification    disable startup notification support
82   --disable-valgrind                disable valgrind support for debugging
83  --enable-crash-dialog              enable crash dialog
84   --disable-startup-notification    disable startup notification support
85   --disable-trayicon-plugin         do not build System Tray Icon plugin
86   --disable-spamassassin-plugin     do not build SpamAssassin plugin
87   --disable-pgpcore-plugin          do not build PGP/Core plugin
88   --disable-pgpmime-plugin          do not build PGP/MIME plugin
89   --disable-pgpinline-plugin        do not build PGP/Inline plugin
90   --disable-smime-plugin            do not build S/Mime plugin
91   --disable-dillo-viewer-plugin     do not build Dillo plugin
92   --disable-bogofilter-plugin       do not build bogofilter plugin
93   --disable-manual                  do not build user manuals
94   --disable-nls                     do not use Native Language Support
96 For other options, refer to ./configure --help .