Topic: Files

This help file describes special files that are associated with mailing lists,
their meaning and format, and how to make use of them.

There are three commands that manipulate the files described here.  They
are:

	no		removes a file previously created or updated
			using "set"

	set		defines the contents of list files

	show		reports the contents of list files

The "no" and "set" command are only available to list owners.

These are the files that can be set for each list.  Files marked (*) are for
internal use only, and may not be set, removed or displayed.  Files marked
(+) may only be displayed by list owners.  Files marked (#) may be multiply
defined.  Files marked (%) are templates and can be expanded; see the
"Responses" help file for more information.

	ack (%)		acknowledgement message sent to people who submit
			to your list

	acl (+)		access control list; moderates who can subscribe
			and submit to the list; see the "ACLs" help topic
			for information about the format of this file

	digest.db (*)	index of digest contents, used for digest summaries

	digest (*)	digest contents

	digest-footer	text appended to digest distributions

	digest-header	text prepended to digest distributions

	digest-schedule	schedule for digest distributions; see below for
			information about the format of this file

	envelope	a script-like specification of owner-defined things
			to do to message headers outside of the standard
			things listmanager does, and the things RFC822
			requires; see below for information about the format
			of this file

	farewell	text message to be sent to members when they remove
			themselves from the list using either the "unsubscribe"
			command or the web interface, or when an owner removes
			them from the list using "remove"

	filter		filter list; one or more patterns to watch for in
			the message body; see below for information about the
			format of this file

	footer (#)	text appended to submissions to the list; if more
			than one footer is present, listmanager will rotate
			through them sequentially

	header		text prepended to submissions

	web-acl		web access control list; moderates who may issue
			list operations via the web interface; this matches
			the client connection and NOT the address provided
			on the form; see the "WWW" help topic for information
			about the format of this file

	welcome         text message to be sent to members when they add
			themselves from the list using either the "subscribe"
			command or the web interface, or when an owner adds
			them to the list using "add"

Special notes:

digest-schedule

  A schedule line is of the form:

	mpat hpat mdaypat wdaypat

  ...where "mpat" is a minute pattern, "hpat" is an hour pattern, "mdaypat" is
  a day-of-month pattern and "wdaypat" is a day-of-week pattern.  At a time of
  day when all four fields of any schedule line match the current time, the
  digest will be sent unless it is empty.

  "mpat" specifies the minute.  The minute is from 00 to 59 inclusive.  The
  pattern is a comma-separated list of one or more minutes or ranges of
  minutes, or "*" meaning any minute, optionally followed by a granularity
  specification.  For example, "*/2" means every other minute starting at
  minute 0, "00-29" refers to any minute in the top half of the hour,
  "0,10,20,30,40,50" is the same as "*/10", "1-59/2" implies only odd-numbered
  minutes, and so on.

  "hpat" specifies the hour in a similar fashion.  The valid range is from 00
  to 23 inclusive.

  "mdaypat" specifies the day of the month in a similar fashion.  The valid
  range is from 01-31.

  "wdaypat" specifies the days of the week in a similar fashion, with some
  exceptions.  The valid range is from 0 to 7, with both 0 and 7 being Sunday.
  You may also specify a three-character name for a weekday, so "Mon-Fri" is
  the same as "1-5".

  Some examples:

        0 7 * *             7:00am daily
        0 7 * 1-5           7:00am weekdays
        30 15 */2 *         3:30pm every other day
        0 6,18 * *          6:00am and 6:00pm daily
        0 12 * 1,3,5        noon Monday, Wednesday and Friday
        0 12 * Mon,Wed,Fri  noon Monday, Wednesday and Friday
        30 */4 * *          every six hours on the half hour

envelope

  An envelope specification contains a set of things to do to the message
  headers (the Internet-standard message routing and delivery tracking
  information, not the text that appears at the top of a message body) on
  submissions sent to the list.

  By default, the script is "null" which means all headers are passed
  verbatim through listmanager and on to the list recipients, with order
  preserved, subject to the following exceptions:

	- an X-List-Software: header is added, whose value reflects the
	  version of listmanager that is running
	- if the "loop-detect" flag is set, an X-Loop-Detect: header is
	  added
	- if any "replyto" flags are set, the Reply-To: header is added
	  or replaced to reflect the requested value
	- the Precedence: header is set or replaced with the value "list"
	- if the what's being distributed is one of may list segments,
	  an X-List-Segment: header is added to indicate which list and
	  which segment of that list is being processed
	- the Errors-To: header is set to point to the list owner address
	- if the "mnemonic" flag is set, the Subject: header is set to or
	  replaced with the "mnemonic-ized" subject; otherwise, the
	  X-Mnemonic: header is added to indicate the mnemonic for this
	  submission
	- the submission's Message-ID: header is renamed to the
	  X-Original-Message-ID: header with the same value

  The envelope specification can be used to amend the submission's headers
  once the above have been applied.  A line is of one of the following two
  forms:

	s <header> <value>	set the specified header to the specified
				value
	d <header>		delete the specified header(s)

  On the "s" instruction, the <header> will have all letters immediately
  following start-of-string or a hyphen capitalized.  Moreover, if <value>
  contains spaces, it should be enclosed in quotation marks.

  Wildcards are permitted on the "d" instruction, such as "d X-*" to delete
  all headers starting with "X-" (i.e. all non-standard headers).  Also,
  all headers matching the <header> will be deleted.  You can therefore
  specify "d received" to delete all instances of the Received: header.

  Setting a header which is already defined replaces the value of that header.
  The exception to this is any header which can be multiply defined (see
  below) in which case a new instance of that header is appended to the
  existing set of headers.

  Listmanager enforces no maximum size on any header's value.  The maximum
  size of a header's name is 64 characters.

  The following headers are known to listmanager.  The table also indicates
  any restrictions that are in effect.  List owners may not create a header
  not listed below unless its name starts with "X-".
  
  Legend:
	r	required; may not be deleted once set
	l	locked; may be set, but not amended once set
	m	multiple; may be multiply defined
	d	description; listmanager will add the list description
		where required to this header if the "describe-to"
		flag is set

	Header		Properties	Header			Properties
	From:			r	Message:			-
	Reply-To:		-	Text:				-
	Errors-To:		-	Received:			m
	Sender:			-	X400-Received:			m
	Return-Receipt-To:	-	Via:				m
	Resent-Reply-To:	m	Mail-From:			m
	Resent-Sender:		m	Date:				rl
	Resent-From:		m	Resent-Date:			m
	Resent-To:		m	Content-Type:			-
	To:			dr	Content-Length:			-
	Cc:			d	Content-Transfer-Encoding:	-
	Bcc:			-	Subject:			-
	Resent-Bcc:		m	Full-Name:			-
	Apparently-To:		d	Comments:			-
	Message-ID:		-	Return-Path:			-
	Resent-Message-ID:	m	X-List-Software:		r

See also: no, Responses, select, set, show
