a

update/scripts/packages/majordomo-1.94.5/Doc/man/majordomo.8

@@ -0,0 +1,300 @@
+.TH MAJORDOMO 8
+.SH NAME
+Majordomo \- manage multiple mailing lists
+.SH SYNOPSIS
+.B Majordomo
+.SH "DESCRIPTION"
+.B Majordomo
+is a perl script which automates the management of Internet mailing lists.
+It is executed via electronic mail; users send e-mail to
+.B Majordomo
+with instructions in the body of the message, and the perl script performs
+the requested actions and responds with the results.  Any text in the
+"Subject:" line is ignored.
+.SH "COMMANDS"
+.B Majordomo
+understands the following commands (arguments in "[]" are optional):
+.TP 5
+.B
+subscribe \fIlist\fR [\fIaddress\fR]
+.P
+Subscribe yourself (or 
+.I address
+if specified) to the named
+.IR list .
+.TP 5
+.B
+unsubscribe \fIlist\fR [\fIaddress\fR]
+.P
+Unsubscribe yourself (or 
+.I address
+if specified) from the named
+.IR list .
+If
+.IR list
+is ``*'' (an asterisk), unsubscribe from all lists on this Majordomo
+server.
+.TP 5
+.B
+auth \fIspecial-word\fP subscribe \fIlist address\fP
+.P
+If the
+.I list
+subscribe policy setting includes \fI+confirm\fR,
+Majordomo will ask for confirmation before a subscription
+is approved.
+The conformation request will show the
+.I special-word
+to send with
+.I auth .
+.TP 5
+.B
+get \fIlist\fR \fIfile\fR
+.P
+Get the
+.I file
+related to
+.IR list .
+.TP 5
+.B
+index \fIlist\fR
+.P
+Return an index of the files you can
+.I get
+associated with
+.IR list .
+.TP 5
+.B
+which [\fIaddress\fR]
+.P
+Find out to which lists you (or
+.I address
+if specified) are subscribed.
+.TP 5
+.B
+who \fIlist\fR
+.P
+Find out who is on the named
+.IR list .
+.TP 5
+.B
+info \fIlist\fR
+.P
+Retrieve the general introductory information for the named
+.IR list .
+.TP 5
+.B
+intro \fIlist\fR
+.P
+Retrieve the introductory message sent to new users
+of
+.IR list .
+Non-subscribers may not be able to retrieve this.
+.TP 5
+.B
+lists
+.P
+Show the lists served by this Majordomo server. It will also show a 50
+character list description if one has been provided.
+.TP 5
+.B
+help
+.P
+Retrieve an informational message, a brief synopsis of the user portion of
+this manual page.
+.TP 5
+.B
+end
+.P
+Stop processing commands (useful if your mailer adds a signature).
+.PP
+A command may be split across multiple lines if all of the lines in
+the command except the last end with a backslash "\\". 
+.PP
+In addition, the owner of the list can issue the following commands:
+.TP 5
+.B
+approve \fIpassword\fR subscribe \fIlist\fR \fIaddress\fR
+.P
+Instruct Majordomo to add 
+.I address
+to
+.IR list .
+The password is required to authenticate the list owner.  This is very weak
+authentication as the password is transmitted in the clear in an e-mail
+message. No claims are made that it will provide anything other than
+rudimentary protection against abuse of the Majordomo server.
+.TP 5
+.B
+approve \fIpassword\fR unsubscribe \fIlist\fR \fIaddress\fR
+.P
+Instruct Majordomo to delete
+.I address
+from
+.IR list .
+The password is required to authenticate the list owner.  See the comments
+above regarding the password.
+.TP 5
+.B
+newinfo \fIlist\fR \fIpassword\fR
+.P
+Update the informational message for
+.I list
+with the text which follows on subsequent lines.  No formatting of the
+message occurs, so the list owner should be careful to constrain the message
+to eighty columns.  Majordomo will include everything up to the string
+.B EOF
+or to the end of the mail message, whichever comes first.  This is useful in
+case the owner wants to verify the new message immediately, e.g.,
+.sp 1
+.RS 10
+To: majordomo
+.sp 0
+newinfo list password
+.sp
+This is new information for the "list" list.
+.sp
+EOF
+.sp 0
+info list
+.sp
+.RE
+.RS 5
+This will simultaneously update the information for the list, and then
+retrieve it for verification.  Note that blank lines are preserved in the
+message.
+.RE
+.TP 5
+.B
+newintro \fIlist\fR \fIpassword\fR
+.P
+Similar to
+.I newinfo ,
+but updates the (optional) introductory message sent to new
+.I list
+subscribers.
+.B
+passwd \fIlist\fR \fIold-password\fR \fInew-password\fR
+.P
+Replace the password for
+.I list
+with
+.IR new-password .
+.TP 5
+.B
+config \fIlist\fR \fIpassword\fR
+.P
+retrieve a self-documenting configuration file for
+the list <list>.  The \fIpassword\fR can be the password
+contained in the file <listname>.passwd or the
+admin_password in the configuration file.
+.TP 5
+.B
+newconfig \fIlist\fR \fIpassword\fR
+.P
+Validates and installs a new configuration file. The config file
+includes everything up to the string
+.B EOF
+or to the end of the mail message, whichever comes first. The config
+file is expected to be a complete config file as returned by the
+"config" command.  Incremental changing of the config file is not yet
+supported.  As soon as the config file is validated and installed its
+settings are available for use. This is useful to remember if you have
+multiple commands in your mail message since they will be subject to
+the settings of the new config file.  If there is an error in the
+config file (incorrect value...), the config file will not be accepted
+and the error message identifying the problem line(s) will be returned
+to the sender. Note that only the errors are returned to the
+sender not the entire config file.
+.TP 5
+.B
+writeconfig \fIlist\fR \fIpassword\fR 
+.P
+Write a new config in standard form. All of the config
+file documentation is optional. Only the keywords and
+values are necessary. If a config file, stripped of
+all comments is installed using newconfig, that is
+what is returned by config.  Writeconfig forces a
+rewrite of the config file with all comments and
+default values in place. It is useful to use after an
+upgrade of majordomo since it will add the new
+keywords for people to change. It also updates the
+documentation in the file if that has changed.
+.TP 5
+.B mkdigest
+.I digest-list-name
+[
+.I outgoing-address
+]
+.I password
+.P
+This will force a digest for the specified list to be created. It is
+most useful if you don't have an account on the machine that handles
+the digest for your list.
+The optional
+.I outgoing-address
+will override the default address,
+.IR listname -outgoing ,
+for distributing the digests;
+this is usually done for security.
+.SH CONFIGURATION
+(Note that this section has not been updated to majordomo version 1.90).
+.B Majordomo
+supports
+.I open
+and
+.I closed
+lists.  An
+.I open
+list is one to which anyone can subscribe themselves.  A subscription
+request sent to
+.B Majordomo
+for a
+.I closed
+list is forwarded to the owner of the list for approval.  If a user tries to
+subscribe an address which is different from their own (for example, a local
+list exploder),
+.B Majordomo
+will forward the request to the list owner for approval, regardless of the
+open or closed status of the list.
+.PP
+.B Majordomo
+depends on the existence of certain system mail aliases.  The first three
+are for running the perl script on incoming e-mail and specifying the
+responsible person in charge of the server:
+.sp 1
+majordomo: "|/usr/local/mail/majordomo/wrapper majordomo"
+.sp 0
+majordomo-owner: brent
+.sp 0
+owner-majordomo: brent
+.sp 1
+These next few aliases are for a list called "sample":
+.sp 1
+sample: :include:/usr/local/mail/lists/sample
+.sp 0
+owner-sample: sample-owner
+.sp 0
+sample-request: "|/usr/local/mail/majordomo/wrapper request-answer sample"
+.sp 0
+owner-sample-request: sample-owner
+.sp 0
+sample-owner: brent
+.sp 0
+sample-approval: brent
+.sp 1
+
+.SH FILES
+/etc/majordomo.cf
+.sp 0
+/usr/local/lib/mail/majordomo/
+
+.SH BUGS
+This man page has not been fully updated to conform to majordomo 1.90.
+
+.SH AUTHORS
+Majordomo and most of the ancillary perl code was written by Brent Chapman,
+<brent@GreatCircle.COM>.  The latest version of the code is available by
+anonymous FTP from FTP.GreatCircle.COM, in directory pub/majordomo.
+This man page was written by Jim Duncan, <jim@math.psu.edu>. Minimal
+update of the man page by John Rouillard <rouilj@cs.umb.edu>.