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