]> Pileus Git - ~andy/fetchmail/blob - INSTALL
df1189cfcfb532b6aaa3502c3186460998fcd6aa
[~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 The Frequently Asked Questions list, included as the file FAQ in this
9 distributions, answers the most common questions about configuring and 
10 running fetchmail.
11
12 1. CONFIGURE
13
14 Installing fetchmail is easy.  From within this directory, type:
15
16         ./configure
17
18 The autoconfiguration script will spend a bit of time figuring out the
19 specifics of your system.  If you want to specify a particular compiler
20 (e.g. you have gcc but want to compile with cc), set the environment 
21 variable CC before you run configure.  
22
23 The configure script accepts certain standard configuration options.
24 These include --prefix, --exec-prefix, --bindir, --infodir, --mandir,
25 and --srcdir.  Do `configure --help' for more.
26
27 POP2 support is no longer compiled in by default, as POP2 is way obsolete
28 and there don't seem to be any live servers for it anymore.  You can
29 configure it back in if you want with `configure --enable-POP2', but
30 leaving it out cuts the executable's size slightly.
31
32 If you want to build for debugging, 
33
34         CFLAGS=-g LDFLAGS=" " ./configure
35
36 will do that.
37
38 If you're running QNX, edit the distributed Makefile directly.  The
39 QNX values for various macros are there but commented out; all you
40 have to do is uncomment them.
41
42 2. MAKE 
43
44 You may find you need flex at version 2.5.3 or greater to build
45 fetchmail.  The stock lex distributed with Linux does not work -- it
46 yields a parser which core-dumps on syntax errors.  You can get flex
47 at the GNU ftp site, ftp://prep.ai.mit.edu/pub/gnu.
48
49 Run
50
51         make
52
53 This should compile fetchmail for your system.
54
55 3. INSTALL
56
57 Lastly, become root and run
58
59         make install
60
61 This will install fetchmail.  By default, fetchmail will be installed
62 in /usr/local/bin, with the man page in /usr/local/man/man1.  If you
63 wish to change these defaults, edit the Makefile AFTER you run
64 "configure" but BEFORE you run "make install."  You can easily choose
65 a prefix other than /usr/local, or you can choose completely different
66 directories for each item.
67
68 NOTE: If you are using an MTA other than sendmail (such as qmail or exim),
69 see the FAQ (section T) for discussion of any special configuration steps
70 that may be necessary.
71
72 4. SET UP A RUN CONTROL FILE
73
74 See the man page or the file sample.rcfile for a description of how to
75 configure your individual preferences.
76
77 If you're upgrading from popclient, see question F4 in the FAQ file.
78
79 5. TEST
80
81 I strongly recommend that your first fetchmail run use the -v and -k
82 options, in case there is something not quite right with your server,
83 your local delivery configuration or your port 25 listener.  Also,
84 beware of aliases that direct your local mail back to the server host!
85
86 This software is known to work with the qpop/popper series of
87 freeware POP3 servers; also with the IMAP2bis and IMAP4 servers that are
88 distributed with Pine from the University of Washington.  
89
90 6. REPORTING BUGS
91
92 You should read the FAQ file question G1 before reporting a bug.
93
94 7. USE IT
95
96 Enjoy!
97