aboutsummaryrefslogtreecommitdiffstats
path: root/INSTALL
blob: 354dc5ad2cb3087262b85a52939646880b152960 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
		INSTALL Instructions for fetchmail

If you have installed binaries (e.g. from an RPM) you can skip to step 4.

If you are a Linux system packager, be aware that the build process generates
an RPM spec file at fetchmail.spec.

1. CONFIGURE

Installing fetchmail is easy.  From within this directory, type:

	./configure

The autoconfiguration script will spend a bit of time figuring out the
specifics of your system.  If you want to specify a particular compiler
(e.g. you have gcc but want to compile with cc), set the environment 
variable CC before you run configure.  

The configure script accepts certain standard configuration options.
These include --prefix, --exec-prefix, --bindir, --infodir, --mandir,
and --srcdir.  Do `config --help' for more.

If you're running QNX, edit the distributed Makefile directly.  The
QNX values for various macros are there but commented out; all you
have to do is uncomment them.

2. MAKE 

Next run

	make

This will compile fetchmail for your system.  Note that in order to
build it, you may find you need flex at version 2.5.3 or greater.  The
stock lex distributed with Linux does not work -- it yields a parser
which core-dumps on syntax errors.

3. INSTALL

Lastly, become root and run

	make install

This will install fetchmail.  By default, fetchmail will be installed
in /usr/local/bin, with the man page in /usr/local/man/man1.  If you
wish to change these defaults, edit the Makefile AFTER you run
"configure" but BEFORE you run "make install."  You can easily choose
a prefix other than /usr/local, or you can choose completely different
directories for each item.

NOTE: If you are using exim, you must configure it to accept local
addresses as valid RCPT TO lines.

4. SET UP A RUN CONTROL FILE

See the man page or the file sample.rcfile for a description of how to
configure your individual preferences.

Note: if you have been using popclient (the ancestor of this program)
at version 3.0b6 or later, do this

(cd ~; mv ~/.poprc ~/.fetchmailrc)

in order to migrate.  Be aware that some of popclient's unnecessary
options have been removed (see the NOTES file for explanation).  You
can't deliver to a local mail file anymore or to standard output any
more, and using an MDA for delivery is discouraged.  If you throw
those options away, fetchmail will now forward your mail into your
system's normal Internet-mail delivery path.

If you use an MDA with popclient or an older version of fetchmail that
requires %s in the MDA string in order to substitute in a local
delivery address, remove it.  One consequences of the internal changes
to support multi-drop mailboxes is that local delivery addresses will
be appended to the end of the command in the obvious way.

Actually, using an MDA is now almost always the wrong thing; the MDA
facility has been retained only for people who can't or won't run a
sendmail-like SMTP listener on port 25. The default, SMTP forwarding
to port 25, is better for at least two major reasons.  One: it feeds
retrieved POP and IMAP mail into your system's normal delivery path
along with local mail and normal Internet mail.  Two: because the port
25 listener returns a positive acknowledge, fetchmail can be sure
you're not going to lose mail to a disk-full or some other
resource-exhaustion problem.

If you used to use -mda "procmail -d <you>" or something similar, forward
to port 25 and do "| procmail -d <you>" in your ~/.forward file.

5. TEST

I strongly recommend that your first fetchmail run use the -v and -k
options, in case there is something not quite right with your server,
your local delivery configuration or your port 25 listener.  Also,
beware of aliases that direct your local mail back to the server host!

This software is known to work with the qpop/popper series of
freeware POP3 servers; also with the imapd servers that are
distributed with Pine from the University of Washington.  Other
POP3 servers have been known to give it indigestion.  Test carefully!
If you have problems, try to switch to IMAP.

A couple of users have reported that some recent (post-2.7.2) versions
of gcc seem to have an optimizer bug that affects fetchmail.  If your
fetchmail core dumps (especially near startup) try recompiling without
-O.  Alternatively, you can drop back to gcc 2.7.2 or below.

6. USE IT

Enjoy!

7. REPORTING BUGS

When reporting bugs, please include the following:

1. Your operating system.
2. The release and patch level of the fetchmail you are running.  You can see
   your patchlevel by typing `fetchmail -V'.
3. The output of fetchmail -V (this will not reveal your password).
4. Any command-line options you used.

It is helpful if you include your .fetchmailrc but not necessary
unless your bug involves an error in configuration parsing.

A transcript of the failed session with -v on is often useful.