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.
   7
   8 1. CONFIGURE
   9
  10 Installing fetchmail is easy.  From within this directory, type:
  11
  12         ./configure
  13
  14 The autoconfiguration script will spend a bit of time figuring out the
  15 specifics of your system.  If you want to specify a particular compiler
  16 (e.g. you have gcc but want to compile with cc), set the environment
  17 variable CC before you run configure.
  18
  19 The configure script accepts certain standard configuration options.
  20 These include --prefix, --exec-prefix, --bindir, --infodir, --mandir,
  21 and --srcdir.  Do `config --help' for more.
  22
  23 If you're running QNX, edit the distributed Makefile directly.  The
  24 QNX values for various macros are there but commented out; all you
  25 have to do is uncomment them.
  26
  27 2. MAKE
  28
  29 You may find you need flex at version 2.5.3 or greater to build
  30 fetchmail.  The stock lex distributed with Linux does not work -- it
  31 yields a parser which core-dumps on syntax errors.
  32
  33 Run
  34
  35         make
  36
  37 This will compile fetchmail for your system.
  38
  39 3. INSTALL
  40
  41 Lastly, become root and run
  42
  43         make install
  44
  45 This will install fetchmail.  By default, fetchmail will be installed
  46 in /usr/local/bin, with the man page in /usr/local/man/man1.  If you
  47 wish to change these defaults, edit the Makefile AFTER you run
  48 "configure" but BEFORE you run "make install."  You can easily choose
  49 a prefix other than /usr/local, or you can choose completely different
  50 directories for each item.
  51
  52 NOTE: If you are using exim, you must configure it to accept local
  53 addresses as valid RCPT TO lines.
  54
  55 4. SET UP A RUN CONTROL FILE
  56
  57 See the man page or the file sample.rcfile for a description of how to
  58 configure your individual preferences.
  59
  60 Note: if you have been using popclient (the ancestor of this program)
  61 at version 3.0b6 or later, do this
  62
  63 (cd ~; mv ~/.poprc ~/.fetchmailrc)
  64
  65 in order to migrate.  Be aware that some of popclient's unnecessary
  66 options have been removed (see the NOTES file for explanation).  You
  67 can't deliver to a local mail file anymore or to standard output any
  68 more, and using an MDA for delivery is discouraged.  If you throw
  69 those options away, fetchmail will now forward your mail into your
  70 system's normal Internet-mail delivery path.
  71
  72 Actually, using an MDA is now almost always the wrong thing; the MDA
  73 facility has been retained only for people who can't or won't run a
  74 sendmail-like SMTP listener on port 25. The default, SMTP forwarding
  75 to port 25, is better for at least two major reasons.  One: it feeds
  76 retrieved POP and IMAP mail into your system's normal delivery path
  77 along with local mail and normal Internet mail.  Two: because the port
  78 25 listener returns a positive acknowledge, fetchmail can be sure
  79 you're not going to lose mail to a disk-full or some other
  80 resource-exhaustion problem.
  81
  82 If you used to use -mda "procmail -d <you>" or something similar, forward
  83 to port 25 and do "| procmail -d <you>" in your ~/.forward file.
  84
  85 5. TEST
  86
  87 I strongly recommend that your first fetchmail run use the -v and -k
  88 options, in case there is something not quite right with your server,
  89 your local delivery configuration or your port 25 listener.  Also,
  90 beware of aliases that direct your local mail back to the server host!
  91
  92 This software is known to work with the qpop/popper series of
  93 freeware POP3 servers; also with the IMAP2bis and IMAP4 servers that are
  94 distributed with Pine from the University of Washington.
  95
  96 A couple of users have reported that some recent (post-2.7.2) versions
  97 of gcc seem to have an optimizer bug that affects fetchmail.  If your
  98 fetchmail core dumps (especially near startup) try recompiling without
  99 -O.  Alternatively, you can drop back to gcc 2.7.2 or below.
 100
 101 6. REPORTING BUGS
 102
 103 You should read the FAQ file before rfeporting a bug.
 104
 105 When reporting bugs, please include the following:
 106
 107 1. Your operating system and compiler version.
 108 2. The release and patch level of the fetchmail you are running.  You can see
 109    your patchlevel by typing `fetchmail -V'.
 110 3. The output of fetchmail -V (this will not reveal your password).
 111 4. Any command-line options you used.
 112
 113 It is helpful if you include your .fetchmailrc, but not necessary
 114 unless your symptom seems to involve an error in configuration parsing.
 115
 116 A transcript of the failed session with -v on is almost always useful.
 117 If the bug involves a core dump, a gdb stack trace is good to have.
 118
 119 Best of all is a mail file which, when fetched, will reproduce the bug.
 120
 121 7. USE IT
 122
 123 Enjoy!
 124