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