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