]> Pileus Git - ~andy/fetchmail/blob - INSTALL
354dc5ad2cb3087262b85a52939646880b152960
[~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 may find you need flex at version 2.5.3 or greater.  The
35 stock lex distributed with Linux does not work -- it yields a parser
36 which core-dumps on syntax errors.
37
38 3. INSTALL
39
40 Lastly, become root and run
41
42         make install
43
44 This will install fetchmail.  By default, fetchmail will be installed
45 in /usr/local/bin, with the man page in /usr/local/man/man1.  If you
46 wish to change these defaults, edit the Makefile AFTER you run
47 "configure" but BEFORE you run "make install."  You can easily choose
48 a prefix other than /usr/local, or you can choose completely different
49 directories for each item.
50
51 NOTE: If you are using exim, you must configure it to accept local
52 addresses as valid RCPT TO lines.
53
54 4. SET UP A RUN CONTROL FILE
55
56 See the man page or the file sample.rcfile for a description of how to
57 configure your individual preferences.
58
59 Note: if you have been using popclient (the ancestor of this program)
60 at version 3.0b6 or later, do this
61
62 (cd ~; mv ~/.poprc ~/.fetchmailrc)
63
64 in order to migrate.  Be aware that some of popclient's unnecessary
65 options have been removed (see the NOTES file for explanation).  You
66 can't deliver to a local mail file anymore or to standard output any
67 more, and using an MDA for delivery is discouraged.  If you throw
68 those options away, fetchmail will now forward your mail into your
69 system's normal Internet-mail delivery path.
70
71 If you use an MDA with popclient or an older version of fetchmail that
72 requires %s in the MDA string in order to substitute in a local
73 delivery address, remove it.  One consequences of the internal changes
74 to support multi-drop mailboxes is that local delivery addresses will
75 be appended to the end of the command in the obvious way.
76
77 Actually, using an MDA is now almost always the wrong thing; the MDA
78 facility has been retained only for people who can't or won't run a
79 sendmail-like SMTP listener on port 25. The default, SMTP forwarding
80 to port 25, is better for at least two major reasons.  One: it feeds
81 retrieved POP and IMAP mail into your system's normal delivery path
82 along with local mail and normal Internet mail.  Two: because the port
83 25 listener returns a positive acknowledge, fetchmail can be sure
84 you're not going to lose mail to a disk-full or some other
85 resource-exhaustion problem.
86
87 If you used to use -mda "procmail -d <you>" or something similar, forward
88 to port 25 and do "| procmail -d <you>" in your ~/.forward file.
89
90 5. TEST
91
92 I strongly recommend that your first fetchmail run use the -v and -k
93 options, in case there is something not quite right with your server,
94 your local delivery configuration or your port 25 listener.  Also,
95 beware of aliases that direct your local mail back to the server host!
96
97 This software is known to work with the qpop/popper series of
98 freeware POP3 servers; also with the imapd servers that are
99 distributed with Pine from the University of Washington.  Other
100 POP3 servers have been known to give it indigestion.  Test carefully!
101 If you have problems, try to switch to IMAP.
102
103 A couple of users have reported that some recent (post-2.7.2) versions
104 of gcc seem to have an optimizer bug that affects fetchmail.  If your
105 fetchmail core dumps (especially near startup) try recompiling without
106 -O.  Alternatively, you can drop back to gcc 2.7.2 or below.
107
108 6. USE IT
109
110 Enjoy!
111
112 7. REPORTING BUGS
113
114 When reporting bugs, please include the following:
115
116 1. Your operating system.
117 2. The release and patch level of the fetchmail you are running.  You can see
118    your patchlevel by typing `fetchmail -V'.
119 3. The output of fetchmail -V (this will not reveal your password).
120 4. Any command-line options you used.
121
122 It is helpful if you include your .fetchmailrc but not necessary
123 unless your bug involves an error in configuration parsing.
124
125 A transcript of the failed session with -v on is often useful.