Pileus Git - ~andy/fetchmail/blob - INSTALL

   1                 INSTALL Instructions for fetchmail
   2
   3 If you have installed binaries (e.g. from an RPM) you can skip to step 5.
   4
   5 If you are a Linux system packager, be aware that the build process generates
   6 an RPM spec file at fetchmail.spec, and you can "make rpm" to generate an
   7 RPM and SRPM.
   8
   9 The Frequently Asked Questions list, included as the file FAQ in this
  10 distributions, answers the most common questions about configuring and
  11 running fetchmail.
  12
  13 1. USEFUL THINGS TO INSTALL FIRST
  14
  15 If you want support for RFC1938-compliant one-time passwords, you'll
  16 need to install Craig Metz's OPIE libraries first.  Then configure
  17 with --enable-OPIE, and fetchmail build process will detect them and
  18 compile appropriately.
  19
  20 Note: there is no point in doing this unless your server is
  21 OTP-enabled.  To test this, telnet to the server port and give it
  22 a valid USER id.  If the OK response includes the string "otp-",
  23 you should install OPIE.
  24
  25 The OPIE library sources are available at ftp://ftp.inner.net/pub/opie.
  26
  27 2. CONFIGURE
  28
  29 Installing fetchmail is easy.  From within this directory, type:
  30
  31         ./configure
  32
  33 The autoconfiguration script will spend a bit of time figuring out the
  34 specifics of your system.  If you want to specify a particular compiler
  35 (e.g. you have gcc but want to compile with cc), set the environment
  36 variable CC before you run configure.
  37
  38 The configure script accepts certain standard configuration options.
  39 These include --prefix, --exec-prefix, --bindir, --infodir, --mandir,
  40 and --srcdir.  Do `configure --help' for more.
  41
  42 POP2 support is no longer compiled in by default, as POP2 is way obsolete
  43 and there don't seem to be any live servers for it anymore.  You can
  44 configure it back in if you want with `configure --enable-POP2', but
  45 leaving it out cuts the executable's size slightly.
  46
  47 Specifying --with-kerberos=DIR will tell the fetchmail build process to
  48 look in DIR for Kerberos support.  Configure normally looks in /usr/kerberos
  49 and /usr/athena; if you specify this option with an argument it will look
  50 in DIR first.
  51
  52 Unfortunately, there doesn't seem to be good standardization of where
  53 Kerberos lives.  If your configuration doesn't match one of the four
  54 that fetchmail's configure.in knows about, you may find you have to
  55 hand-hack the Makefile a bit.
  56
  57 If you want to build for debugging,
  58
  59         CFLAGS=-g LDFLAGS=" " ./configure
  60
  61 will do that.
  62
  63 If you're running QNX, edit the distributed Makefile directly.  The
  64 QNX values for various macros are there but commented out; all you
  65 have to do is uncomment them.
  66
  67 3. MAKE
  68
  69 You may find you need flex at version 2.5.3 or greater to build
  70 fetchmail.  The stock lex distributed with some versions of Linux does
  71 not work -- it yields a parser which core-dumps on syntax errors.  You
  72 can get flex at the GNU ftp site, ftp://prep.ai.mit.edu/pub/gnu.
  73
  74 Run
  75
  76         make
  77
  78 This should compile fetchmail for your system.
  79
  80 4. INSTALL
  81
  82 Lastly, become root and run
  83
  84         make install
  85
  86 This will install fetchmail.  By default, fetchmail will be installed
  87 in /usr/local/bin, with the man page in /usr/local/man/man1.  You can
  88 use the configure options --bindir and --mandir to change these.
  89
  90 NOTE: If you are using an MTA other than sendmail (such as qmail,
  91 exim, or smail), see the FAQ (section T) for discussion of any special
  92 configuration steps that may be necessary.
  93
  94 5. SET UP A RUN CONTROL FILE
  95
  96 See the man page and the file sample.rcfile for a description of how to
  97 configure your individual preferences.
  98
  99 If you're upgrading from popclient, see question F4 in the FAQ file.
 100
 101 6. TEST
 102
 103 I strongly recommend that your first fetchmail run use the -v and -k
 104 options, in case there is something not quite right with your server,
 105 your local delivery configuration or your port 25 listener.  Also,
 106 beware of aliases that direct your local mail back to the server host!
 107
 108 This software is known to work with the qpop/popper series of freeware
 109 POP3 servers; also with the IMAP2bis and IMAP4 servers that are
 110 distributed with Pine from the University of Washington; also with the
 111 Cyrus IMAP server from CMU.  This covers all the servers normally
 112 hosted on Linux and *BSD systems.  It also works with Microsoft Exchange,
 113 despiite the fact that Microsoft Exchange is extremely broken (returns
 114 incorrect message lengths in LIST responses).
 115
 116 7. REPORTING BUGS
 117
 118 You should read the FAQ file question G3 before reporting a bug.
 119
 120 8. USE IT
 121
 122 Once you've verified your configuration, you can start fetchmail to
 123 run in background and forget about it.  Enjoy!