2012-05-16 [paul] 3.8.0cvs43
[claws.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 0003ca4..5290407 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,89 +1,7 @@
 Installation
 ============
 
-This program requires GTK+ 1.2.6 or higher to be compiled.
-
-This program is developed on Debian GNU/Linux (woody/sid)
-(Linux 2.4.x + glibc 2.2), so it is possible not to work correctly
-on the other environment.
-
-It is confirmed to work on the following environments:
-
-Linux
-
-o Debian GNU/Linux unstable (sid) (glibc 2.3.x)
-o Debian GNU/Linux 3.0 (woody) (glibc 2.2.5)
-o Debian GNU/Linux 2.2 (potato) (glibc 2.1.3)
-o Kondara MNU/Linux (glibc 2.1.x)
-o Kondara MNU/Linux 1.2
-o Kondara MNU/Linux 2.0
-o Vine Linux 1.1 (glibc 2.0.x + libwcsmbs)
-o Vine Linux 2.0 (glibc 2.1.x) (Intel, PPC)
-o Vine Linux 2.1 / 2.1.5 / 2.5 / 2.6
-o Laser5 Linux 6.0 / 6.2 / 6.4 (glibc 2.1.x)
-o TurboLinux 4.0 (glibc 2.0.7 + libwcsmbs)
-o TurboLinux 6.0 (glibc 2.1.2)
-o TurboLinux 7.0 (glibc 2.2.x)
-o Miracle Linux Standard Edition Version1.0
-o Miracle Linux for PostgreSQL Version1.0
-o Miracle Linux for Samba Version1.0
-o RedHat Linux 5.2 (glibc 2.0.7)
-o RedHat Linux 6.0
-o RedHat Linux 6.1 + Helix GNOME (glibc 2.1.x)
-o RedHat Linux 6.2 / 6.2J (glibc 2.1.x)
-o RedHat Linux 7.0 / 7.0J / 7.1 / 7.2 / 7.3
-o LinuxPPC2000 + Yukikaze(Japanization kit)
-o Linux2000G (Intel / PPC)
-o HOLON Linux 2.0 (Intel / PPC)
-o Linux for PPC Japanese Edition 2.0 (glibc 2.1.x)
-o Linux for PPC Japanese Edition 3.0 (glibc 2.1.x)
-o LinuxPPC Q4 2000 (glibc 2.1.x)
-o Linux MLD4
-o Linux MLD5
-o Plamo Linux 2.0 / 2.1 / 2.2.x / 3.0
-o Slackware 7.0 / 7.1 / 8.0 / 8.1
-o Linux Mandrake 7.0 / 7.1 / 7.2 / 8.0 / 8.1 / 9.0
-o SuSE Linux 6.3 (glibc 2.1.2)
-o SuSE Linux 6.4
-o SuSE Linux 7.0 / 7.1 / 7.2 / 7.3
-o OpenLinux 2.3 (glibc 2.1.1 -> 2.1.3)
-o Caldera OpenDesktop 2.4
-o Caldera Workstation 3.1
-o Conectiva Linux 4.0 / 5.0 / 7.0 / 8.0
-o Vector Linux 1.5
-o Yellow Dog Linux 2.0 (glibc 2.2.1)
-o Yellow Dog Linux 2.1 (PowerPC)
-o ASP Linux 7.2 (glibc 2.2.4)
-o Redmond Linux (Lycoris)
-o Gentoo Linux 1.x
-
-BSD
-
-o FreeBSD 3.2-RELEASE
-o FreeBSD 3.4-RELEASE
-o FreeBSD 4.0/4.1/4.2/4.3/4.4/4.5/4.6-RELEASE
-o FreeBSD 5.0-CURRENT
-o NetBSD 1.4.2
-o NetBSD 1.5 + XPG4DL
-o NetBSD 1.5.1 / 1.5.2
-o OpenBSD 2.7
-o OpenBSD 2.8 (i386)
-o OpenBSD 2.9 / 3.0 / 3.1
-o BSD/OS 4.0.1
-
-Other commercial Unix
-
-o Solaris 2.5 / 2.5.1 / 2.6
-o Solaris 7 / 8 / 9
-o IRIX 6.3 / 6.4 / 6.5 6.5.8m
-o HP-UX 10.20 / 11.0 / 11i
-o Tru64 Unix 5.0 (OSF1 V5.0)
-o SCO UnixWare 7
-o Mac OS X 10.1.4 (Darwin 5.4) + XDarwin (without XLocale support) + libxpg4
-
-Others
-
-o Windows (MSVC + GTK+ for win32) (in progress)
+This program requires GTK+ 2.10.0 or higher to be compiled.
 
 Build it
 ========
@@ -100,46 +18,81 @@ To compile and install, just type:
 Password: [Enter password]
 # make install
 
-Additional libraries
-====================
-
-It is recommend to install gdk-pixbuf or gdk_imlib library before installing
-Sylpheed for built-in image view support, and compface library for X-Face
-support.
-
-You can get compface utilities and library from the following location:
-
-  http://freshmeat.net/projects/compface/
-
-Sylpheed supports US-ASCII, ISO-8859-1, and EUC-JP by default.
-If you want other character set / encoding (such as UTF-8, KOI8-R, and GB2312)
-to be supported, you have to install libjconv, which is a wrapper for
-iconv(). You can obtain it from the following location:
+To run, just type:
 
-  http://ghost.math.sci.hokudai.ac.jp/misc/libjconv/
+% claws-mail
 
-GnuPG (>= 1.0.7) and GPGME (>= 0.3.10) are required for GnuPG (PGP) support.
-You can get GnuPG and GPGME from the following location:
-
-  ftp://ftp.gnupg.org/pub/gcrypt/alpha/gpgme/
-  ftp://ftp.gnupg.org/pub/gcrypt/gnupg/
+Additional libraries
+====================
+only needed if you require the additional functionality
+
+Bogofilter
+    for Bogofilter plugin support
+    http://bogofilter.sourceforge.net/
+compface
+    for X-Face support
+    http://freshmeat.net/projects/compface/
+D-Bus
+    for interprocess communication support
+    http://www.freedesktop.org/wiki/Software/dbus
+Dillo (>= 0.7.0)
+    for Dillo HTML viewer plugin support
+    http://www.dillo.org/
+Enchant (and dictionaries)
+    for spell-checker support
+    http://www.abisource.com/enchant/
+GnuPG (>= 1.2.1) and GPGME (>=  0.4.5)
+    for GnuPG and S/MIME plugin support
+    http://www.gnupg.org/
+    ftp://ftp.gnupg.org/gcrypt/gpgme/
+J-Pilot
+    for J-Pilot support
+    http://www.jpilot.org/
+libEtPan! (>= 0.57)
+    for IMAP4 and NNTP support
+    http://www.etpan.org
+Network Manager
+    for support for detection of network connection changes
+    http://www.gnome.org/projects/NetworkManager/
+OpenLDAP (>= 2.0.7)
+    for LDAP support
+    http://www.openldap.org/
+GnuTLS (>= 0.4.2)
+    for SSL support
+    http://www.gnu.org/software/gnutls/
+SpamAssassin
+    for SpamAssassin plugin support
+    http://spamassassin.apache.org/
 
 Options for configure script
 ============================
-
-  --disable-compface  disable compface (X-Face) support
-  --disable-jconv     disable libjconv support
-  --enable-openssl    SSL support (requires OpenSSL)
-  --enable-ipv6       IPv6 support
-  --enable-gpgme      GnuPG support (requires GPGME and GnuPG)
-  --enable-ldap       LDAP support
-  --enable-jpilot     JPilot support
+Most options are automatically enabled if the dependencies
+are matched.
+
+  --with-config-dir=RCDIR                  local config dir (default: ~/.claws-mail)
+  --disable-compface               disable compface (X-Face) support
+  --disable-ipv6                   disable IPv6 support
+  --disable-gnutls                 disable GnuTLS support
+  --disable-libetpan               disable IMAP4 and NNTP support
+  --disable-gnomeprint             disable libgnomeprint support
+  --disable-enchant                disable Enchant support
+  --disable-ldap                           disable LDAP support
+  --disable-jpilot                         disable JPilot support
+  --disable-startup-notification    disable startup notification support
+  --disable-valgrind                disable valgrind support for debugging
+ --enable-crash-dialog             enable crash dialog
+  --disable-startup-notification    disable startup notification support
+  --disable-trayicon-plugin         do not build System Tray Icon plugin
+  --disable-spamassassin-plugin     do not build SpamAssassin plugin
+  --disable-pgpcore-plugin         do not build PGP/Core plugin
+  --disable-pgpmime-plugin          do not build PGP/MIME plugin
+  --disable-pgpinline-plugin        do not build PGP/Inline plugin
+  --disable-smime-plugin            do not build S/Mime plugin
+  --disable-dillo-viewer-plugin     do not build Dillo plugin
+  --disable-bogofilter-plugin       do not build bogofilter plugin
+  --disable-manual                 do not build user manuals
+  --disable-nls                    do not use Native Language Support
 
 For other options, refer to ./configure --help .
 
 
-If the installation of Sylpheed failed, check whether all the required
-libraries are correctly installed. If it still failed, please send bug
-report to:
-
-  Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>