Pileus Git - ~andy/fetchmail/blob - INSTALL

   1 INSTALL Instructions for fetchmail
   2 ==================================
   3
   4 If you have installed binaries (e.g. from a Linux RPM or DPKG, Solaris
   5 package or FreeBSD port), you can skip to step 5.
   6
   7 The Frequently Asked Questions list, included as the file FAQ in this
   8 distributions, answers the most common questions about configuring and
   9 running fetchmail.
  10
  11 1. USEFUL THINGS TO INSTALL FIRST
  12
  13 If you want support for RFC1938-compliant one-time passwords, you'll
  14 need to install Craig Metz's OPIE libraries first and *make sure
  15 they're on the normal library path* where configure will find them.  Then
  16 configure with --enable-OPIE, and fetchmail build process will detect
  17 them and compile appropriately.
  18
  19 Note: there is no point in doing this unless your server is
  20 OTP-enabled.  To test this, telnet to the server port and give it
  21 a valid USER id.  If the OK response includes the string "otp-",
  22 you should install OPIE.  You need version 2.32 or better.
  23
  24 The OPIE library sources are available at http://www.inner.net/pub/opie/
  25 You can also find OPIE and IPV6-capable servers there.
  26
  27 Building in IPv6 support *requires* an up-to-date operating system.
  28 Recent Linux versions with glibc 2.1.1 or newer, FreeBSD, Solaris should
  29 be fine.
  30
  31 The IPsec code *requires* the inet6-apps kit, which used to be available
  32 from ftp.ipv6.inner.net:/pub/ipv6 (via IPv6) or ftp.inner.net /pub/ipv6
  33 (via IPv4), but the software has been withdrawn, so we're sorry, no
  34 advanced IPsec support at this time.
  35
  36 If you have trouble with intl or gettext functions, try using the
  37 configure option `--with-included-gettext'.
  38
  39
  40 2. CONFIGURE
  41
  42 Installing fetchmail is easy.  From within this directory, type:
  43
  44         ./configure
  45
  46 (If your gettext is old, you may need to include the
  47 --with-included-gettext option).
  48
  49 The autoconfiguration script will spend a bit of time figuring out the
  50 specifics of your system.  If you want to specify a particular compiler
  51 (e.g. you have gcc but want to compile with cc), set the environment
  52 variable CC before you run configure.
  53
  54 The configure script accepts certain standard configuration options.
  55 These include --prefix, --exec-prefix, --bindir, --infodir, --mandir,
  56 and --srcdir.  Do `configure --help' for more.
  57
  58 POP2 support is no longer compiled in by default, as POP2 is way obsolete
  59 and there don't seem to be any live servers for it anymore.  You can
  60 configure it back in if you want with `configure --enable-POP2', but
  61 leaving it out cuts the executable's size slightly.
  62
  63 Support for CompuServe's RPA authentication method (rather similar to
  64 APOP) is available but also not included in the standard build.  You
  65 can compile it in with `configure --enable-RPA'.
  66
  67 Support for Microsoft's NTLM authentication method is also available
  68 but also not included in the standard build.  You can compile it in
  69 with `configure --enable-NTLM'.
  70
  71 Support for authentication using RFC1731 GSSAPI is available
  72 but also not included by default.  You can compile it in with
  73 `configure --with-gssapi', which looks for GSSAPI support in standard
  74 locations (/usr, /usr/local).  If you set --with-GSSAPI=DIR
  75 you can direct the build to look for GSSAPI support under DIR.
  76
  77 Hooks for the OpenSSL library (see http://www.openssl.org/) are
  78 included in the distribution.  To enable these, configure with
  79 --with-ssl; they are not included in the standard build.
  80
  81 If you want to build for debugging,
  82
  83         CFLAGS=-g LDFLAGS=" " ./configure
  84
  85 will do that.
  86
  87 To specify a fallback MUA in case local port 25 doesn't respond, this is
  88 not recommended, because you'll usually see differences between MTA and
  89 MDA use. If you wish to proceed nonetheless, do one of:
  90
  91         configure --enable-fallback=procmail
  92         configure --enable-fallback=sendmail
  93
  94 A disadvantage of using procmail is that local alias expansion
  95 according to /etc/aliases won't get done if we fall back to it.
  96
  97 Advanced configuration:
  98 -----------------------
  99 Specifying --with-kerberos=DIR or --with-kerberos5=DIR will tell the
 100 fetchmail build process to look in DIR for Kerberos support.
 101 Configure normally looks in /usr/kerberos and /usr/athena; if you
 102 specify this option with an argument it will look in DIR first.
 103
 104 Unfortunately, there doesn't seem to be good standardization of where
 105 Kerberos lives.  If your configuration doesn't match one of the four
 106 that fetchmail's configure.in knows about, you may find you have to
 107 hand-hack the Makefile a bit.
 108
 109 You may also want to hand-hack the Makefile if you're writing a custom
 110 or bleeding-edge resolver library.  In that case you will probably
 111 want to add -lresolv or whatever to the definition of LOADLIBS.
 112
 113 It is also possible to explicitly condition out the support for
 114 POP3, IMAP, and ETRN (with configure arguments of --disable-POP3,
 115 --disable-IMAP, and --disable-ETRN respectively).
 116
 117
 118 3. MAKE
 119
 120 Run
 121
 122         make
 123
 124 This should compile fetchmail for your system.  If fetchmail fails to build
 125 properly, see the FAQ section B on build-time problems.
 126
 127
 128 4. INSTALL
 129
 130 Lastly, become root and run
 131
 132         make install
 133
 134 This will install fetchmail.  By default, fetchmail will be installed
 135 in /usr/local/bin, with the man page in /usr/local/man/man1.  You can
 136 use the configure options --bindir and --mandir to change these.
 137
 138 If you are tight on disk space, you can run instead
 139
 140         make install-strip
 141
 142 NOTE: If you are using an MTA other than sendmail (such as qmail,
 143 exim, or smail), see the FAQ (section T) for discussion of any special
 144 configuration steps that may be necessary.
 145
 146
 147 5. SET UP A RUN CONTROL FILE
 148
 149 See the man page for a description of how to configure your individual
 150 preferences.
 151
 152 If you're upgrading from popclient, see question F4 in the FAQ file.
 153
 154
 155 6. TEST
 156
 157 I strongly recommend that your first fetchmail run use the -v, -a and -k
 158 options, in case there is something not quite right with your server,
 159 your local delivery configuration or your port 25 listener.  Also,
 160 beware of aliases that direct your local mail back to the server host!
 161
 162 This software is known to work with the qpop/popper series of freeware
 163 POP3 servers; also with the IMAP2bis and IMAP4 servers that are
 164 distributed with Pine from the University of Washington; also with the
 165 Cyrus IMAP server from CMU.  This covers all the servers commonly
 166 hosted on Linux and *BSD systems.  It also works with the IMAP service
 167 of Microsoft Exchange, despite the fact that Microsoft Exchange is
 168 extremely broken (returns incorrect message lengths in LIST
 169 responses).
 170
 171 See the FAQ, section S, for detailed advice on running with various
 172 servers.
 173
 174
 175 7. REPORTING BUGS
 176
 177 You should read the FAQ file question G3 before reporting a bug.
 178
 179
 180 8. USE IT
 181
 182 Once you've verified your configuration, you can start fetchmail to
 183 run in background and forget about it.  Enjoy!
 184
 185
 186 END of text file INSTALL