More simplification
[claws.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 8d18fd1..8660d23 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,80 +1,16 @@
 Installation
 ============
 
-This program requires GTK+ 1.2.6 or higher to be compiled.
+This program requires GTK+ 2.16 or higher to be compiled.
 
-This program is developed on Debian GNU/Linux (woody)
-(Linux 2.2.x + glibc 2.2), so it is possible not to work correctly
-on the other environment.
+Build it
+========
 
-It is confirmed to work on the following environments:
+If you're using a package-based system, please make sure that gtk-devel
+and glib-devel (or similar) packages are installed before the compilation
+(you may also require flex (lex) and bison (yacc)).
 
-o Debian GNU/Linux (woody/sid) (glibc 2.2)
-o Kondara MNU/Linux (glibc 2.1.x)
-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
-o Laser5 Linux 6.0 (glibc 2.1.x)
-o Laser5 Linux 6.2 (glibc 2.1.x)
-o Laser5 Linux 6.4 (glibc 2.1.x)
-o TurboLinux 4.0 (glibc 2.0.7 + libwcsmbs)
-o TurboLinux 6.0 (glibc 2.1.2)
-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
-o RedHat Linux 7.1
-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 Linux MLD4
-o Linux MLD5
-o Plamo Linux 2.0
-o Slackware 7.1
-o Linux Mandrake 7.0
-o Linux Mandrake 7.1
-o Linux Mandrake 7.2
-o Linux Mandrake 8.0
-o SuSE Linux 6.3 (glibc 2.1.2)
-o SuSE Linux 6.4
-o SuSE Linux 7.0
-o SuSE Linux 7.1
-o OpenLinux 2.3 (glibc 2.1.1 -> 2.1.3)
-o Caldera OpenDesktop 2.4
-o Conectiva Linux 4.0
-o Conectiva Linux 5.0
-o Vector Linux 1.5
-o FreeBSD 3.2-RELEASE
-o FreeBSD 3.4-RELEASE
-o FreeBSD 4.0-RELEASE
-o FreeBSD 4.1-RELEASE
-o FreeBSD 4.2-RELEASE
-o FreeBSD 5.0-CURRENT
-o NetBSD 1.4.2
-o NetBSD 1.5 + XPG4DL
-o OpenBSD 2.7
-o OpenBSD 2.8 (i386)
-o OpenBSD 2.9
-o BSD/OS 4.0.1
-o Solaris 2.5
-o Solaris 2.5.2
-o Solaris 2.6
-o Solaris 7
-o Solaris 8
-o IRIX 6.3
-o IRIX 6.5 6.5.8m
-o HP-UX 10.20
-o Tru64 Unix 5.0 (OSF1 V5.0)
-o Mac OS X (Darwin 1.3) + Xtools (has locale problem)
-o Windows (cygwin + GTK+ for win32) (unstable)
-
-For installation, just type:
+To compile and install, just type:
 
 % ./configure
 % make
@@ -82,27 +18,136 @@ For installation, just type:
 Password: [Enter password]
 # make install
 
-I recommend you to install gdk-pixbuf or gdk_imlib library before installing
-for built-in image view support, and libcompface for X-Face support.
-
-
-If you want to enable IPv6 support, append the option
---enable-ipv6 after ./configure.
-
-If you want to enable GnuPG support, you need GPGME 0.2.1 or later, and
-GnuPG 1.0.4f or later. You can get them from the following location:
-
-  ftp://ftp.gnupg.org/pub/gcrypt/alpha/gpgme/
-  ftp://ftp.gnupg.org/pub/gcrypt/devel/
-
-and append the option --enable-gpgme after ./configure.
-
-WARNING: the GnuPG support is still in the development stage, and it
-         may not work correctly. I suggest never to use a real key.
-         Please use sample keys.
-
+To run, just type:
+
+% claws-mail
+
+Additional libraries or programs
+================================
+only needed if you require the additional functionality
+
+Bogofilter
+    for Bogofilter plugin support
+    http://bogofilter.sourceforge.net/
+Bsfilter
+    for Bsfilter plugin support
+    http://sourceforge.jp/projects/bsfilter/
+Canberra (>= 0.6)
+    for some sound features of Notification plugin
+    http://0pointer.de/lennart/projects/libcanberra/
+compface
+    for X-Face support
+    http://freshmeat.net/projects/compface/
+Clam AntiVirus daemon
+    for Clamd plugin support
+    http://www.clamav.net/
+D-Bus (>= 0.60)
+    for interprocess communication support
+    http://www.freedesktop.org/wiki/Software/dbus
+Enchant (and dictionaries) (>= 1.0.0)
+    for spell-checker support
+    http://www.abisource.com/enchant/
+GData (>= 0.6.4)
+    for GData plugin support
+    https://live.gnome.org/libgdata/
+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/
+GnuTLS (>= 0.4.2)
+    for SSL support
+    http://www.gnu.org/software/gnutls/
+GTK+ WebKit (>= 1.0)
+    for Fancy plugin support
+    http://trac.webkit.org/wiki/WebKitGTK/
+Gs tool
+    for PostScript feature of PDF Viewer plugin
+    http://pages.cs.wisc.edu/~ghost/
+Indicate (>= 0.3.0)
+    for indicator feature of Notification plugin
+    https://launchpad.net/libindicator/
+J-Pilot
+    for J-Pilot support
+    http://www.jpilot.org/
+LCDproc daemon
+    for lcdproc feature of Notification plugin
+    http://www.lcdproc.org
+libEtPan! (>= 0.57)
+    for IMAP4, NNTP and Mailmbox plugin support
+    http://www.etpan.org
+Network Manager (>= 0.6.2)
+    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/
+Perl (>= 5.8.0)
+    for perl plugin support
+    http://www.perl.org/
+Poppler (>= 0.4.2)
+    for PDF Viewer plugin support
+    http://poppler.freedesktop.org/       
+GnuTLS (>= 0.4.2)
+    for SSL support
+    http://www.gnu.org/software/gnutls/
+PyGTK (>= 2.10.3) 
+    for Python plugin support
+    http://www.pygtk.org/
+Python
+    for Python plugin support
+    http://python.org/
+SpamAssassin
+    for SpamAssassin plugin support
+    http://spamassassin.apache.org/
+Options for configure script
+============================
+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-bogofilter-plugin       do not build Bogofilter plugin
+  --disable-address_keeper-plugin   do not build Address Keeper plugin
+  --disable-archive-plugin          do not build Archive plugin
+  --disable-att_remover-plugin      do not build Att Remover plugin
+  --disable-attachwarner-plugin     do not build Attachwarner plugin
+  --disable-bsfilter-plugin         do not build BSfilter plugin
+  --disable-clamd-plugin            do not build Clamd plugin
+  --disable-fancy-plugin            do not build Fancy plugin
+  --disable-fetchinfo-plugin        do not build Fetchinfo plugin
+  --disable-gdata-plugin            do not build GData plugin
+  --disable-mailmbox-plugin         do not build MailMbox plugin
+  --disable-newmail-plugin          do not build NewMail plugin
+  --disable-notification-plugin     do not build Notification plugin
+  --disable-pdf_viewer-plugin       do not build PDF Viewer plugin
+  --disable-perl-plugin             do not build Perl plugin
+  --disable-python-plugin           do not build Python plugin
+  --disable-rssyl-plugin            do not build RSSyl plugin
+  --disable-spamassassin-plugin     do not build SpamAssassin plugin
+  --disable-spam_report-plugin      do not build Spam Report plugin
+  --disable-tnef_parse-plugin       do not build TNEF Parse plugin
+  --disable-vcalendar-plugin        do not build vCalendar 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 all needed libraries are
-correctly installed. If it still failed, please send bug report to:
 
-  Hiroyuki Yamamoto <hiro-y@kcn.ne.jp>