Merged subject prefix patch from Christine Spang.

[eoc.git] / enemies-of-carlotta.1

diff --git a/enemies-of-carlotta.1 b/enemies-of-carlotta.1
index 322ca65f5098b6d35aa5f91f0aa05188366e6f0a..5d97093ad903dc1707dd2f2317466e4929e571f8 100644 (file)
--- a/enemies-of-carlotta.1
+++ b/enemies-of-carlotta.1
@@ -83,10 +83,13 @@ or
 .TP
 .BI \-\-posting= type
 When creating a list, set its posting mode to
-.IR free ,
-.IR auto ,
+.IR free 
+(anyone can post),
+.IR auto
+(only subscribers can post, mails from others need to be moderated),
 or
-.IR moderated .
+.IR moderated 
+(all mails are moderated).
 Use with
 .BR \-\-edit ,
 or
@@ -287,9 +290,9 @@ Messages waiting for moderator approval.
 Subscription and unsubscription requests waiting to be confirmed by the user.
 .TP
 .B templates
-Directory containing list spesific templates (optional). If this
+Directory containing list specific templates (optional). If this
 directory exists, templates are searched from it before going for
-system wide templates. An empty file here means the corresponding
+system wide templates. An empty file here means the
 corresponding message is not sent at all. This can, for example, to
 be used to turn off the "please wait for moderator" mails on a per\-list
 basis.
@@ -357,6 +360,11 @@ is set to "fi", then the template named "foo" is first searched as
 .B pristine\-headers
 Do not MIME encode the headers. Set to "yes" to not encode, anything
 else (including empty or unset) means encoding will happen.
+.TP
+.B subject\-prefix
+A string to prepend to the "Subject" header of mails sent to this
+list, such as "[list\-name]". The prefix will not be added to
+subjects which already contain the prefix string.
 .SH EXAMPLES
 To create a list called 
 .IR moviefans@example.com ,
@@ -369,6 +377,7 @@ use the following command (all on one line):
 enemies\-of\-carlotta \-\-name=moviefans@example.com
 \-\-owner=ding@example.com \-\-create
 .RE
+.fi
 .PP
 Note that you need to arrange mail to arrive at the list (and its
 command addresses) by configuring your mail system.
@@ -376,15 +385,19 @@ For Qmail and Postfix, see below.
 .PP
 To see the subscribers on that list:
 .sp 1
+.nf
 .RS
 enemies\-of\-carlotta \-\-name=moviefans@example.com \-\-list
 .RE
+.fi
 .PP
 People wanting to subscribe to the list should mail
 .sp 1
+.nf
 .RS
 moviefans\-subscribe@example.com
 .RE
+.fi
 .SH QMAIL
 With QMail, to arrange for incoming mail to be processed by Enemies of
 Carlotta, you need to create a couple of
@@ -403,8 +416,10 @@ containing
 .PP
 If you're running a virtual domain, example.com, and the mails are
 being delivered to via 
-.I /var/qmail/control/virtualdomains to joe\-exampledotcom, the
-files would be called
+.I /var/qmail/control/virtualdomains
+to
+.IR joe\-exampledotcom ,
+the files would be called
 .I .qmail\-exampledotcom\-fans
 and
 .I .qmail\-exampledotcom\-fans\-default
@@ -416,6 +431,37 @@ and would contain
 .sp 1
 (all on one line, of course, in case the manual page formatter breaks it
 on several lines).
+.SH COURIER-MTA
+For Courier-MTA, the instructions are similar to the Qmail ones above.
+If your user name is joe and you wish to run the joe-fans email list,
+you need to create the two files .courier-fans and .courier-fans-default
+in your home directory with the content
+.sp 1
+.RS
+|enemies-of-carlotta --is-list --name $RECIPIENT || exit 67
+.br
+|enemies-of-carlotta --incoming
+.RE
+.sp 1
+(The former file needs only the second line, but the first line does no
+harm and it is easier to keep track of things when the files have the
+same content.  Note that $RECIPIENT should be included verbatim, it is
+not a metavariable for you to expand.)
+.PP
+If you are running a virtual domain configured so that all mail to the
+domain @example.com is delivered to joe-exampledotcom, you need to
+create the files .courier-exampledotcom-fans and
+.courier-exampledotcom-fans-default containing the two following lines:
+.sp 1
+.RS
+|enemies-of-carlotta --is-list --name $RECIPIENT --skip-prefix=joe-exampledotcom || exit 67
+.br
+|enemies-of-carlotta --incoming --skip-prefix=joe-exampledotcom
+.RE
+.sp 1
+If the virtual domain is for list use only, then it is sufficient to
+create only the file .courier-exampledotcom-default containing the
+latter two lines.
 .SH POSTFIX
 With Postfix, you need to set up a
 .I .forward
@@ -439,7 +485,7 @@ file containing
 .PP
 To use Enemies of Carlotta with a Postfix virtual domain, you need to
 set up a 
-.I "virtual regular expression map,"
+.IR "virtual regular expression map" ,
 typically called
 .I /etc/postfix/virtual_regexp
 (add