annotate man/mlmmj-process.1 @ 748:dfc9ab125fd4

Fix spelling of 'receive' and 'voodoo'; make mlmmj-recieve a symlink
author Chris Webb
date Sun, 03 Oct 2010 21:40:42 +1100
parents ebe24524a3f7
children c7fef0950be6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
317
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
1 .TH mlmmj-process "1" "September 2004" mlmmj-process
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
2 .SH NAME
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
3 mlmmj-process \- process mail for an mlmmj managed mailinglist
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
4 .SH SYNOPSIS
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
5 .B mlmmj-process
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
6 \fI-L /path/to/list -m /path/to/mail \fR[\fI-h\fR] [\fI-P\fR] [\fI-V\fR]
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
7 .HP
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
8 \fB\-h\fR: This help
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
9 .HP
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
10 \fB\-L\fR: Full path to list directory
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
11 .HP
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
12 \fB\-m\fR: Full path to mail file
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
13 .HP
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
14 \fB\-P\fR: Don't execute mlmmj-send (debugging only)
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
15 .HP
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
16 \fB\-V\fR: Print version
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
17 .SH DESCRIPTION
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
18 This is the binary which processes a mail. Examples of what such processing
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
19 is:
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
20 .RS 0
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
21 .IP \(bu 4
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
22 .B
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
23 Access control
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
24
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
25 Using the access rules specified in <listdir>/control/access to perform access
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
26 control to the list. This is done before headers are stripped, so one can
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
27 create allow rules based on headers that are later stripped.
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
28 .IP \(bu 4
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
29 .B
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
30 Header stripping
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
31
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
32 Headers specified in <listdir>/control/delheaders are deleted from the mail.
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
33 .IP \(bu 4
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
34 .B
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
35 Header addition
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
36
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
37 Headers specified in <listdir>/control/customheaders are added to the mail.
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
38 This could be headers like List-ID: or Reply-To:
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
39 .IP \(bu 4
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
40 .B
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
41 List control
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
42
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
43 In case there's a mail with a recipient delimiter it's not a regular list mail.
748
dfc9ab125fd4 Fix spelling of 'receive' and 'voodoo'; make mlmmj-recieve a symlink
Chris Webb
parents: 317
diff changeset
44 Processing of these happens in mlmmj-receive as well. Examples of such are
317
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
45 subscription requests, mails to owner etc.
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
46 It will base it's recipient delimiter detection on the Delivered-To: header if
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
47 present. If not, the To: header is used.
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
48 .IP \(bu 4
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
49 .B
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
50 Moderation
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
51
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
52 If the list is moderated, it will happen in mlmmj-process.
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
53 .RE
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
54
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
55 When processing is done, it will invoke the needed binary according to whatever
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
56 mail it is. If it's a subscription request it will invoke mlmmj-sub, if it's a
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
57 regular list mail it will invoke mlmmj-send.
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
58 .SH "SEE ALSO"
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
59 The file TUNABLES from the mlmmj source distribution or in the documentation
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
60 directory of the operating system distribution.
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
61 .SH AUTHORS
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
62 This manual page was written by the following persons:
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
63 .HP
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
64 Søren Boll Overgaard <boll@debian.org> (based on html2man output)
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
65 .HP
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
66 Mads Martin Jørgensen <mmj@mmj.dk>