4 ezmlmrc \- ezmlm-make configuration file
10 is a file that configures
12 for setting up new lists.
14 if a plain text with four types
16 the first position of the line.
17 No other text is allowed on the same line. For
18 security reasons, no periods are allowed anywhere in a tag.
19 Any line with a ``#'' in position 1 is ignored,
20 as is any text preceding the first tag.
25 is unique. It should start in position 1 with ``x.yz'', where
26 ``x'' is the major version number, ``y'' a minor version number, and ``z''
27 a bugfix version number.
29 will print a warning message if it is used with an
31 file that lacks the version identifier, or
34 file that has a version identifier that differs in
35 either major or minor version numbers from the
41 file is processed top down. Text preceding the first tag is ignored.
42 Subsequently, one and only one file is open for writing. Any text encountered
45 is copied to that file as is with a few substitutions (see below). Text
46 following conditional tags is copied only if the condition is met. A file is
47 automatically closed when a new file is opened. Opening a file overwrites
48 any preexisting file with that name.
53 The following text will be copied to
55 if the options specified after the ``#'' are active, in this case
59 Any number of flags can be specified. This
60 is used to adapt the files and
61 messages to the type of list created. If no flags are
62 used, the ``#'' can be omitted. If the file name is the same as the previous
63 tag, or if it is omitted, the text will be added to the previous file.
64 When a new file is opened the previous file is closed. Attempts to add
65 more text to a already closed file overwrites its contents.
66 For all letter switches (except
69 case tags are opposite and mutually exclusive. Thus, if
82 has special meaning. It is false if the list is being edited, e.g.
95 is specified. Thus, for normal edits with unchanged list name, the files
98 are not overwritten (preserving manual customizations), but if the list name
99 changes or if explicitly specified by
109 This is an alternative way of specifying ``if switch \-5 is specified and
110 the \-i switch is not specified''. ``^'' is used as ``not''.
114 will be erased, if the options after the ``#'' are active, in this case
118 An alternative to specify that a flag, e.g. ``4'' should not be active is
122 The directory ``directory'' is created if the flags specified are active, in
127 If no flags are specified, the ``#'' can be
130 .B </:link/directory#aI/>
134 if the flags specified are active, in
139 If no flags are specified, the ``#'' can be
148 between the first 2 hyphens (if any) for
152 between the second and third hyphen (if any) for
170 anywhere in the text. Other tags of this format are copied to the files as is.
176 will be substituted on-the-fly where appropriate for the
180 local part of the list address, the
182 the subscriber address or the moderation accept address,
183 and the subscription reply address or moderation reject address, respectively.
186 is to allow the same text file to be used for requests pertaining to both
187 the main list and the digest list.
189 Before the template file is processed,
191 will create the list directory.
195 .SH "DESCRIPTION OF EZMLMRC"
196 The ezmlmrc file is preconfigured to act upon
198 switches to produce the results as described in the
201 A number of files are created via
203 independently of any switched. These are
205 with a short description of the list,
207 with frequently asked questions about the list,
209 adding ``Precedence: bulk'' and ``X-No-Archive: yes'' to outgoing messages,
210 .I dir\fB/headerremove
211 removing ``Return-Path'', ``Return-Receipt-To'', ``Content-length'',
212 and ``Precedence'' from list messages, and
213 .I dir\fB/text/sub-ok
214 with text sent after successful subscription. These files are not overwritten
215 when lists are edited.
217 Also created are the following files within
231 .BR mod-sub-confirm ,
232 .BR mod-unsub-confirm ,
248 In addition to switch-dependent lines, an invocation of
250 is placed at the end of
255 to process the contents of the bounce directory.
260 .B \-0\ mainlist@mainhost
261 switch is used) to reject undesirable messages.
262 Below is a description of the switches and the consequences
263 the have for list creation with the standard
278 .I dir\fB/text/bottom
279 is adjusted to mention archive access.
287 Block archive. The list set up with
289 to allow only moderators archive access.
299 .I dir\fB/digest/lock
301 .I dir\fB/digest/lockbounce
303 .I dir\fB/digest/bounce/
305 .I dir\fB/digest/subscribers/
307 .I dot\fB-digest-owner
310 .I dot\fB-digest-return-default
323 are added with default arguments to
325 A note on digest (un)subscription is added to
326 .I dir\fB/text/bottom
328 .IR dir\fB/text/mod-help .
329 .I dir\fB/text/digest
330 is created for the ``Administrivia'' section of the digest.
333 The items mentioned under switch
335 are not done. The result is that the references to the digest
336 in the text files is removed.
339 The text ``[\fIlocal\fR]'' is placed in
341 resulting in the text being used as the list's subject index.
348 The -s switch is added to the
352 so that only subscribers can access the archive.
357 is not used. Anyone can access the archive if archive (access) in general
362 for ``archived'', and
371 (for moderated lists)
374 after messages are posted. This sets up the cross-reference for
386 to allow unconfirmed unsubscribe.
395 line that tests the envelope sender against the address database in
399 As a consequence, posts from such senders are rejected. This switch is ignored
400 for sublists (i.e. if the
401 .B \-0\ mainlist@mainhost
407 line testing the envelope sender against the ``blacklist'' in
412 The -l switch is added to the
416 to allow retrieval of subscriber list and list log by remote administrators.
418 This is pointless, unless the list is also set up for remote administration
422 .I dir\fB/text/mod-help
426 Do not allow access to the subscriber list under any circumstances. The
428 \-l switch is not specified.
441 .BR ezmlm-moderate(1) ,
444 .I dot\fB/\-accept-default
446 .I dot\fB/-reject-default
448 .IR dir\fB/moderator .
449 .I dir\fB/text/mod-help
451 Special action is taken when the
453 switch is combined with
455 In this case, the setup is as for the
463 for posts with an envelope sender that is a subscriber or a moderator, and
466 for posts with other envelope senders. The consequence is that posts from
467 subscribers (with the usual caveats for SENDER checks) are posted directly,
468 whereas other posts are sent for moderation.
471 No message moderation.
480 Allow text file editing.
484 is set up with the \-e switch to allow remote admins to via E-mail edit
488 This is pointless, unless the list is also set up for remote administration
492 .I dir\fB/text/mod-help
496 Remote editing of files in
504 For moderated lists, the
506 switch is used so that posts from non-moderators are rejected rather than
507 sent for moderation. This is for some announcement lists.
529 to service commands in the ``Subject'' line of messages sent to the
530 ``list-request'' address.
540 .I dir\fB/text/mod-help
548 Subscription moderation.
551 .I dir\fB/text/mod-help
553 .I dir\fB/text/sub-confirm
561 .I dir\fB/text/trailer
562 is created with instructions on how to unsubscribe.
565 .I dir\fB/text/trailer
573 line to check the envelope sender against the subscriber address databases.
574 If the sender is not found, the post is rejected. This results in
575 subscriber-only posts, with the usual caveats for SENDER checks.
576 Special action is taken when the
578 switch is combined with
580 In this case, the setup is as for the
588 for posts with an envelope sender that is a subscriber or a moderator, and
591 for posts with other envelope senders.
593 is set up with the \-R switch.
594 The consequence is that posts from
595 subscribers (with the usual caveats for SENDER checks) are posted directly,
596 whereas other posts are sent for moderation.
598 is set up with the \-R switch.
599 Thus, ignored posts are silently
600 removed rather than returned to sender.
606 restricting posts by envelope sender is not used.
612 invocations from the list setup. It is assumed that
618 will be run by other means, such as crond.
621 switch is used with this switch, the local list name will be added to the
625 .I dir\fB/digest/sql .
626 This is to support building the main list for a distributed list using
627 a SQL address database. In addition,
629 will be set up for bounce handling in
638 User configurable. By default, if the
642 is created. This file contains many MIME types not routinely supported.
644 .I dir\fB/mimeremove are stripped from multipart posts before archiving
649 or create a list and list
650 .IR dir\fB/mimeremove .
653 is created containing ``40000:2'' causing
655 to reject all posts that have a body of less than 2 bytes (empty) or
656 more than 40000 bytes (too large).
658 .B \-0\fI\ mainlist@mainhost
660 is created with ``mainlist@mainhost''.
661 .B dir\fB/ezmlm-reject
664 to avoid rejecting messages that the main list has accepted.
667 The list is set up to add ``from'' to
668 .I dir/fB/headerremove
672 .IR dir\fB/headeradd .
673 This replaces the incoming ``From:'' header as desirable for some announcement
676 .B \-4\fI\ tstdigopts
678 will be used as the arguments for
682 This must be both switches and their arguments for
683 .BR ezmlm-tstdig(1) .
685 This is pointless, unless the list is also set up for digests
690 .B \-5\fI\ owner@ownerhost
691 .I owner@ownerhost is placed in
693 so that mail to ``list-owner'' is forwarded to that address, rather than
696 If the address does not start with an underscore or alphanumeric character,
697 the argument must start with an ampersand.
699 .B \-6\fI\ host:port:user:password:datab:table
701 The string, followed by the list name is placed in
703 The same string with ``table'' suffixed with ``_digest'' and ``_allow''
707 .IR dir\fB/allow/sql ,
709 .B \-7\fI\ /msgmodPath
713 is the list is set up for message moderation with the
717 .B \-8\fI\ /submodPath
721 is the list is set up for subscription moderation with the
725 .B \-9\fI\ /remoteAdminPath
729 is the list is set up for remote administration with the