]> Pileus Git - ~andy/fetchmail/blobdiff - INSTALL
Mimedecode now defaults to "off".
[~andy/fetchmail] / INSTALL
diff --git a/INSTALL b/INSTALL
index edf7d2449880bc71b93a54d35e9cc25e0d5995db..2d9809951e7805fcb65da5d9acf1e03d8d5432f0 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -13,16 +13,24 @@ running fetchmail.
 1. USEFUL THINGS TO INSTALL FIRST
 
 If you want support for RFC1938-compliant one-time passwords, you'll
-need to install Craig Metz's OPIE libraries first.  Then configure
-with --enable-OPIE, and fetchmail build process will detect them and
-compile appropriately.
+need to install Craig Metz's OPIE libraries first and *make sure
+they're on the normal library path* where configure will find them.  Then
+configure with --enable-OPIE, and fetchmail build process will detect
+them and compile appropriately.
 
 Note: there is no point in doing this unless your server is
 OTP-enabled.  To test this, telnet to the server port and give it
 a valid USER id.  If the OK response includes the string "otp-",
-you should install OPIE.
+you should install OPIE.  You need version 2.32 or better.
 
 The OPIE library sources are available at ftp://ftp.inner.net/pub/opie.
+You can also find OPIE and IPV6-capable servers there.
+
+Building in IPv6 support or the IPsec patches REQUIRES that Craig
+Metz's inet6-apps kit be installed; the IPsec patches require that the
+kit be built with network security API support enabled. The kit can be
+gotten from ftp.ipv6.inner.net:/pub/ipv6 (via IPv6) or ftp.inner.net
+/pub/ipv6 (via IPv4).
 
 2. CONFIGURE
 
@@ -44,15 +52,15 @@ 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
 leaving it out cuts the executable's size slightly.
 
-Specifying --with-kerberos=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 specify this option with an argument it will look
-in DIR first. 
+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'.
 
-Unfortunately, there doesn't seem to be good standardization of where
-Kerberos lives.  If your configuration doesn't match one of the four
-that fetchmail's configure.in knows about, you may find you have to
-hand-hack the Makefile a bit.
+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
+locations (/usr, /usr/local).  If you set --with-GSSAPI=DIR
+you can direct the build to look for GSSAPI support under DIR.
 
 If you want to build for debugging, 
 
@@ -60,6 +68,31 @@ If you want to build for debugging,
 
 will do that.
 
+To enable multilingual support using GNU gettext, 
+
+       configure --enable-nls
+
+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
+specify this option with an argument it will look in DIR first.
+
+Unfortunately, there doesn't seem to be good standardization of where
+Kerberos lives.  If your configuration doesn't match one of the four
+that fetchmail's configure.in knows about, you may find you have to
+hand-hack the Makefile a bit.
+
+You may also want to hand-hack the Makefile if you're writing a custom
+or bleeding-edge resolver library.  In that case you will probably
+want to add -lresolv or whatever to the definition of LOADLIBS.
+
+It is also possible to explicitly condition out the support for
+POP3, IMAP, and ETRN (with configure arguments of --disable-POP3,
+--disable-IMAP, and --disable-ETRN respectively).  However, none
+of these wins back more that 3 to 4K on an Intel box.
+
 If you're running QNX, edit the distributed Makefile directly.  The
 QNX values for various macros are there but commented out; all you
 have to do is uncomment them.
@@ -75,7 +108,9 @@ Run
 
        make
 
-This should compile fetchmail for your system.
+This should compile fetchmail for your system.  If fetchmail fails to build
+properly, see the FAQ section B on build-time problems.  Note: parallelized
+make (e.g. make -j 4) fails due to some weirdness in the yacc productions.
 
 4. INSTALL
 
@@ -109,8 +144,9 @@ This software is known to work with the qpop/popper series of freeware
 POP3 servers; also with the IMAP2bis and IMAP4 servers that are
 distributed with Pine from the University of Washington; also with the
 Cyrus IMAP server from CMU.  This covers all the servers normally
-hosted on Linux and *BSD systems.  Note that this software does *not*
-work with Microsoft Exchange, because Microsoft Exchange is broken.
+hosted on Linux and *BSD systems.  It also works with Microsoft Exchange,
+despite the fact that Microsoft Exchange is extremely broken (returns
+incorrect message lengths in LIST responses).
 
 7. REPORTING BUGS