]> Pileus Git - ~andy/fetchmail/blob - INSTALL
Not experimental any more.
[~andy/fetchmail] / 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 Next run
30
31         make
32
33 This will compile fetchmail for your system.  Note that in order to
34 build it, you'll need either flex at version 2.5.3 or greater, or lex.
35
36 If mxget.c fails to compile, your DNS-query support isn't compatible
37 with BSD's and Linux's.  Manually undefine HAVE_GETHOSTBYNAME in
38 config.h and rebuild.  You'll lose the multidrop-mailbox feature and
39 Kerberos option, but nothing else.
40
41 3. INSTALL
42
43 Lastly, become root and run
44
45         make install
46
47 This will install fetchmail.  By default, fetchmail will be installed
48 in /usr/local/bin, with the man page in /usr/local/man/man1.  If you
49 wish to change these defaults, edit the Makefile AFTER you run
50 "configure" but BEFORE you run "make install."  You can easily choose
51 a prefix other than /usr/local, or you can choose completely different
52 directories for each item.
53
54 NOTE: If you are using exim, you must configure it to accept local
55 addresses as valid RCPT TO lines.
56
57 4. SET UP A RUN CONTROL FILE
58
59 See the man page or the file sample.rcfile for a description of how to
60 configure your individual preferences.
61
62 Note: if you have been using popclient (the ancestor of this program)
63 at version 3.0b6 or later, do this
64
65 (cd ~; mv ~/.poprc ~/.fetchmailrc)
66
67 in order to migrate.  Be aware that some of popclient's unnecessary
68 options have been removed (see the NOTES file for explanation).  You
69 can't deliver to a local mail file anymore or to standard output any
70 more, and using an MDA for delivery is discouraged.  If you throw
71 those options away, fetchmail will now forward your mail into your
72 system's normal Internet-mail delivery path.
73
74 If you use an MDA with popclient or an older version of fetchmail that
75 requires %s in the MDA string in order to substitute in a local
76 delivery address, remove it.  One consequences of the internal changes
77 to support multi-drop mailboxes is that local delivery addresses will
78 be appended to the end of the command in the obvious way.
79
80 Actually, using an MDA is now almost always the wrong thing; the MDA
81 facility has been retained only for people who can't or won't run a
82 sendmail-like SMTP listener on port 25. The default, SMTP forwarding
83 to port 25, is better for at least two major reasons.  One: it feeds
84 retrieved POP and IMAP mail into your system's normal delivery path
85 along with local mail and normal Internet mail.  Two: because the port
86 25 listener returns a positive acknowledge, fetchmail can be sure
87 you're not going to lose mail to a disk-full or some other
88 resource-exhaustion problem.
89
90 If you used to use -mda "procmail -d <you>" or something similar, forward
91 to port 25 and do "| procmail -d <you>" in your ~/.forward file.
92
93 5. TEST
94
95 I strongly recommend that your first fetchmail run use the -v and -k
96 options, in case there is something not quite right with your server,
97 your local delivery configuration or your port 25 listener.  Also,
98 beware of aliases that direct your local mail back to the server host!
99
100 This software is known to work with the qpop/popper series of
101 freeware POP3 servers; also with the imapd servers that are
102 distributed with Pine from the University of Washington.  Other
103 POP3 servers have been known to give it indigestion.  Test carefully!
104 If you have problems, try to switch to IMAP.
105
106 6. USE IT
107
108 Enjoy!
109