INSTALL Instructions for fetchmail
==================================
+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. PREPARATIONS: USEFUL THINGS TO INSTALL FIRST
+
+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. USEFUL THINGS TO INSTALL FIRST
+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
The OPIE library sources are available at http://www.inner.net/pub/opie/
You can also find OPIE and IPV6-capable servers there.
+1.4 IPv6
+
Building in IPv6 support *requires* an up-to-date operating system.
Recent Linux versions with glibc 2.1.1 or newer, FreeBSD, Solaris should
be fine.
-The IPsec code *requires* the inet6-apps kit, which used to be available
-from ftp.ipv6.inner.net:/pub/ipv6 (via IPv6) or ftp.inner.net /pub/ipv6
-(via IPv4), but the software has been withdrawn, so we're sorry, no
-advanced IPsec support at this time.
-
If you have trouble with intl or gettext functions, try using the
-configure option `--with-included-gettext'.
+configure option '--with-included-gettext'.
2. CONFIGURE
+2.1 Basic options
+
Installing fetchmail is easy. From within this directory, type:
- ./configure
+ ./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:
-(If your gettext is old, you may need to include the
---with-included-gettext option).
+ ./configure
The autoconfiguration script will spend a bit of time figuring out the
specifics of your system. If you want to specify a particular compiler
The configure script accepts certain standard configuration options.
These include --prefix, --exec-prefix, --bindir, --infodir, --mandir,
-and --srcdir. Do `configure --help' for more.
+and --srcdir. Do 'configure --help' for more.
POP2 support is no longer compiled in by default, as POP2 is way obsolete
and there don't seem to be any live servers for it anymore. You can
-configure it back in if you want with `configure --enable-POP2', but
+configure it back in if you want with 'configure --enable-POP2', but
leaving it out cuts the executable's size slightly.
Support for CompuServe's RPA authentication method (rather similar to
APOP) is available but also not included in the standard build. You
-can compile it in with `configure --enable-RPA'.
+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
-with `configure --enable-NTLM'.
+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
but also not included by default. You can compile it in with
-`configure --with-gssapi', which looks for GSSAPI support in standard
+'configure --with-gssapi', which looks for GSSAPI support in standard
locations (/usr, /usr/local). If you set --with-GSSAPI=DIR
you can direct the build to look for GSSAPI support under DIR.
Hooks for the OpenSSL library (see http://www.openssl.org/) are
included in the distribution. To enable these, configure with
---with-ssl; they are not included in the standard build.
-
-If you want to build for debugging,
-
- CFLAGS=-g LDFLAGS=" " ./configure
-
-will do that.
-
-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
+--with-ssl; they are not included in the standard build. Fetchmail's
+configure script will probe some default locations for the
+include/openssl/ssl.h file. If this doesn't work (i. e. configure prints
+"SSL support enabled, but OpenSSL not found" and aborts), you need to
+give the explicit prefix of your OpenSSL installation (specify the
+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.
-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
-Advanced configuration:
------------------------
Specifying --with-kerberos=DIR or --with-kerberos5=DIR will tell the
fetchmail build process to look in DIR for Kerberos support.
Configure normally looks in /usr/kerberos and /usr/athena; if you
--disable-IMAP, and --disable-ETRN respectively).
-3. MAKE
+3. BUILD
Run