annotate README @ 190:fbb3417c1a54 default tip

Minor fixes in man pages, reported by lintian(1)
author markus schnalke <meillo@marmaro.de>
date Mon, 29 Aug 2011 19:22:51 +0200
parents 89467037cb36
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
67
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
1 Masqmail README
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
2 ===============
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
3
67
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
4 Masqmail is a mail server designed for hosts that are not permanently
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
5 connected to the internet. It handles outgoing messages, i.e. those
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
6 that are to be sent over the non-permanent link (usually a ppp or slip
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
7 connection over a modem or ISDN adapter) specially and delivers them
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
8 only when explicitely told to do so. There is support for multiple
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
9 providers, it is possible to write different configurations for each
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
10 one. The configuration chosen is selected at delivery time, so that if
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
11 for example a delivery of a message failed while connected with
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
12 provider 1, it may be delivered when connected to provider 2. For each
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
13 provider another mail host (or none) can be specified.
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
14
67
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
15 Masqmail provides (a yet simple) mechanism to rewrite headers, also
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
16 depending on the current connection. This makes it possible to deliver
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
17 messages with a return address on the local network which will be
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
18 rewitten at delivery time. The purpose of this is:
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
19
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
20 - to allow delivery failure messages that are produced on the local
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
21 network to be delivered immediately, while those that are produced
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
22 outside can be delivered to a mailbox on the internet, to be retrieved
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
23 later.
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
24
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
25 - to give mail servers a return address which they can accept if they
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
26 check for spam mail. Many mail servers require a return address which
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
27 has the same domain as the server it is getting the message from. If
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
28 you normally connect to only one provider, this is usually not a
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
29 problem as you can configure your mailer to a fixed address (but then
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
30 there is still the problem with the failure messages...), but it is a
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
31 problem if you use different ones from time to time.
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
32
67
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
33 Masqmail shall once be a complete replacement for sendmail (or other
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
34 MTAs such as exim, qmail or smail) on a local network, but it is NOT
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
35 supposed to be installed in a network with a permanent internet
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
36 connection (at least if it is not behind a secure firewall) because
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
37 it has no ability to check for undesired relaying or spam filtering.
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
38
67
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
39
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
40 Masqmail's website is:
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
41
67
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
42 http://marmaro.de/prog/masqmail
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
43
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
44 The email address of it's mailing list is:
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
45
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
46 <masqmail@marmaro.de>
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
47
67
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
48 To subscribe yourself to the list, send a mail with the subject
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
49 ``subscribe masqmail'' to <minimalist@marmaro.de>. The mailing list
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
50 archive is accessible at: http://lists.marmaro.de/masqmail/ . If you
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
51 have any problems, contact me: markus schnalke <meillo@marmaro.de>.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
52
67
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
53
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
54 INSTALLATION
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
55 ------------
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
56
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
57 For installation instructions, see INSTALL.
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
58
67
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
59
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
60 BUGS
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
61 ----
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
62
67
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
63 There are probably a lot of bugs in masqmail. Please report any one you
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
64 discover to me. The more bug reports I get, the better masqmail will
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
65 get.
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
66
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
67 See docs/howto-report-bugs for detailed instructions.
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
68
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
69
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
70 CREDITS
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
71 -------
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
72
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
73 I would like to thank everyone who has submitted suggestions and bug
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
74 reports. Special thanks to:
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
75
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
76 Gregor Hoffleit for beta testing and his suggestions for delivering
67
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
77 mail immediately when online. And for supplying a patch which made
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
78 masqmail work with mutt. And again for making the Debian package. And
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
79 more patches.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
80
67
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
81 Dale Perkel for patiently trying to make MM compile and run with libc5
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
82 and various bug reports.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
83
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
84 Andre Masloch for finding most bugs.
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
85
67
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
86 Edouard G. Parmelan for many patches and bug reports.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
87
67
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
88 Iain Lea for the Redhat spec file.
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
89
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
90 Juergen Daubert for excellent bug reports including patches and various
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
91 feedback.
0
08114f7dcc23 this is masqmail-0.2.21 from oliver kurth
meillo@marmaro.de
parents:
diff changeset
92
144
89467037cb36 credited Paolo's contributions
meillo@marmaro.de
parents: 67
diff changeset
93 Paolo for a large patch improving several parts of masqmail, especially
89467037cb36 credited Paolo's contributions
meillo@marmaro.de
parents: 67
diff changeset
94 server-side SMTP SIZE support.
89467037cb36 credited Paolo's contributions
meillo@marmaro.de
parents: 67
diff changeset
95
67
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
96 ... and many others.
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
97 See ChangeLog, the code repository log, and the mailing list for more.
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
98 Feel free to tell me if you think you are missing on this list.
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
99
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
100
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
101
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
102 This file was originally written by by Oliver Kurth <oku@masqmail.cx>.
bce7604e0465 updated README; added howto-report-bugs
meillo@marmaro.de
parents: 0
diff changeset
103 Later updated and extended by markus schnalke <meillo@marmaro.de>.