]> Pileus Git - ~andy/fetchmail/blob - INSTALL
First step towards netrc fix.
[~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 `config --help' for more.
26
27 If you're running QNX, edit the distributed Makefile directly.  The
28 QNX values for various macros are there but commented out; all you
29 have to do is uncomment them.
30
31 2. MAKE 
32
33 You may find you need flex at version 2.5.3 or greater to build
34 fetchmail.  The stock lex distributed with Linux does not work -- it
35 yields a parser which core-dumps on syntax errors.  You can get flex
36 at the GNU ftp site, ftp://prep.ai.mit.edu/pub/gnu.
37
38 Run
39
40         make
41
42 This should compile fetchmail for your system.
43
44 3. INSTALL
45
46 Lastly, become root and run
47
48         make install
49
50 This will install fetchmail.  By default, fetchmail will be installed
51 in /usr/local/bin, with the man page in /usr/local/man/man1.  If you
52 wish to change these defaults, edit the Makefile AFTER you run
53 "configure" but BEFORE you run "make install."  You can easily choose
54 a prefix other than /usr/local, or you can choose completely different
55 directories for each item.
56
57 NOTE: If you are using an MTA other than sendmail (such as qmail or exim),
58 see the FAQ (section T) for discussion of any special configuration steps
59 that may be necessary.
60
61 4. SET UP A RUN CONTROL FILE
62
63 See the man page or the file sample.rcfile for a description of how to
64 configure your individual preferences.
65
66 If you're upgrading from popclient, see question F4 in the FAQ file.
67
68 5. TEST
69
70 I strongly recommend that your first fetchmail run use the -v and -k
71 options, in case there is something not quite right with your server,
72 your local delivery configuration or your port 25 listener.  Also,
73 beware of aliases that direct your local mail back to the server host!
74
75 This software is known to work with the qpop/popper series of
76 freeware POP3 servers; also with the IMAP2bis and IMAP4 servers that are
77 distributed with Pine from the University of Washington.  
78
79 6. REPORTING BUGS
80
81 You should read the FAQ file question G1 before reporting a bug.
82
83 7. USE IT
84
85 Enjoy!
86