add feature: configurable subject prefixing for mailing lists

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

diff --git a/enemies-of-carlotta.1 b/enemies-of-carlotta.1
index 5f70634aabc8bfbdf23a514c0398da071b87c429..5d97093ad903dc1707dd2f2317466e4929e571f8 100644 (file)
--- a/enemies-of-carlotta.1
+++ b/enemies-of-carlotta.1
@@ -360,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 ,
@@ -426,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