HEAD: removed mrwise debug crud from uniclientgen.cc.
[wvapps.git] / retchmail / retchmailrc.5
blobd2bdb4c3a548647f7c36e4fec8257a561dcb1c2f
1 .TH RETCHMAILRC 5 "January 2002" "NIT.CA" "Retchmail"
2 .SH NAME
3 retchmailrc \- retchmail configuration file
4 .SH DESCRIPTION
5 When
6 .B retchmail
7 starts, it first loads its configuration from
8 .IR $HOME/.retchmailrc ,
9 which contains basic information about all of the various accounts and
10 servers that you want to download your mail from, and deliver your mail to.
11 .sp
12 The configuration file
13 .I $HOME/.retchmailrc
14 is in Windows "ini" file format, with
15 .B sections
16 named in square brackets and a number of
17 .B variable = value
18 pairs within each section.
19 .sp
20 Here is a sample configuration file:
21 .PP
22 [POP Servers]
23 .br
24 testuser@example.com = password
25 .br
26 [POP Targets]
27 .br
28 testuser@example.com = localuser
29 .PP
30 The sample configuration file above contains all of the options
31 necessary to run retchmail to automatically deliver mail from
32 .B testuser@example.com
34 .B localuser.
35 when retchmail is invoked.
36 .PP
37 If you want retchmail to use SSL to encrypt all of the traffic between it
38 and your POP server, then it's as easy as adding :995 to the POP Servers
39 account name as follows:
40 .PP
41 [POP Servers]
42 .br
43 testuser@example.com:995 = password
44 .br
45 [POP Targets]
46 .br
47 testuser@example.com:995 = localuser
48 .PP 
49 If you wish to have retchmail use a mail delivery agent (MDA) other then
50 sendmail to deliver your mail you may also add a MDA Override option to your
51 config file as follows:
52 .PP
53 [POP Servers]
54 .br
55 testuser@example.com = password
56 .br
57 [MDA Override]
58 .br
59 testuser@example.com = qmail
60 .PP
61 .SH SEE ALSO
62 .BR retchmail (1),
63 .PP
64 .SH AUTHORS
65 Avery Pennarun and Patrick Patterson for Net Integration Technologies Inc., as
66 part of the NetIntegrator project.