]> Pileus Git - ~andy/fetchmail/blob - INSTALL
Document recent changes.
[~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 org greater, or lex.
35
36 3. INSTALL
37
38 Lastly, become root and run
39
40         make install
41
42 This will install fetchmail.  By default, fetchmail will be installed
43 in /usr/local/bin, with the man page in /usr/local/man/man1.  If you
44 wish to change these defaults, edit the Makefile AFTER you run
45 "configure" but BEFORE you run "make install."  You can easily choose
46 a prefix other than /usr/local, or you can choose completely different
47 directories for each item.
48
49 NOTE: If you are using exim, you must configure it to accept local
50 addresses as valid RCPT TO lines.
51
52 4. SET UP A RUN CONTROL FILE
53
54 See the man page or the file sample.rcfile for a description of how to
55 configure your individual preferences.
56
57 Note: if you have been using popclient (the ancestor of this program)
58 at version 3.0b6 or later, do this
59
60 (cd ~; mv ~/.poprc ~/.fetchmailrc)
61
62 in order to migrate.  Be aware that some of popclient's unnecessary 
63 options have been removed (see the NOTES file for explanation).  You
64 can't deliver to a local mail file anymore, and using an MDA for delivery
65 is discouraged.  If you throw those options away, fetchmail will now forward
66 your mail into your system's normal Internet-mail delivery path.
67
68 If you use an MDA with popclient or an older version of fetchmail that
69 requires %s in the MDA string in order to substitute in a local
70 delivery address, remove it.  One consequences of the internal changes
71 to support multi-drop mailboxes is that local delivery addresses will
72 be appended to the end of the command in the obvious way.
73
74 5. TEST
75
76 I strongly recommend that your first fetchmail run use the -v and -k
77 options, in case there is something not quite right with your server,
78 your local delivery configuration or your port 25 listener.  Also,
79 beware of aliases that direct your local mail back to the server host!
80
81 This software is known to work with the qpop/popper series of
82 freeware POP3 servers; also with the imapd servers that are
83 distributed with Pine from the University of Washington.  Other
84 POP3 servers have been known to give it indigestion.  Test carefully!
85 If you have problems, switch to imap.
86
87 If you're going to use multi-drop mailboxes, test with particular care.
88 This code was very difficult to test and should be considered experimental.
89
90 6. USE IT
91
92 Enjoy!
93