Note Earl's regression fix for SSL_CTX_clear_options() on older OpenSSL.

[~andy/fetchmail] / INSTALL

diff --git a/INSTALL b/INSTALL
index 6070ab4a8ebb0e31d56f62e9a61dacb38320050c..a0b7520420def7e0cf14f1164f75a5883940e205 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,19 +1,40 @@
 INSTALL Instructions for fetchmail
 ==================================
 
-If you are installing from the subversion repository, see README.svn for
-further instructions on how to set up the checked out repository.
+Building from Git repository: see README.git
+
+Packagers and port/emerge maintainers: see README.packaging.
+
 
 If you have installed binaries (e.g. from a Linux RPM or DPKG, Solaris
-package or FreeBSD port), you can skip to step 5.
+package or FreeBSD port), you can skip to step 5 below.
 
+---------------------------------------------------------------------
 The Frequently Asked Questions list, included as the file FAQ in this
-distributions, answers the most common questions about configuring and
+distribution, answers the most common questions about configuring and
 running fetchmail.
+---------------------------------------------------------------------
+
 
-1. USEFUL THINGS TO INSTALL FIRST
+1. PREPARATIONS: USEFUL THINGS TO INSTALL FIRST
 
-1.1 OTP/OPIE
+1.1 OpenSSL
+
+If you are installing OpenSSL yourself, it is recommended that you build
+shared OpenSSL libraries, it works better and updating OpenSSL does not
+then require you to reinstall all applications that use OpenSSL.
+
+Try after unpacking OpenSSL:
+
+       ./config shared && make && make test && make install
+
+1.2 gettext (internationalization)
+
+Internationalization of fetchmail requires GNU gettext (libintl and
+libiconv). Fetchmail, as of version 6.3.0, no longer ships its own
+libintl copy.  Note that some systems include gettext in their libc.
+
+1.3 OTP/OPIE
 
 If you want support for RFC1938-compliant one-time passwords, you'll
 need to install Craig Metz's OPIE libraries first and *make sure
@@ -29,22 +50,6 @@ you should install OPIE.  You need version 2.32 or better.
 The OPIE library sources are available at http://www.inner.net/pub/opie/
 You can also find OPIE and IPV6-capable servers there.
 
-1.2 OpenSSL
-
-If you are installing OpenSSL yourself, it is recommended that you build
-shared OpenSSL libraries, it works better and updating OpenSSL does not
-then require you to reinstall all applications that use OpenSSL.
-
-Try after unpacking OpenSSL:
-
-       ./config shared && make && make test && make install
-
-1.3 gettext (internationalization)
-
-Internationalization of fetchmail requires GNU gettext (libintl and
-libiconv). Fetchmail, as of version 6.3.0, no longer ships its own
-libintl copy.
-
 1.4 IPv6
 
 Building in IPv6 support *requires* an up-to-date operating system.
@@ -61,6 +66,11 @@ configure option '--with-included-gettext'.
 
 Installing fetchmail is easy.  From within this directory, type:
 
+       ./configure --with-ssl
+
+if you have OpenSSL (and its developer packages, if separate) installed
+on your system, or if you don't or do not need SSL/TLS support:
+
        ./configure
 
 The autoconfiguration script will spend a bit of time figuring out the
@@ -82,7 +92,7 @@ APOP) is available but also not included in the standard build.  You
 can compile it in with 'configure --enable-RPA'.
 
 Support for Microsoft's NTLM authentication method is also available
-but also not included in the standard build.  You can compile it in
+but not included in the standard build either.  You can compile it in
 with 'configure --enable-NTLM'.
 
 Support for authentication using RFC1731 GSSAPI is available
@@ -102,16 +112,6 @@ directory that contains OpenSSL's "include" subdirectory), for instance:
 "--with-ssl=/example/path" would assume that you have an
 /example/path/include/openssl/ssl.h header file.
 
-To specify a fallback MUA in case local port 25 doesn't respond, this is
-not recommended, because you'll usually see differences between MTA and
-MDA use. If you wish to proceed nonetheless, do one of:
-
-       configure --enable-fallback=procmail
-       configure --enable-fallback=sendmail
-
-A disadvantage of using procmail is that local alias expansion
-according to /etc/aliases won't get done if we fall back to it.
-
 2.2 Advanced options
 
 Specifying --with-kerberos=DIR or --with-kerberos5=DIR will tell the