3 ezmlm-make \- create a new mailing list
22 sets up a new mailing list,
23 .IR local\fB@\fIhost ,
24 along with several extra addresses to handle administrative requests.
26 All mailing list information is stored in a new directory,
29 must be an absolute pathname, starting with a slash.
31 must be an absolute file name starting with a slash. Arguments other than
33 may be omitted when editing an existing list, using the
40 is controlled by a template,
42 Described here is the behavior with the default template file.
44 will print a warning message before continuing,
45 if the ezmlmrc version does not match the
49 .B ezmlm-make also creates
51 where it stores all configuration information. By reading this file, you
52 can rapidly get information about how the list is set up.
56 switch will read information from this file. Thus, when using
59 you only need to specify the desired switches and switch arguments and
63 switch all switches become sticky, i.e. the default for all switches (and
64 command line arguments) becomes the switches and arguments active for the
65 list to be edited. Note that the choice of config file also is sticky,
76 .IR dot\fB-return-default ,
79 You should make sure that messages to
80 .IR local\fB@\fIhost ,
81 .IR local\fB-owner@\fIhost ,
82 etc. are controlled by
87 For message moderated lists,
89 sets up two additional
92 .IR dot\fB-accept-default
94 .IR dot\fB-reject-default .
101 .IR dot\fB-digest-return-default
103 .IR dot\fB-digest-owner .
107 is specified, digest creation by
109 via trigger messages to the
110 .I local\fB/@\fIhost\fB-dig.\fIdigestcode
115 sets up lists to add a ``X-No-Archive: yes'' header to outgoing messages.
116 Public archiving servers will interpret this header as a
117 request not to archive messages from
118 the list. It this in not what you desire, remove this header from
120 for global effects, or from
122 for the specific list.
129 ezmlm-make ~joe/SOS ~joe/.qmail-sos joe-sos isp.net
138 ezmlm-make ~alias/SOS ~alias/.qmail-sos sos isp.net
141 chown -R alias ~alias/SOS
146 by a normal user enabling automatic digests:
149 ezmlm-make -d ~joe/SOS ~joe/.qmail-sos joe-sos isp.net
154 to change an existing list in ~joe/SOS to a message moderated list with
155 remote administration, and enabling the remote administrator(s) to retrieve
156 a subscriber list and to edit
158 files (digest are still enabled):
161 ezmlm-make -emrldn ~joe/SOS
164 Mail can arrive at any time!
165 For safe editing, turn on the sticky bit of the home directory before
166 editing the list setup,
167 then turn it off again (see
170 Moderator addresses are added with
173 ezmlm-sub ~joe/SOS/mod mod1@host1 mod2@host2 ...
177 also creates the necessary text files in
181 has a large number of switches to control all aspects of list generation.
182 Only defaults or a small subset of switches are necessary for most list
183 setups. Other options are present primarily to allow a external CGI script
184 or other graphical user interface to use
186 to manipulate ezmlm list setups.
187 .SH "VIRTUAL DOMAINS"
190 prefixes the name of the controlling user to the LOCAL part of the recipient
193 needs to be informed of this in order to correctly interpret list commands.
194 This is done by adjusting
196 This adaptation is necessary only when ezmlm is used with qmail version 1.01
199 To create the list ``tl@virtual.dom'' where ``virtual.dom'' is controlled
200 by ``vu'' (virtual.dom:vu), change identity to ``vu'' or chown files to
204 ezmlm-make ~vu/dir ~vu/.qmail-tl tl virtual.dom
208 echo "vu-tl" > ~vu/inlocal
211 Thus, create the list exactly as for a list under ``alias'', but adjust
213 to the list local name prefixed with the controlling user name.
217 letter switches except
221 are available for interpretation via
229 have special meaning within the program.
231 customization should respect the function of the switches described here.
234 Switches currently active for the list
235 will be used, as modified by the current command line.
238 makes switches ``sticky''. By default,
239 only switches specified on the current command line will be used.
242 as it is meaningless except in edit mode. Note that the config file choice
249 is set up so that most text files (and
250 .IR DIR\fB/headeradd ,
251 .IR DIR\fB/headerremove )
252 are not overwritten if they already exist so as to preserve
253 manual customizations. If
257 overrides this behavior and all files are rewritten. You can also force
259 to rewrite all files by using
263 (Default.) Archived and configured with
273 will archive new messages.
279 Block archive. Only moderators are allowed to access the archive.
283 Archive access is open to anyone or subscribers only, depending
292 (see CONFIGURATION) from the directory where
298 file (normally /etc/ezmlmrc and if not found there, the ezmlmrc file
299 in the ezmlm binary directory).
302 switch may cause you to execute
305 configuration file controlled by another user.
307 does not allow periods in any tag to restrict all actions to within
309 Be careful with this option setting up lists for other users,
310 especially when running
322 to override a default when using
331 .I local\fB\-digest@host
332 digest list to disseminate digest of the list messages. By default, this
333 is done when 30 messages, 48 hours, or 64 kbytes of message body text have
334 accumulated since the last digest. Use the
336 switch to override these defaults. See
345 Do not set up the digest list.
350 will remove links before creating them and accept
351 if directories to be created are already present.
353 will also (via entries in
355 remove flags that are present but not desired for the current list.
356 Thus, this option can be used to reconfigure existing lists without affecting
357 moderator and subscriber lists or message archive. All desired
360 need to be specified. To make all switches sticky, i.e. only specify the
361 ones changed from the previous setup, use
363 Command line arguments other
367 In the unlikely case where
369 is changed, you must manually remove the old links.
370 Mail can arrive at any time!
371 For safe editing, turn on the sticky bit of the home directory before
372 using the edit function,
373 then turn it off again (see
376 is set up so that most text files (and
377 .IR DIR\fB/headeradd ,
378 .IR DIR\fB/headerremove )
379 are not overwritten if they already exist so as to preserve
380 manual customizations. If
384 overrides this behavior and all files are rewritten. You can also force
386 to rewrite all files by using
393 will abort if directories or links to be created already exist. This prevents
394 accidental reconfiguration of a pre-existing list, since the first action
395 is to create the list directory.
400 will set up the list so that the outgoing subject will be prefixed
409 Archive access requests from unrecognized SENDERs will be rejected.
410 This restriction is safe, since replies are sent to the SENDER address.
414 Do not guard archive.
415 Archive access request from any SENDER will be serviced.
418 Help subscription. Subscriptions do not require confirmation. Strongly
419 recommended against, since anyone can subscribe any address,
420 but may be useful for some subscription moderated lists.
424 Subscription requires confirmation by reply to a message sent to the
425 subscription address.
428 Indexed for WWW archive access.
430 will create the list so that
432 is invoked to maintain an index suitable for use by
437 The list is created without
438 .BR ezmlm-archive(1) .
441 Jump off. Unsubscribe does not require confirmation. Strongly recommended
442 against, since anyone can unsubscribe any address, but may be useful
447 Unsubscribe requires confirmation by a reply to a message sent to the
448 subscription address.
455 It sets up the list so that posts from addresses in
457 are rejected. This is useful in combination with the
459 switch to temporarily restrain offenders, such as misconfigured auto-responders
460 or automatic spammers.
461 It can also be used in combination with
463 to filter out SENDERs from whom the moderators do not want to see
465 re-mailers and spammers come to mind).
467 To add/remove blacklisted addresses:
470 .B ezmlm-sub \fIdir\fB/deny \fIbad@host
474 .B ezmlm-unsub \fIdir\fB/deny \fIbad@host
482 is not created, and even if it exists, the contents will be ignored.
487 sets up the list so that remote administrators can request a subscriber list,
488 and search the subscriber log.
492 The subscriber list cannot be obtained.
495 Message moderation. (Please note that the
496 .B \-u switch modifies
497 the action of this switch.)
504 .IR dir\fB/mod/subscribers/ ,
505 where the moderator addresses are stored.
508 .IR dir\fB/mod/pending/ ,
509 .IR dir\fB/mod/accepted/ ,
511 .IR dir\fB/mod/rejected/ .
512 These directories are used to queue messages awaiting moderation.
514 will be set up to run
516 to store incoming messages in the moderation queue and send moderation
517 requests to the moderators.
519 will be set up to run
527 To add/remove moderators:
530 .B ezmlm-sub \fIdir\fB/mod \fImoderator@host
534 .B ezmlm-unsub \fIdir\fB/mod \fImoderator@host
540 Message posting is not moderated.
545 sets up the list to allow remote administrators to edit files in
551 Text file editing not allowed.
555 Posts from addresses other than moderators are rejected. This is
556 applicable to message moderated lists only
559 The switch has no effect on other lists.
564 For moderated lists, all posts are forwarded to the moderators.
565 The switch has effects only on message moderated lists.
574 will respond to administrative requests and
576 will allow archive retrieval.
583 will allow only digest creation, remote administration, and archive
584 retrieval by remote administrators, (if the list is configured with these
588 ReQuest address is serviced.
590 will configure the list to process commands sent in the subject to
591 .IR local\fB-request@\fIhost .
592 This is done by adding a
599 Do not process messages sent to the ``request'' address.
604 enables remote administration by touching
606 Moderator(s) can unsubscribe and subscribe
610 option on how moderator addresses are stored and manipulated.
613 (Default.) No remote administration.
616 Subscription moderation.
618 enables subscription moderation by touching
620 This affects subscriptions for both the main list and the digest list.
623 option on how moderator addresses are stored and manipulated.
626 (Default.) Subscriptions are not moderated.
632 .I dir\fB/text/trailer
633 to set up the list to add a trailer to outgoing messages.
643 so that posts and archive access is restricted to subscribers.
644 These are addresses subscribed to the main list, the digest, or added
645 manually to the address database in
647 which accommodates addresses from e.g. subscribers working from an address
648 other than their subscriber address.
650 Posts from unrecognized SENDER addresses will be rejected.
651 This is relatively easily defeated for posts.
652 More secure alternatives are message moderated lists configured with the
658 There is no reason to combine of SENDER checks on posts with message
659 moderation. Therefore, the combination of the
663 switch is used for a configuration with SENDER restrictions (like with
665 alone), with the difference that posts from non-subscribers will be sent for
666 moderation instead of being rejected. This allows the list admin to let
667 non-subscribers post occasionally, as well as to catch subscribers posting
668 from non-subscriber addresses.
672 Do not restrict posts based on SENDER address.
687 invocations from the list setup. It is assumed that
692 .I local\fB-digest@\fIhost
693 will be run by other means, such as crond.
694 If the list is set up with SQL support (see
696 restrict the list to a subset of addresses by adding the list name to
699 .I dir\fB/allow/sql ,
700 .I dir\fB/digest/sql ,
701 configuration files. Useful only when setting up the main list
702 for a large distributed list supported by a SQL address database.
703 Also, bounces will be handled by
706 .BR ezmlm-return(1) .
707 As the main list will have only sublists as subscribers, it is desirable
708 to log bounces and feedback messages rather than to remove a bouncing
713 No address restriction. Normal
717 .BR ezmlm-return(1) .
722 will configure the list with a few extras:
724 will be configured to strip annoying mime parts such as excel spreadsheets,
725 rtf text, html text etc from the messages. Messages consisting solely of
726 this Content-type will be rejected. See
732 .B \-0 \fImainlist@host
733 Make the list a sublist of list
738 sets up the list to replace the ``From:'' header of the message with
746 switches used for digest generation with the text in
748 This is part of a command line, NOT a specific switch. It should normally
749 be placed within single quotes. This switch is mainly for programmatic
750 use. For changing list defaults, it is usually easier to create a custom
752 file and edit it. The default is '-t24 -m30 -k64'. (See
758 will configure the list to forward mail directed to the list owner to
761 .B \-6\fI\ host:port:user:password:datab:table
762 SQL connect info. Use the sql
767 (default port for SQL server) as
774 and the table root name
777 This will have no effect unless the ezmlm programs
778 are compiled with SQL support.
780 .B \-7 \fI/msg_mod_path
783 the path to the database for message moderators, if the list is set up for
786 must be an absolute pathname, starting with a slash. If not, it will be ignored.
788 .B \-8 \fI/sub_mod_path
791 the path to the database for subscription moderators, if the list is set up for
792 subscription moderation.
794 must be an absolute pathname, starting with a slash. If not, it will be ignored.
796 .B \-9 \fI/rem_adm_path
799 the path to the database for remote administrators, if the list is set up for
800 remote administration.
802 must be an absolute pathname, starting with a slash. If not, it will be ignored.
808 switch, and the list was previously created or edited with a
809 new (ezmlm-idx >= 0.23) version of
811 all arguments other than
813 can be omitted. In this case, arguments will be read from
815 The appropriate flags must always be specified. To override
821 all arguments must be specified.
825 is template driven. The template file consists of plain text with four types
826 of tags. Both start in
827 the first position of the line.
828 No other text is allowed on the same line. For
829 security reasons, no periods are allowed anywhere in a tag.
830 Any line with a ``#'' in position 1 is ignored,
831 as is any text preceding the first tag.
834 The following text will be copied to
836 if the options specified after the ``#'' are active, in this case
840 Any number of flags can be specified. This
841 is used to adapt the files and
842 messages to the type of list created. If no flags are
843 used, the ``#'' can be omitted. If the file name is the same as the previous
844 tag, or if it is omitted, the text will be added to the previous file.
845 When a new file is opened the previous file is closed. Attempts to add
846 more text to a already closed file overwrites its contents.
848 An alternative to specify that a flag, e.g. ``4'' should not be active is
849 to prefix the switch with ``^'', e.g. use ``^4''.
850 The ``E'' flag is treated in a special manner. When the list
851 is being edited, it evaluates to false if the file already exists,
852 true if it does not. Thus, files using this condition are not overwritten
853 when editing. This is useful for files that you frequently customize manually.
857 will be erased, if the options after the ``#'' are active, in this case
863 The directory ``directory'' is created if the flags specified are active, in
868 If no flags are specified, the ``#'' can be
871 .B </:link/directory#aI/>
875 if the flags specified are active, in
880 If no flags are specified, the ``#'' can be
889 between the first 2 hyphens (if any) for
893 between the second and third hyphen (if any) for
907 the set of all active flags for
909 the config file used for
915 anywhere in the text. Other tags of this format are copied to the files as is.
922 will be substituted on-the-fly where appropriate for the
926 local part of the list address, the
928 the subscriber address or the moderation accept address,
930 and the subscription reply address or moderation reject address, respectively.
933 is to allow the same text file to be used for requests pertaining to both
934 the main list and the digest list.
936 makes it possible to share some files between lists.
938 is defined only by programs where this makes sense, i.e.
949 will create the list directory before processing the template file, and
952 after all other actions.
959 in the ezmlm binary directory. This can be overridden with the
966 deals with the template file as us-ascii.
968 the characters ``</'' at the beginning of a line will disrupt
971 Any occurrence of tags with the format ``<#X#>'' with
972 with 'X' being any digit, 'B', 'C', 'D', 'F', 'H', 'L', or 'T'
973 will be substituted by
975 Any occurrence of a tag of this format with 'X' being 'h', 'l', 'A',
983 will substitute tags with 'h' and 'l', and tags with 'n' will be replaced
984 by the current message number.
986 will substitute tags ``<#h#>'', ``<#l#>'' in the same way. The
987 tag ``<#n#>'' will be replaced by the digest message number which is the
988 number of the first message in the digest.
990 In practice, these character sequences are unlikely to occur in any
991 multi-byte character set text. They also will not occur by chance
993 single-byte character sets where '<', '/', and '#'
994 retain their us-ascii codes.
997 cannot deal with ezmlmrc lines containing NUL (they will be truncated
998 at the NUL). This needs to be fixed to make it 8-bit clean.
~mdw / ezmlm / blob