annotate man/mlmmj-sub.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 e5286b45f9ca
children c3ee2bfaeb02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
728
e5286b45f9ca Fixed documentation regarding silent subscription, and added
Ben Schmidt
parents: 561
diff changeset
1 .TH mlmmj-sub "1" "January 2010" mlmmj-sub
317
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
2 .SH NAME
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
3 mlmmj-sub \- subscribe address to a mailinglist run by mlmmj
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
4 .SH SYNOPSIS
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
5 .B mlmmj-sub
343
6d1f589dee87 This is post crash commit of working copy mmj. Will test compile etc.
mmj
parents: 317
diff changeset
6 \fI-L /path/to/list -a john@doe.org \fR[\fI-c\fR | \fI-C\fR] \fR[\fI-d\fR | \fI-n\fR]
728
e5286b45f9ca Fixed documentation regarding silent subscription, and added
Ben Schmidt
parents: 561
diff changeset
7 [\fI-f\fR] [\fI-h\fR] [\fI-U\fR] [\fI-V\fR]
317
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
8 .HP
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
9 \fB\-a\fR: Email address to subscribe
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
10 .HP
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
11 \fB\-c\fR: Send welcome mail
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
12 .HP
728
e5286b45f9ca Fixed documentation regarding silent subscription, and added
Ben Schmidt
parents: 561
diff changeset
13 \fB\-C\fR: Request mail confirmation
e5286b45f9ca Fixed documentation regarding silent subscription, and added
Ben Schmidt
parents: 561
diff changeset
14 .HP
343
6d1f589dee87 This is post crash commit of working copy mmj. Will test compile etc.
mmj
parents: 317
diff changeset
15 \fB\-d\fR: Subscribe to digest version of the list
6d1f589dee87 This is post crash commit of working copy mmj. Will test compile etc.
mmj
parents: 317
diff changeset
16 .HP
728
e5286b45f9ca Fixed documentation regarding silent subscription, and added
Ben Schmidt
parents: 561
diff changeset
17 \fB\-f\fR: Force subscription (do not moderate)
317
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
18 .HP
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
19 \fB\-h\fR: This help
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
20 .HP
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
21 \fB\-L\fR: Full path to list directory
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
22 .HP
561
16f1746469b1 submod man
mmj
parents: 512
diff changeset
23 \fB\-m\fR: Subscriber moderation string
16f1746469b1 submod man
mmj
parents: 512
diff changeset
24 .HP
343
6d1f589dee87 This is post crash commit of working copy mmj. Will test compile etc.
mmj
parents: 317
diff changeset
25 \fB\-n\fR: Subscribe to nomail version of the list
6d1f589dee87 This is post crash commit of working copy mmj. Will test compile etc.
mmj
parents: 317
diff changeset
26 .HP
512
9d7d41368743 man-pages and 1.2.8
mmj
parents: 343
diff changeset
27 \fB\-s\fR: Don't send a mail to the subscriber if already subscribed
9d7d41368743 man-pages and 1.2.8
mmj
parents: 343
diff changeset
28 .HP
317
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
29 \fB\-U\fR: Don't switch to the user id of the listdir owner
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
30 .HP
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
31 \fB\-V\fR: Print version
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
32 .SH DESCRIPTION
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
33 This utility is used to subscribe people to the specified mailinglist. It will
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
34 write the email address in a file with the name of the beginning letter of the
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
35 email address getting subscribed in the <listdir>/subscribers.d/ directory.
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
36
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
37 Unless the \fB\-U\fR switch is used it will switch its user id to the user id
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
38 owning the list directory. This is done to make sure that new files created are
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
39 having correct permissions.
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
40
343
6d1f589dee87 This is post crash commit of working copy mmj. Will test compile etc.
mmj
parents: 317
diff changeset
41 The nomail version of the list is a list version where people are subscribed
748
dfc9ab125fd4 Fix spelling of 'receive' and 'voodoo'; make mlmmj-recieve a symlink
Chris Webb
parents: 728
diff changeset
42 like usual, but they won't receive any postings to the list. This is useful for
343
6d1f589dee87 This is post crash commit of working copy mmj. Will test compile etc.
mmj
parents: 317
diff changeset
43 people who read the mailinglist through a news gateway, but want to be able to
6d1f589dee87 This is post crash commit of working copy mmj. Will test compile etc.
mmj
parents: 317
diff changeset
44 post to the list.
6d1f589dee87 This is post crash commit of working copy mmj. Will test compile etc.
mmj
parents: 317
diff changeset
45
512
9d7d41368743 man-pages and 1.2.8
mmj
parents: 343
diff changeset
46 Normally a mail is sent to the subscriber if the address is already subscribed
9d7d41368743 man-pages and 1.2.8
mmj
parents: 343
diff changeset
47 to the list. If the \fB\-s\fR switch is used such a mail will not be sent.
9d7d41368743 man-pages and 1.2.8
mmj
parents: 343
diff changeset
48
728
e5286b45f9ca Fixed documentation regarding silent subscription, and added
Ben Schmidt
parents: 561
diff changeset
49 Subscription may be moderated (if <listdir>/control/submod exists) unless the
e5286b45f9ca Fixed documentation regarding silent subscription, and added
Ben Schmidt
parents: 561
diff changeset
50 \fB\-f\fR switch is given.
e5286b45f9ca Fixed documentation regarding silent subscription, and added
Ben Schmidt
parents: 561
diff changeset
51
e5286b45f9ca Fixed documentation regarding silent subscription, and added
Ben Schmidt
parents: 561
diff changeset
52 To ensure a silent subscription, use \fB\-f\fR, but neither \fB\-c\fR
e5286b45f9ca Fixed documentation regarding silent subscription, and added
Ben Schmidt
parents: 561
diff changeset
53 nor \fB\-C\fR.
317
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
54 .SH "SEE ALSO"
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
55 mlmmj-unsub(1), setuid(2)
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
56 .SH AUTHORS
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
57 This manual page was written by the following persons:
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
58 .HP
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
59 Søren Boll Overgaard <boll@debian.org> (based on html2man output)
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
60 .HP
ebe24524a3f7 Manual pages
mmj
parents:
diff changeset
61 Mads Martin Jørgensen <mmj@mmj.dk>