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