mlmmj

changeset 0e403f9320ac

Convert documentation to UTF-8
author Ben Schmidt
date Sat, 14 Aug 2010 01:07:52 +1000
parents 7d7149bce08e
children 3a637a2669a1
files README TUNABLES
diffstat 2 files changed, 58 insertions(+), 58 deletions(-) [+]
line diff
     1.1 --- a/README	Sat Aug 14 01:07:36 2010 +1000
     1.2 +++ b/README	Sat Aug 14 01:07:52 2010 +1000
     1.3 @@ -6,20 +6,20 @@
     1.4  
     1.5  The functionality:
     1.6  
     1.7 -  Archive
     1.8 -  Custom headers / footer
     1.9 -  Fully automated bouncehandling (similar to ezmlm)
    1.10 -  Complete requeueing functionality
    1.11 -  Moderation functionality
    1.12 -  Subject prefix
    1.13 -  Subscribers only posting
    1.14 -  Regular expression access control
    1.15 -  Functionality to retrieve old posts
    1.16 -  Web-interface
    1.17 -  Digests
    1.18 -  No mail delivery subscription
    1.19 -  VERP support
    1.20 -  Delivery Status Notification (RFC1891) support
    1.21 + · Archive
    1.22 + · Custom headers / footer
    1.23 + · Fully automated bouncehandling (similar to ezmlm)
    1.24 + · Complete requeueing functionality
    1.25 + · Moderation functionality
    1.26 + · Subject prefix
    1.27 + · Subscribers only posting
    1.28 + · Regular expression access control
    1.29 + · Functionality to retrieve old posts
    1.30 + · Web-interface
    1.31 + · Digests
    1.32 + · No mail delivery subscription
    1.33 + · VERP support
    1.34 + · Delivery Status Notification (RFC1891) support
    1.35  
    1.36  To use mlmmj, do the following:
    1.37  
    1.38 @@ -131,7 +131,7 @@
    1.39  10) Have a look at the file TUNABLES for runtime configurable things.
    1.40  
    1.41  Tunables in include/mlmmj.h:
    1.42 -  There's some time intervals for how mlmmj-maintd operates. I've choosen
    1.43 + · There's some time intervals for how mlmmj-maintd operates. I've choosen
    1.44     non-strict defaults, so depending on your BOFH rate you might want to tweak.
    1.45     The defaults should be good for most people though.
    1.46  
     2.1 --- a/TUNABLES	Sat Aug 14 01:07:36 2010 +1000
     2.2 +++ b/TUNABLES	Sat Aug 14 01:07:52 2010 +1000
     2.3 @@ -9,63 +9,63 @@
     2.4  to specify several entries (one pr. line), it's marked "list". If the file's
     2.5  entire content is used as value, it's marked "text".
     2.6  
     2.7 -  listaddress			(list)
     2.8 + · listaddress			(list)
     2.9  
    2.10     This file contains all addresses which mlmmj sees as listaddresses (see
    2.11     tocc below). The first one is the one used as the primary one, when mlmmj
    2.12     sends out mail.
    2.13  
    2.14 -  closedlist			(boolean)
    2.15 + · closedlist			(boolean)
    2.16  
    2.17     Is the list is open or closed. If it's closed subscription and
    2.18     unsubscription via mail is disabled.
    2.19  
    2.20 -  closedlistsub		(boolean)
    2.21 + · closedlistsub		(boolean)
    2.22  
    2.23     Closed for subscription. Unsubscription is possible.
    2.24  
    2.25 -  moderated			(boolean)
    2.26 + · moderated			(boolean)
    2.27  
    2.28     If this file is present, the emailaddresses in the file
    2.29     listdir/control/moderators will act as moderators for the list.
    2.30  
    2.31 -  submod			(list)
    2.32 + · submod			(list)
    2.33  
    2.34     If this file is present, subscription will be moderated by owner(s).
    2.35     If there are emailaddresses in this file, then these will be used
    2.36     instead of owner.
    2.37  
    2.38 -  tocc				(boolean)
    2.39 + · tocc				(boolean)
    2.40  
    2.41     If this file is present, the list address does not have to be in the To:
    2.42     or Cc: header of the email to the list.
    2.43  
    2.44 -  subonlypost			(boolean)
    2.45 + · subonlypost			(boolean)
    2.46  
    2.47     When this file is present, only people who are subscribed to the list,
    2.48     are allowed to post to it. The check is made against the "From:" header.
    2.49  
    2.50 -  modnonsubposts		(boolean)
    2.51 + · modnonsubposts		(boolean)
    2.52  
    2.53     When this file is present and subonlypost is enabled, all postings from
    2.54     people who are not subscribed to the list will be moderated.
    2.55  
    2.56 -  prefix			(normal)
    2.57 + · prefix			(normal)
    2.58  
    2.59     The prefix for the Subject: line of mails to the list. This will alter the
    2.60     Subject: line, and add a prefix if it's not present elsewhere.
    2.61  
    2.62 -  owner			(list)
    2.63 + · owner			(list)
    2.64  
    2.65     The emailaddresses in this file (1 pr. line) will get mails to
    2.66     listname+owner@listdomain.tld
    2.67  
    2.68 -  customheaders		(list)
    2.69 + · customheaders		(list)
    2.70  
    2.71     These headers are added to every mail coming through. This is the place you
    2.72     want to add Reply-To: header in case you want such.
    2.73  
    2.74 -  delheaders			(list)
    2.75 + · delheaders			(list)
    2.76  
    2.77     In this file is specified *ONE* headertoken to match pr. line. If the file
    2.78     consists of:
    2.79 @@ -74,149 +74,149 @@
    2.80     Then all occurences of these headers in incoming list mail will be deleted.
    2.81     "From " and "Return-Path:" are deleted no matter what.
    2.82  
    2.83 -  access			(list)
    2.84 + · access			(list)
    2.85  
    2.86     If this file exists, all headers of a post to the list is matched against
    2.87     the rules. The first rule to match wins. See README.access for syntax and
    2.88     examples.
    2.89  
    2.90 -  memorymailsize		(normal)
    2.91 + · memorymailsize		(normal)
    2.92  
    2.93     Here is specified in bytes how big a mail can be and still be prepared for
    2.94     sending in memory. It's greatly reducing the amount of write system calls to
    2.95     prepare it in memory before sending it, but can also lead to denial of
    2.96     service attacks. Default is 16k (16384 bytes).
    2.97  
    2.98 -  addtohdr			(boolean)
    2.99 + · addtohdr			(boolean)
   2.100  
   2.101     When this file is present, a To: header including the recipients
   2.102     emailaddress will be added to outgoing mail. Recommended usage is to remove
   2.103     existing To: headers with delheaders (see above) first.
   2.104  
   2.105 -  relayhost			(normal)
   2.106 + · relayhost			(normal)
   2.107  
   2.108     The host specified (IP address or hostname, both works) in this file will
   2.109     be used for relaying the mail sent to the list. Defaults to 127.0.0.1.
   2.110  
   2.111 -  notifysub			(boolean)
   2.112 + · notifysub			(boolean)
   2.113  
   2.114     If this file is present, the owner(s) will get a mail with the address of
   2.115     someone sub/unsubscribing to a mailinglist.
   2.116  
   2.117 -  notifymod			(boolean)
   2.118 + · notifymod			(boolean)
   2.119  
   2.120     If this file is present, the poster (based on the envelope from) will
   2.121     get a mail when their post is being moderation.
   2.122  
   2.123 -  digestinterval		(normal)
   2.124 + · digestinterval		(normal)
   2.125  
   2.126     This file specifies how many seconds will pass before the next digest is
   2.127     sent. Defaults to 604800 seconds, which is 7 days.
   2.128  
   2.129 -  digestmaxmails		(normal)
   2.130 + · digestmaxmails		(normal)
   2.131  
   2.132     This file specifies how many mails can accumulate before digest sending is
   2.133     triggered. Defaults to 50 mails, meaning that if 50 mails arrive to the list
   2.134     before digestinterval have passed, the digest is delivered.
   2.135  
   2.136 -  bouncelife			(normal)
   2.137 + · bouncelife			(normal)
   2.138  
   2.139     Here is specified for how long time in seconds an address can bounce before
   2.140     it's unsubscribed. Defaults to 432000 seconds, which is 5 days.
   2.141  
   2.142 -  noarchive			(boolean)
   2.143 + · noarchive			(boolean)
   2.144  
   2.145     If this file exists, the mail won't be saved in the archive but simply
   2.146     deleted.
   2.147  
   2.148 -  nosubconfirm			(boolean)
   2.149 + · nosubconfirm			(boolean)
   2.150  
   2.151     If this file exists, no mail confirmation is needed to subscribe to the
   2.152     list. This should in principle never ever be used, but there is times
   2.153     on local lists etc. where this is useful. HANDLE WITH CARE!
   2.154  
   2.155 -  noget			(boolean)
   2.156 + · noget			(boolean)
   2.157  
   2.158     If this file exists, then retrieving old posts with +get-N is disabled
   2.159  
   2.160 -  subonlyget			(boolean)
   2.161 + · subonlyget			(boolean)
   2.162  
   2.163     If this file exists, then retrieving old posts with +get-N is only
   2.164     possible for subscribers. The above mentioned 'noget' have precedence.
   2.165  
   2.166 -  verp				(normal)
   2.167 + · verp				(normal)
   2.168  
   2.169     Enable VERP support. Anything added in this variable will be appended the
   2.170     MAIL FROM: line. If "postfix" is put in the file, it'll make postfix use
   2.171     VERP by adding XVERP=-= to the MAIL FROM: line.
   2.172  
   2.173 -  maxverprecips		(normal)
   2.174 + · maxverprecips		(normal)
   2.175  
   2.176     How many recipients pr. mail delivered to the smtp server. Defaults to 100.
   2.177  
   2.178 -  notoccdenymails		(boolean)
   2.179 -  noaccessdenymails		(boolean)
   2.180 -  nosubonlydenymails		(boolean)
   2.181 + · notoccdenymails		(boolean)
   2.182 + · noaccessdenymails		(boolean)
   2.183 + · nosubonlydenymails		(boolean)
   2.184  
   2.185     These switches turns off whether mlmmj sends out notification about postings
   2.186     being denied due to the listaddress not being in To: or Cc: (see 'tocc'),
   2.187     when it was rejected due to an access rule (see 'access') or whether it's a
   2.188     subscribers only posting list (see 'subonlypost').
   2.189  
   2.190 -  nosubmodmails		(boolean)
   2.191 + · nosubmodmails		(boolean)
   2.192  
   2.193     This switch turns off whether mlmmj sends out notification about
   2.194     subscription being moderated to the person requesting subscription
   2.195     (see 'submod').
   2.196  
   2.197 -  smtpport			(normal)
   2.198 + · smtpport			(normal)
   2.199  
   2.200     In this file a port other than port 25 for connecting to the relayhost
   2.201     can be specified.
   2.202  
   2.203 -  delimiter			(normal)
   2.204 + · delimiter			(normal)
   2.205  
   2.206     This specifies what to use as recipient delimiter for the list.
   2.207     Default is "+".
   2.208  
   2.209 -  nodigesttext			(boolean)
   2.210 + · nodigesttext			(boolean)
   2.211  
   2.212     If this file exists, digest mails won't have a text part with a thread
   2.213     summary.
   2.214  
   2.215 -  nodigestsub			(boolean)
   2.216 + · nodigestsub			(boolean)
   2.217  
   2.218     If this file exists, subscription to the digest version of the mailinglist
   2.219     will be denied. (Useful if you don't want to allow digests and notify users
   2.220     about it).
   2.221  
   2.222 -  nonomailsub			(boolean)
   2.223 + · nonomailsub			(boolean)
   2.224  
   2.225     If this file exists, subscription to the nomail version of the mailinglist
   2.226     will be denied. (Useful if you don't want to allow nomail and notify users
   2.227     about it).
   2.228  
   2.229 -  maxmailsize			(normal)
   2.230 + · maxmailsize			(normal)
   2.231  
   2.232     With this option the maximal allowed size of incoming mails can be specified.
   2.233  
   2.234 -  nomaxmailsizedenymails	(boolean)
   2.235 + · nomaxmailsizedenymails	(boolean)
   2.236  
   2.237     If this is set, no reject notifications caused by violation of maxmailsize
   2.238     will be sent.
   2.239  
   2.240 -  nolistsubsemail		(boolean)
   2.241 + · nolistsubsemail		(boolean)
   2.242  
   2.243     If this is set, the LISTNAME+list@ functionality for requesting an
   2.244     email with the subscribers for owner is disabled.
   2.245  
   2.246 -  staticbounceaddr		(normal)
   2.247 + · staticbounceaddr		(normal)
   2.248  
   2.249     If this is set to something@example.org, the bounce address (Return-Path:)
   2.250     will be fixed to something+listname-bounces-and-so-on@example.org
   2.251     in case you need to disable automatic bounce handling.
   2.252  
   2.253 -  ifmodsendonlymodmoderate	(boolean)
   2.254 + · ifmodsendonlymodmoderate	(boolean)
   2.255  
   2.256     If this file is present, then mlmmj in case of moderation checks the
   2.257     envelope from, to see if the sender is a moderator, and in that case
   2.258 @@ -224,11 +224,11 @@
   2.259     a moderator sending mail to the list won't bother all the other moderators
   2.260     with his mail.
   2.261  
   2.262 -  footer			(text)
   2.263 + · footer			(text)
   2.264  
   2.265     The content of this file is appended to mail sent to the list.
   2.266  
   2.267 -  notmetoo			(boolean)
   2.268 + · notmetoo			(boolean)
   2.269  
   2.270     If this file is present, mlmmj attempts to exclude the sender of a post
   2.271     from the distribution list for that post so people don't receive copies