a
This commit is contained in:
137
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/approve.1
vendored
Normal file
137
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/approve.1
vendored
Normal file
@@ -0,0 +1,137 @@
|
||||
'\" t
|
||||
.TH APPROVE 1
|
||||
.SH NAME
|
||||
approve \- approve a Majordomo request
|
||||
.SH SYNOPSIS
|
||||
.B approve [filename]
|
||||
.SH "DESCRIPTION"
|
||||
.B approve
|
||||
automates the task of replying to an approval request from Majordomo. Input
|
||||
is the e-mail message containing Majordomo's request, read from
|
||||
.IR filename ,
|
||||
or read from standard input if no filename is specified.
|
||||
.PP
|
||||
.B approve
|
||||
currently understands two types of requests; those requesting
|
||||
subscription to a
|
||||
.I closed
|
||||
list, and those which bounced due to a lack of permission to post to a
|
||||
moderated, or
|
||||
.IR private ,
|
||||
mailing list.
|
||||
.B approve
|
||||
reads the body of the message from Majordomo to determine the appropriate
|
||||
action. Assuming a message containing a subscription request like the
|
||||
following:
|
||||
.sp 1
|
||||
.RS 3
|
||||
From: Majordomo@This.COM
|
||||
.sp 0
|
||||
To: this-list-approval@This.COM
|
||||
.sp 1
|
||||
Joe User <User@Fubar.COM> requests you approve the following:
|
||||
.sp 1
|
||||
.RS 3
|
||||
subscribe this-list Joe User <User@Fubar.COM>
|
||||
.RE
|
||||
.sp 1
|
||||
If you approve, send a line such as the following to Majordomo@This.COM:
|
||||
.sp 1
|
||||
.RS 3
|
||||
approve PASSWD subscribe this-list Joe User <User@Fubar.COM>
|
||||
.RE
|
||||
.RE
|
||||
.sp 1
|
||||
then running
|
||||
.B approve
|
||||
on the message by saving it in a file, e.g.,
|
||||
.sp 1
|
||||
.RS 3
|
||||
approve /tmp/request
|
||||
.RE
|
||||
.sp 1
|
||||
or
|
||||
.sp 1
|
||||
.RS 3
|
||||
approve < /tmp/request
|
||||
.RE
|
||||
.sp 1
|
||||
will result in the following reply to Majordomo:
|
||||
.sp 1
|
||||
.RS 3
|
||||
To: Majordomo@This.COM
|
||||
.sp 1
|
||||
approve PASSWD subscribe this-list User@Fubar.COM (Joe User)
|
||||
.sp 1
|
||||
.RE
|
||||
If
|
||||
.B approve
|
||||
is on the user's path, then it's possible to execute it via a shell escape,
|
||||
piping the current message to
|
||||
.B approve
|
||||
from a mail program, e.g.,
|
||||
.sp
|
||||
.RS 3
|
||||
!approve
|
||||
.RE
|
||||
.sp
|
||||
would
|
||||
.I approve
|
||||
the current message in /usr/ucb/Mail.
|
||||
.PP
|
||||
If, in the latter case, the "Subject:" line of the request from Majordomo is
|
||||
"BOUNCE <list>: <reason>", the message is treated as a posting rejected by
|
||||
.B resend
|
||||
for some reason, and is reformatted with appropriate "Approved:" headers to
|
||||
cause it to succeed, and then it is resubmitted to Majordomo for posting.
|
||||
This provides an easy mechanism for the moderator of a mailing list to
|
||||
approve postings to the list.
|
||||
.SH CONFIGURATION
|
||||
.B approve
|
||||
assumes that the
|
||||
.I approve
|
||||
password for each list is the same as the
|
||||
.I approval
|
||||
password used by
|
||||
.BR resend ,
|
||||
and that this password is stored
|
||||
in a file called
|
||||
.I .majordomo
|
||||
in the user's home directory. The file has the following format:
|
||||
.RS 5
|
||||
.TS
|
||||
l l l .
|
||||
.sp
|
||||
this-list passwd1 Majordomo@This.COM
|
||||
other-list passwd2 Majordomo@Other.GOV
|
||||
.sp
|
||||
.TE
|
||||
.RE
|
||||
The first column specifies the name of the mailing list, the second column
|
||||
specifies the list-owner's password for the given list, and the third column
|
||||
specifies the e-mail address of the associated Majordomo server. It is
|
||||
assumed that the value in the third column is an Internet-style
|
||||
"something@somewhere" address, and that postings for "List" should be sent
|
||||
to "List@somewhere". Since this file
|
||||
.B only
|
||||
needs to be read by the user, it should be mode 600 to protect the
|
||||
passwords.
|
||||
.SH FILES
|
||||
~/.majordomo
|
||||
.sp 0
|
||||
/usr/local/lib/mail/majordomo/
|
||||
.SH SEE ALSO
|
||||
majordomo(8),perl(1),resend(1).
|
||||
.SH BUGS
|
||||
There is no direct support for MH(1), so MH users will have to run
|
||||
.B approve
|
||||
directly on the message file in their inbox.
|
||||
.sp
|
||||
The
|
||||
.I .majordomo
|
||||
file requires an at-sign, "@", in the address of the Majordomo server, even
|
||||
if it colocated on the same system as the list-owner.
|
||||
.SH AUTHORS
|
||||
Majordomo and most of the ancillary perl code was written by Brent Chapman,
|
||||
<brent@GreatCircle.COM>.
|
||||
This man page was written by Jim Duncan, <jim@math.psu.edu>.
|
||||
132
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/approve.man
vendored
Normal file
132
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/approve.man
vendored
Normal file
@@ -0,0 +1,132 @@
|
||||
|
||||
|
||||
|
||||
APPROVE(1) USER COMMANDS APPROVE(1)
|
||||
|
||||
|
||||
|
||||
NAME
|
||||
approve - approve a Majordomo request
|
||||
|
||||
SYNOPSIS
|
||||
approve [filename]
|
||||
|
||||
DESCRIPTION
|
||||
approve automates the task of replying to an approval
|
||||
request from Majordomo. Input is the e-mail message con-
|
||||
taining Majordomo's request, read from _f_i_l_e_n_a_m_e, or read
|
||||
from standard input if no filename is specified.
|
||||
|
||||
approve currently understands two types of requests; those
|
||||
requesting subscription to a _c_l_o_s_e_d list, and those which
|
||||
bounced due to a lack of permission to post to a moderated,
|
||||
or _p_r_i_v_a_t_e, mailing list. approve reads the body of the
|
||||
message from Majordomo to determine the appropriate action.
|
||||
Assuming a message containing a subscription request like
|
||||
the following:
|
||||
|
||||
From: Majordomo@This.COM
|
||||
To: this-list-approval@This.COM
|
||||
|
||||
Joe User <User@Fubar.COM> requests you approve the fol-
|
||||
lowing:
|
||||
|
||||
subscribe this-list Joe User <User@Fubar.COM>
|
||||
|
||||
If you approve, send a line such as the following to
|
||||
Majordomo@This.COM:
|
||||
|
||||
approve PASSWD subscribe this-list Joe User
|
||||
<User@Fubar.COM>
|
||||
|
||||
then running approve on the message by saving it in a file,
|
||||
e.g.,
|
||||
|
||||
approve /tmp/request
|
||||
|
||||
or
|
||||
|
||||
approve < /tmp/request
|
||||
|
||||
will result in the following reply to Majordomo:
|
||||
|
||||
To: Majordomo@This.COM
|
||||
|
||||
approve PASSWD subscribe this-list User@Fubar.COM (Joe
|
||||
User)
|
||||
|
||||
If approve is on the user's path, then it's possible to exe-
|
||||
cute it via a shell escape, piping the current message to
|
||||
|
||||
|
||||
|
||||
Sun Release 4.1 Last change: 1
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
APPROVE(1) USER COMMANDS APPROVE(1)
|
||||
|
||||
|
||||
|
||||
approve from a mail program, e.g.,
|
||||
|
||||
!approve
|
||||
|
||||
would _a_p_p_r_o_v_e the current message in /usr/ucb/Mail.
|
||||
|
||||
If, in the latter case, the "Subject:" line of the request
|
||||
from Majordomo is "BOUNCE <list>: <reason>", the message is
|
||||
treated as a posting rejected by resend for some reason, and
|
||||
is reformatted with appropriate "Approved:" headers to cause
|
||||
it to succeed, and then it is resubmitted to Majordomo for
|
||||
posting. This provides an easy mechanism for the moderator
|
||||
of a mailing list to approve postings to the list.
|
||||
|
||||
CONFIGURATION
|
||||
approve assumes that the _a_p_p_r_o_v_e password for each list is
|
||||
the same as the _a_p_p_r_o_v_a_l password used by resend, and that
|
||||
this password is stored in a file called ._m_a_j_o_r_d_o_m_o in the
|
||||
user's home directory. The file has the following format:
|
||||
|
||||
this-list passwd1 Majordomo@This.COM
|
||||
other-list passwd2 Majordomo@Other.GOV
|
||||
|
||||
The first column specifies the name of the mailing list, the
|
||||
second column specifies the list-owner's password for the
|
||||
given list, and the third column specifies the e-mail
|
||||
address of the associated Majordomo server. It is assumed
|
||||
that the value in the third column is an Internet-style
|
||||
"something@somewhere" address, and that postings for "List"
|
||||
should be sent to "List@somewhere". Since this file only
|
||||
needs to be read by the user, it should be mode 600 to pro-
|
||||
tect the passwords.
|
||||
|
||||
FILES
|
||||
~/.majordomo
|
||||
/usr/local/lib/mail/majordomo/
|
||||
|
||||
SEE ALSO
|
||||
majordomo(8),perl(1),resend(1).
|
||||
|
||||
BUGS
|
||||
There is no direct support for MH(1), so MH users will have
|
||||
to run approve directly on the message file in their inbox.
|
||||
|
||||
The ._m_a_j_o_r_d_o_m_o file requires an at-sign, "@", in the address
|
||||
of the Majordomo server, even if it colocated on the same
|
||||
system as the list-owner.
|
||||
|
||||
AUTHORS
|
||||
Majordomo and most of the ancillary perl code was written by
|
||||
Brent Chapman, <brent@GreatCircle.COM>. This man page was
|
||||
written by Jim Duncan, <jim@math.psu.edu>.
|
||||
|
||||
|
||||
|
||||
Sun Release 4.1 Last change: 2
|
||||
|
||||
|
||||
|
||||
1
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/bounce-remind.1
vendored
Normal file
1
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/bounce-remind.1
vendored
Normal file
@@ -0,0 +1 @@
|
||||
.so man1/bounce.1
|
||||
198
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/bounce-remind.man
vendored
Normal file
198
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/bounce-remind.man
vendored
Normal file
@@ -0,0 +1,198 @@
|
||||
|
||||
|
||||
|
||||
bbbboooouuuunnnncccceeee((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV bbbboooouuuunnnncccceeee((((1111))))
|
||||
|
||||
|
||||
|
||||
NNNNAAAAMMMMEEEE
|
||||
bounce, bounce-remind - handle majordomo list subscribers
|
||||
whose mail is undeliverable
|
||||
|
||||
SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
|
||||
bbbboooouuuunnnncccceeee [[[[----dddd]]]] [[[[----ffff _c_o_n_f_i_g-_f_i_l_e ]]]] [[[[----mmmmaaaajjjjoooorrrrddddoooommmmoooo _s_e_r_v_e_r-_a_d_d_r_e_s_s ]]]]
|
||||
[[[[----uuuunnnnssssuuuubbbb]]]] _m_a_j_o_r_d_o_m_o-_l_i_s_t _u_s_e_r-_a_d_d_r_e_s_s
|
||||
|
||||
bbbboooouuuunnnncccceeee [[[[----dddd]]]] [[[[----ffff _c_o_n_f_i_g-_f_i_l_e ]]]] [[[[----mmmmaaaajjjjoooorrrrddddoooommmmoooo _s_e_r_v_e_r-_a_d_d_r_e_s_s ]]]]
|
||||
----eeeexxxxppppiiiirrrreeee [[[[----mmmmaaaaxxxxaaaaggggeeee _d_a_y_s ]]]] _b_o_u_n_c_e-_a_d_d_r_e_s_s-_f_i_l_e
|
||||
|
||||
bbbboooouuuunnnncccceeee----rrrreeeemmmmiiiinnnndddd
|
||||
|
||||
AAAAVVVVAAAAIIIILLLLAAAABBBBIIIILLLLIIIITTTTYYYY
|
||||
Provided with distributions of Majordomo.
|
||||
|
||||
DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
|
||||
bbbboooouuuunnnncccceeee and bbbboooouuuunnnncccceeee----rrrreeeemmmmiiiinnnndddd are perl scripts which help list
|
||||
owners handle subscribers whose mail is bouncing. Mail is
|
||||
"bounced" in this context when it is undeliverable because
|
||||
hosts or addresses are unreachable or because of other mail
|
||||
errors.
|
||||
|
||||
Mail is also "bounced" by the resend script for various
|
||||
administrative reasons; these bounces are described in
|
||||
aaaapppppppprrrroooovvvveeee(1).
|
||||
|
||||
When a list owner observes that an email address
|
||||
consistently causes mail errors, the owner may use bbbboooouuuunnnncccceeee to
|
||||
remove the address from the list and place the address on a
|
||||
special bbbboooouuuunnnncccceeeessss mailing list.
|
||||
|
||||
bbbboooouuuunnnncccceeee----rrrreeeemmmmiiiinnnndddd,,,, which should be run nightly by ccccrrrroooonnnn(4M),
|
||||
sends a message to each of the user addresses on the bbbboooouuuunnnncccceeeessss
|
||||
list, on the chance that the mail error has been corrected.
|
||||
The message informs the addressee that their mail has been
|
||||
undeliverable and that they have been removed from one or
|
||||
more majordomo lists. It also instructs them how to
|
||||
unsubscribe from the bbbboooouuuunnnncccceeeessss list and re-subscribe to the
|
||||
list of their choice.
|
||||
|
||||
bbbboooouuuunnnncccceeee can also be used to expire addresses off the bbbboooouuuunnnncccceeeessss
|
||||
list after a predetermined number of days.
|
||||
|
||||
If bbbboooouuuunnnncccceeee is invoked under a name that contains ``unsub'' it
|
||||
will simply unsubscribe the offending address from the
|
||||
majordomo list; it will not place the address on the bbbboooouuuunnnncccceeeessss
|
||||
list.
|
||||
|
||||
OOOOPPPPTTTTIIIIOOOONNNNSSSS
|
||||
These options relate to bbbboooouuuunnnncccceeee;;;; bbbboooouuuunnnncccceeee----rrrreeeemmmmiiiinnnndddd takes no
|
||||
arguments or options.
|
||||
|
||||
|
||||
|
||||
Page 1 (printed 9/24/96)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
bbbboooouuuunnnncccceeee((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV bbbboooouuuunnnncccceeee((((1111))))
|
||||
|
||||
|
||||
|
||||
----dddd Debug; print what would be done, but don't do it.
|
||||
|
||||
----ffff ccccoooonnnnffffiiiigggg----ffffiiiilllleeee
|
||||
Use the specified configuration file. The default
|
||||
is ~~~~////....mmmmaaaajjjjoooorrrrddddoooommmmoooo,,,, and the format for this file is
|
||||
described in the CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN section of the
|
||||
aaaapppppppprrrroooovvvveeee(1) man page. This file provides the
|
||||
list-owner's password for each list and the
|
||||
address of the corresponding Majordomo server.
|
||||
|
||||
----mmmmaaaajjjjoooorrrrddddoooommmmoooo sssseeeerrrrvvvveeeerrrr----aaaaddddddddrrrreeeessssssss
|
||||
Use this _s_e_r_v_e_r-_a_d_d_r_e_s_s for majordomo rather than
|
||||
the address from the configuration file.
|
||||
|
||||
----uuuunnnnssssuuuubbbb Unsubscribes the offending address from the
|
||||
majordomo list, without entering that address on
|
||||
the bbbboooouuuunnnncccceeeessss list. This is equivalent to invoking
|
||||
bbbboooouuuunnnncccceeee under a name containing ``unsub''.
|
||||
|
||||
----eeeexxxxppppiiiirrrreeee Expire entries from the specified bbbboooouuuunnnncccceeeessss list.
|
||||
|
||||
----mmmmaaaaxxxxaaaaggggeeee ddddaaaayyyyssss
|
||||
Expire entries older than ddddaaaayyyyssss.... The default is
|
||||
coded into the bbbboooouuuunnnncccceeee script as $$$$ddddeeeeffffaaaauuuulllltttt____mmmmaaaaxxxxaaaaggggeeee
|
||||
days. It is set to 21 days in the majordomo
|
||||
distribution.
|
||||
|
||||
OOOOPPPPEEEERRRRAAAANNNNDDDDSSSS
|
||||
mmmmaaaajjjjoooorrrrddddoooommmmoooo----lllliiiisssstttt
|
||||
The list from which the offending user-address
|
||||
should be removed.
|
||||
|
||||
uuuusssseeeerrrr----aaaaddddddddrrrreeeessssssss
|
||||
The address to which mail is currently
|
||||
undeliverable.
|
||||
|
||||
bbbboooouuuunnnncccceeee----aaaaddddddddrrrreeeessssssss----ffffiiiilllleeee
|
||||
The name of the file that contains the bbbboooouuuunnnncccceeeessss
|
||||
list.
|
||||
|
||||
CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN
|
||||
If bbbboooouuuunnnncccceeee is going to be used only to unsubscribe users, a
|
||||
link can be created whose name contains ``unsub'' so that
|
||||
users could be unsubscribed simply by typing
|
||||
|
||||
unsub firewalls-digest fury@world.std.com
|
||||
|
||||
for example.
|
||||
|
||||
In any case, a configuration file must exist and must
|
||||
contain the names of the owner's lists, along with their
|
||||
respective passwords and the email address of the associated
|
||||
|
||||
|
||||
|
||||
Page 2 (printed 9/24/96)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
bbbboooouuuunnnncccceeee((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV bbbboooouuuunnnncccceeee((((1111))))
|
||||
|
||||
|
||||
|
||||
Majordomo server. The format of this file is given in the
|
||||
CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN section of the aaaapppppppprrrroooovvvveeee(1) man page. The
|
||||
default name for this file is ~~~~////....mmmmaaaajjjjoooorrrrddddoooommmmoooo,,,, and the same
|
||||
file can serve for both the aaaapppppppprrrroooovvvveeee and bbbboooouuuunnnncccceeee scripts.
|
||||
|
||||
The bbbboooouuuunnnncccceeeessss list, if it is used, must be created. It is
|
||||
like any other Majordomo list excepting that the priority of
|
||||
this list should be set to jjjjuuuunnnnkkkk and its owner and sender
|
||||
should be nnnnoooobbbbooooddddyyyy.... Of course, the ``nobody'' mail alias must
|
||||
exist; it is should be set to /dev/null. That is,
|
||||
|
||||
nobody: /dev/null
|
||||
|
||||
This will spare the human list owner as well as the
|
||||
postmaster from having to deal with mail bouncing from the
|
||||
bbbboooouuuunnnncccceeeessss list.
|
||||
|
||||
A ccccrrrroooonnnn(1M) job should be set up to run bbbboooouuuunnnncccceeee----rrrreeeemmmmiiiinnnndddd every
|
||||
night. bbbboooouuuunnnncccceeee----rrrreeeemmmmiiiinnnndddd must run on the same server as the
|
||||
bbbboooouuuunnnncccceeeessss list; it mails a message to everyone on the list
|
||||
advising them that they have been removed from one or more
|
||||
Majordomo lists and instructs them how to get off the
|
||||
bbbboooouuuunnnncccceeeessss list and back on the list of their choice.
|
||||
|
||||
bbbboooouuuunnnncccceeee can only expire addresses if it has a copy of the
|
||||
bbbboooouuuunnnncccceeeessss subscriber file, so this can either be run on the
|
||||
server occasionally by the Majordomo administrator or by a
|
||||
cron job. It can also be run remotely with a copy of the
|
||||
bbbboooouuuunnnncccceeeessss file retrived by the use of the ``who bounces''
|
||||
command to majordomo.
|
||||
|
||||
FFFFIIIILLLLEEEESSSS
|
||||
////eeeettttcccc////aaaalllliiiiaaaasssseeeessss
|
||||
////eeeettttcccc////mmmmaaaajjjjoooorrrrddddoooommmmoooo....ccccffff
|
||||
|
||||
SSSSEEEEEEEE AAAALLLLSSSSOOOO
|
||||
mmmmaaaajjjjoooorrrrddddoooommmmoooo((((8888)))),,,,aaaapppppppprrrroooovvvveeee((((1111))))
|
||||
|
||||
AAAAUUUUTTTTHHHHOOOORRRR
|
||||
Majordomo and most of the ancillary perl code was written by
|
||||
Brent Chapman <brent@GreatCircle.COM>. Majordomo is
|
||||
available via anonymous FTP from FTP.GreatCircle.COM, in the
|
||||
directory pub/majordomo. This man page was written by Kevin
|
||||
Kelleher <fury@world.std.com>.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Page 3 (printed 9/24/96)
|
||||
|
||||
|
||||
|
||||
221
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/bounce.1
vendored
Normal file
221
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/bounce.1
vendored
Normal file
@@ -0,0 +1,221 @@
|
||||
.TH bounce 1
|
||||
.SH NAME
|
||||
bounce, bounce-remind \- handle majordomo list subscribers whose mail is undeliverable
|
||||
.LP
|
||||
.SH SYNOPSIS
|
||||
.B bounce [\-d] [\-f
|
||||
.I config-file
|
||||
.B ] [\-majordomo
|
||||
.I server-address
|
||||
.B ] [\-unsub]
|
||||
.I majordomo-list user-address
|
||||
.LP
|
||||
.B bounce [\-d] [\-f
|
||||
.I config-file
|
||||
.B ] [\-majordomo
|
||||
.I server-address
|
||||
.B ] \-expire [\-maxage
|
||||
.I days
|
||||
.B ]
|
||||
.I bounce-address-file
|
||||
.LP
|
||||
.B bounce-remind
|
||||
.LP
|
||||
.SH AVAILABILITY
|
||||
Provided with distributions of Majordomo.
|
||||
.LP
|
||||
.SH DESCRIPTION
|
||||
.B bounce
|
||||
and
|
||||
.B bounce-remind
|
||||
are perl scripts which help list owners
|
||||
handle subscribers whose mail is bouncing. Mail is "bounced"
|
||||
in this context when it is undeliverable because hosts or
|
||||
addresses are unreachable or because of other mail errors.
|
||||
.LP
|
||||
Mail is also "bounced" by the resend script for various administrative
|
||||
reasons; these bounces are described in
|
||||
.BR approve (1).
|
||||
.LP
|
||||
When a list owner observes that an email address consistently causes
|
||||
mail errors, the owner may use
|
||||
.B bounce
|
||||
to remove the address from the list and place the address on a special
|
||||
.BR bounces
|
||||
mailing list.
|
||||
.LP
|
||||
.B bounce-remind,
|
||||
which should be run nightly by
|
||||
.BR cron (4M),
|
||||
sends a message to each of the user addresses on the
|
||||
.BR bounces
|
||||
list, on the chance that the mail error has been corrected.
|
||||
The message informs the addressee that their mail has been
|
||||
undeliverable and that they have been removed from one or
|
||||
more majordomo lists. It also instructs them how to unsubscribe
|
||||
from the
|
||||
.BR bounces
|
||||
list and re-subscribe to the list of their choice.
|
||||
.LP
|
||||
.B bounce
|
||||
can also be used to expire addresses off the
|
||||
.BR bounces
|
||||
list after a predetermined number of days.
|
||||
.LP
|
||||
If
|
||||
.B bounce
|
||||
is invoked under a name that contains ``unsub'' it will simply
|
||||
unsubscribe the offending address from the majordomo list; it
|
||||
will not place the address on the
|
||||
.BR bounces
|
||||
list.
|
||||
.LP
|
||||
.SH OPTIONS
|
||||
These options relate to
|
||||
.B bounce; bounce-remind
|
||||
takes no arguments or options.
|
||||
.LP
|
||||
.TP 10
|
||||
.B \-d
|
||||
Debug; print what would be done, but don't do it.
|
||||
.TP
|
||||
.B \-f config-file
|
||||
Use the specified configuration file. The default is
|
||||
.BR ~/.majordomo,
|
||||
and the format for this file is described in the
|
||||
.BR CONFIGURATION
|
||||
section of the
|
||||
.BR approve (1)
|
||||
man page. This file provides the list-owner's password for
|
||||
each list and the address of the corresponding Majordomo
|
||||
server.
|
||||
.TP
|
||||
.B \-majordomo server-address
|
||||
Use this
|
||||
.IR server-address
|
||||
for majordomo rather than the address from the configuration file.
|
||||
.TP
|
||||
.B \-unsub
|
||||
Unsubscribes the offending address from the majordomo list,
|
||||
without entering that address on the
|
||||
.BR bounces
|
||||
list. This is equivalent to invoking
|
||||
.BR bounce
|
||||
under a name containing ``unsub''.
|
||||
.TP
|
||||
.B \-expire
|
||||
Expire entries from the specified
|
||||
.BR bounces
|
||||
list.
|
||||
.TP
|
||||
.B \-maxage days
|
||||
Expire entries older than
|
||||
.BI days.
|
||||
The default is coded into the
|
||||
.BR bounce
|
||||
script as
|
||||
.BI $default_maxage
|
||||
days. It is set to 21 days in the majordomo distribution.
|
||||
.LP
|
||||
.SH OPERANDS
|
||||
.TP 10
|
||||
.B majordomo-list
|
||||
The list from which the offending user-address should be removed.
|
||||
.TP
|
||||
.B user-address
|
||||
The address to which mail is currently undeliverable.
|
||||
.TP
|
||||
.B bounce-address-file
|
||||
The name of the file that contains the
|
||||
.BR bounces
|
||||
list.
|
||||
.LP
|
||||
.SH CONFIGURATION
|
||||
If
|
||||
.B bounce
|
||||
is going to be used only to unsubscribe users, a link can be
|
||||
created whose name contains ``unsub'' so that users could be
|
||||
unsubscribed simply by typing
|
||||
.sp 1
|
||||
.RS 3
|
||||
unsub firewalls-digest fury@world.std.com
|
||||
.RE
|
||||
.sp 1
|
||||
for example.
|
||||
.LP
|
||||
In any case, a configuration file must exist and must contain
|
||||
the names of the owner's lists, along with their respective
|
||||
passwords and the email address of the associated Majordomo
|
||||
server. The format of this file is given in the
|
||||
.B CONFIGURATION
|
||||
section of the
|
||||
.BR approve (1)
|
||||
man page. The default name for this file is
|
||||
.BR ~/.majordomo,
|
||||
and the same file can serve for both the
|
||||
.B approve
|
||||
and
|
||||
.B bounce
|
||||
scripts.
|
||||
.LP
|
||||
The
|
||||
.B bounces
|
||||
list, if it is used, must be created. It is like any other
|
||||
Majordomo list excepting that the priority of this list
|
||||
should be set to
|
||||
.B junk
|
||||
and its owner and sender should be
|
||||
.B nobody.
|
||||
Of course, the ``nobody'' mail alias must exist; it is should
|
||||
be set to /dev/null. That is,
|
||||
.sp 1
|
||||
.RS 3
|
||||
nobody: /dev/null
|
||||
.RE
|
||||
.sp 1
|
||||
This will spare the human list owner as well as the postmaster
|
||||
from having to deal with mail bouncing from the
|
||||
.B bounces
|
||||
list.
|
||||
.LP
|
||||
A
|
||||
.BR cron (1M)
|
||||
job should be set up to run
|
||||
.B bounce-remind
|
||||
every night.
|
||||
.B bounce-remind
|
||||
must run on the same server as the
|
||||
.B bounces
|
||||
list; it mails a message to everyone on the list advising
|
||||
them that they have been removed from one or more Majordomo
|
||||
lists and instructs them how to get off the
|
||||
.B bounces
|
||||
list and back on the list of their choice.
|
||||
.LP
|
||||
.B bounce
|
||||
can only expire addresses if it has a copy of the
|
||||
.B bounces
|
||||
subscriber file, so this can either be run on the server
|
||||
occasionally by the Majordomo administrator or by a cron
|
||||
job. It can also be run remotely with a copy of the
|
||||
.B bounces
|
||||
file retrived by the use of the ``who bounces'' command
|
||||
to majordomo.
|
||||
.LP
|
||||
.SH FILES
|
||||
.PD 0
|
||||
.TP 20
|
||||
.B /etc/aliases
|
||||
.TP
|
||||
.B /etc/majordomo.cf
|
||||
.PD
|
||||
.LP
|
||||
.SH SEE ALSO
|
||||
.B majordomo(8),approve(1)
|
||||
.LP
|
||||
.SH AUTHOR
|
||||
Majordomo and most of the ancillary perl code was written by
|
||||
Brent Chapman <brent@GreatCircle.COM>.
|
||||
Majordomo is available via anonymous FTP
|
||||
from FTP.GreatCircle.COM, in the directory pub/majordomo. This
|
||||
man page was written by Kevin Kelleher <fury@world.std.com>.
|
||||
198
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/bounce.man
vendored
Normal file
198
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/bounce.man
vendored
Normal file
@@ -0,0 +1,198 @@
|
||||
|
||||
|
||||
|
||||
bbbboooouuuunnnncccceeee((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV bbbboooouuuunnnncccceeee((((1111))))
|
||||
|
||||
|
||||
|
||||
NNNNAAAAMMMMEEEE
|
||||
bounce, bounce-remind - handle majordomo list subscribers
|
||||
whose mail is undeliverable
|
||||
|
||||
SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
|
||||
bbbboooouuuunnnncccceeee [[[[----dddd]]]] [[[[----ffff _c_o_n_f_i_g-_f_i_l_e ]]]] [[[[----mmmmaaaajjjjoooorrrrddddoooommmmoooo _s_e_r_v_e_r-_a_d_d_r_e_s_s ]]]]
|
||||
[[[[----uuuunnnnssssuuuubbbb]]]] _m_a_j_o_r_d_o_m_o-_l_i_s_t _u_s_e_r-_a_d_d_r_e_s_s
|
||||
|
||||
bbbboooouuuunnnncccceeee [[[[----dddd]]]] [[[[----ffff _c_o_n_f_i_g-_f_i_l_e ]]]] [[[[----mmmmaaaajjjjoooorrrrddddoooommmmoooo _s_e_r_v_e_r-_a_d_d_r_e_s_s ]]]]
|
||||
----eeeexxxxppppiiiirrrreeee [[[[----mmmmaaaaxxxxaaaaggggeeee _d_a_y_s ]]]] _b_o_u_n_c_e-_a_d_d_r_e_s_s-_f_i_l_e
|
||||
|
||||
bbbboooouuuunnnncccceeee----rrrreeeemmmmiiiinnnndddd
|
||||
|
||||
AAAAVVVVAAAAIIIILLLLAAAABBBBIIIILLLLIIIITTTTYYYY
|
||||
Provided with distributions of Majordomo.
|
||||
|
||||
DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
|
||||
bbbboooouuuunnnncccceeee and bbbboooouuuunnnncccceeee----rrrreeeemmmmiiiinnnndddd are perl scripts which help list
|
||||
owners handle subscribers whose mail is bouncing. Mail is
|
||||
"bounced" in this context when it is undeliverable because
|
||||
hosts or addresses are unreachable or because of other mail
|
||||
errors.
|
||||
|
||||
Mail is also "bounced" by the resend script for various
|
||||
administrative reasons; these bounces are described in
|
||||
aaaapppppppprrrroooovvvveeee(1).
|
||||
|
||||
When a list owner observes that an email address
|
||||
consistently causes mail errors, the owner may use bbbboooouuuunnnncccceeee to
|
||||
remove the address from the list and place the address on a
|
||||
special bbbboooouuuunnnncccceeeessss mailing list.
|
||||
|
||||
bbbboooouuuunnnncccceeee----rrrreeeemmmmiiiinnnndddd,,,, which should be run nightly by ccccrrrroooonnnn(4M),
|
||||
sends a message to each of the user addresses on the bbbboooouuuunnnncccceeeessss
|
||||
list, on the chance that the mail error has been corrected.
|
||||
The message informs the addressee that their mail has been
|
||||
undeliverable and that they have been removed from one or
|
||||
more majordomo lists. It also instructs them how to
|
||||
unsubscribe from the bbbboooouuuunnnncccceeeessss list and re-subscribe to the
|
||||
list of their choice.
|
||||
|
||||
bbbboooouuuunnnncccceeee can also be used to expire addresses off the bbbboooouuuunnnncccceeeessss
|
||||
list after a predetermined number of days.
|
||||
|
||||
If bbbboooouuuunnnncccceeee is invoked under a name that contains ``unsub'' it
|
||||
will simply unsubscribe the offending address from the
|
||||
majordomo list; it will not place the address on the bbbboooouuuunnnncccceeeessss
|
||||
list.
|
||||
|
||||
OOOOPPPPTTTTIIIIOOOONNNNSSSS
|
||||
These options relate to bbbboooouuuunnnncccceeee;;;; bbbboooouuuunnnncccceeee----rrrreeeemmmmiiiinnnndddd takes no
|
||||
arguments or options.
|
||||
|
||||
|
||||
|
||||
Page 1 (printed 9/24/96)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
bbbboooouuuunnnncccceeee((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV bbbboooouuuunnnncccceeee((((1111))))
|
||||
|
||||
|
||||
|
||||
----dddd Debug; print what would be done, but don't do it.
|
||||
|
||||
----ffff ccccoooonnnnffffiiiigggg----ffffiiiilllleeee
|
||||
Use the specified configuration file. The default
|
||||
is ~~~~////....mmmmaaaajjjjoooorrrrddddoooommmmoooo,,,, and the format for this file is
|
||||
described in the CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN section of the
|
||||
aaaapppppppprrrroooovvvveeee(1) man page. This file provides the
|
||||
list-owner's password for each list and the
|
||||
address of the corresponding Majordomo server.
|
||||
|
||||
----mmmmaaaajjjjoooorrrrddddoooommmmoooo sssseeeerrrrvvvveeeerrrr----aaaaddddddddrrrreeeessssssss
|
||||
Use this _s_e_r_v_e_r-_a_d_d_r_e_s_s for majordomo rather than
|
||||
the address from the configuration file.
|
||||
|
||||
----uuuunnnnssssuuuubbbb Unsubscribes the offending address from the
|
||||
majordomo list, without entering that address on
|
||||
the bbbboooouuuunnnncccceeeessss list. This is equivalent to invoking
|
||||
bbbboooouuuunnnncccceeee under a name containing ``unsub''.
|
||||
|
||||
----eeeexxxxppppiiiirrrreeee Expire entries from the specified bbbboooouuuunnnncccceeeessss list.
|
||||
|
||||
----mmmmaaaaxxxxaaaaggggeeee ddddaaaayyyyssss
|
||||
Expire entries older than ddddaaaayyyyssss.... The default is
|
||||
coded into the bbbboooouuuunnnncccceeee script as $$$$ddddeeeeffffaaaauuuulllltttt____mmmmaaaaxxxxaaaaggggeeee
|
||||
days. It is set to 21 days in the majordomo
|
||||
distribution.
|
||||
|
||||
OOOOPPPPEEEERRRRAAAANNNNDDDDSSSS
|
||||
mmmmaaaajjjjoooorrrrddddoooommmmoooo----lllliiiisssstttt
|
||||
The list from which the offending user-address
|
||||
should be removed.
|
||||
|
||||
uuuusssseeeerrrr----aaaaddddddddrrrreeeessssssss
|
||||
The address to which mail is currently
|
||||
undeliverable.
|
||||
|
||||
bbbboooouuuunnnncccceeee----aaaaddddddddrrrreeeessssssss----ffffiiiilllleeee
|
||||
The name of the file that contains the bbbboooouuuunnnncccceeeessss
|
||||
list.
|
||||
|
||||
CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN
|
||||
If bbbboooouuuunnnncccceeee is going to be used only to unsubscribe users, a
|
||||
link can be created whose name contains ``unsub'' so that
|
||||
users could be unsubscribed simply by typing
|
||||
|
||||
unsub firewalls-digest fury@world.std.com
|
||||
|
||||
for example.
|
||||
|
||||
In any case, a configuration file must exist and must
|
||||
contain the names of the owner's lists, along with their
|
||||
respective passwords and the email address of the associated
|
||||
|
||||
|
||||
|
||||
Page 2 (printed 9/24/96)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
bbbboooouuuunnnncccceeee((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV bbbboooouuuunnnncccceeee((((1111))))
|
||||
|
||||
|
||||
|
||||
Majordomo server. The format of this file is given in the
|
||||
CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN section of the aaaapppppppprrrroooovvvveeee(1) man page. The
|
||||
default name for this file is ~~~~////....mmmmaaaajjjjoooorrrrddddoooommmmoooo,,,, and the same
|
||||
file can serve for both the aaaapppppppprrrroooovvvveeee and bbbboooouuuunnnncccceeee scripts.
|
||||
|
||||
The bbbboooouuuunnnncccceeeessss list, if it is used, must be created. It is
|
||||
like any other Majordomo list excepting that the priority of
|
||||
this list should be set to jjjjuuuunnnnkkkk and its owner and sender
|
||||
should be nnnnoooobbbbooooddddyyyy.... Of course, the ``nobody'' mail alias must
|
||||
exist; it is should be set to /dev/null. That is,
|
||||
|
||||
nobody: /dev/null
|
||||
|
||||
This will spare the human list owner as well as the
|
||||
postmaster from having to deal with mail bouncing from the
|
||||
bbbboooouuuunnnncccceeeessss list.
|
||||
|
||||
A ccccrrrroooonnnn(1M) job should be set up to run bbbboooouuuunnnncccceeee----rrrreeeemmmmiiiinnnndddd every
|
||||
night. bbbboooouuuunnnncccceeee----rrrreeeemmmmiiiinnnndddd must run on the same server as the
|
||||
bbbboooouuuunnnncccceeeessss list; it mails a message to everyone on the list
|
||||
advising them that they have been removed from one or more
|
||||
Majordomo lists and instructs them how to get off the
|
||||
bbbboooouuuunnnncccceeeessss list and back on the list of their choice.
|
||||
|
||||
bbbboooouuuunnnncccceeee can only expire addresses if it has a copy of the
|
||||
bbbboooouuuunnnncccceeeessss subscriber file, so this can either be run on the
|
||||
server occasionally by the Majordomo administrator or by a
|
||||
cron job. It can also be run remotely with a copy of the
|
||||
bbbboooouuuunnnncccceeeessss file retrived by the use of the ``who bounces''
|
||||
command to majordomo.
|
||||
|
||||
FFFFIIIILLLLEEEESSSS
|
||||
////eeeettttcccc////aaaalllliiiiaaaasssseeeessss
|
||||
////eeeettttcccc////mmmmaaaajjjjoooorrrrddddoooommmmoooo....ccccffff
|
||||
|
||||
SSSSEEEEEEEE AAAALLLLSSSSOOOO
|
||||
mmmmaaaajjjjoooorrrrddddoooommmmoooo((((8888)))),,,,aaaapppppppprrrroooovvvveeee((((1111))))
|
||||
|
||||
AAAAUUUUTTTTHHHHOOOORRRR
|
||||
Majordomo and most of the ancillary perl code was written by
|
||||
Brent Chapman <brent@GreatCircle.COM>. Majordomo is
|
||||
available via anonymous FTP from FTP.GreatCircle.COM, in the
|
||||
directory pub/majordomo. This man page was written by Kevin
|
||||
Kelleher <fury@world.std.com>.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Page 3 (printed 9/24/96)
|
||||
|
||||
|
||||
|
||||
357
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/digest.1
vendored
Normal file
357
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/digest.1
vendored
Normal file
@@ -0,0 +1,357 @@
|
||||
.TH digest 1
|
||||
.SH NAME
|
||||
digest \- receive a file for a digest, or create and mail a digest
|
||||
.LP
|
||||
.SH SYNOPSIS
|
||||
.B digest \-r|R|m|p \-C \-l
|
||||
.I majordomo-listname recipient
|
||||
.LP
|
||||
.B digest \-r|R|m|p
|
||||
[
|
||||
.B \-c
|
||||
.I configuration-file
|
||||
]
|
||||
.LP
|
||||
.SH AVAILABILITY
|
||||
Provided with distributions of Majordomo.
|
||||
.LP
|
||||
.SH DESCRIPTION
|
||||
The digest script is a perl script which automates the
|
||||
management of digests of electronic mail. It can be
|
||||
run in a standalone configuration or as part of Majordomo.
|
||||
.LP
|
||||
It requires two directories: a work directory and an
|
||||
archive directory. Incoming email messages are held
|
||||
in the work directory until they are collected into a
|
||||
digest. The digests are created and stored
|
||||
in the archive directory.
|
||||
.LP
|
||||
Incoming email messages are given
|
||||
numerical names starting with ``001'' and are numbered in
|
||||
order of arrival. The digests are named according to volume
|
||||
and number. For example, the filename ``v01.n028'' indicates
|
||||
volume 1, number 28 of the digest.
|
||||
.LP
|
||||
It should be noted that digest needs a configuration file
|
||||
to define all of its operating parameters. If no such
|
||||
file is specified, digest will use the
|
||||
.SB $HOME/.digestrc
|
||||
file.
|
||||
.LP
|
||||
Several aspects of digest configuration determine how and
|
||||
when a digest is created. A digest can be created at
|
||||
regular intervals (as long as there are incoming messages)
|
||||
or whenever certain configurable conditions are met. These
|
||||
conditions are: how large the digest can be (in characters),
|
||||
how long the digest can be (in lines), and how old the messages
|
||||
in the digest can be (in days).
|
||||
.LP
|
||||
.SH OPTIONS
|
||||
.TP 10
|
||||
.B \-r
|
||||
Receive an email message via standard input
|
||||
and place the file into the working directory.
|
||||
If any one of the conditions for digest creation
|
||||
are met, create and mail a digest. These conditions
|
||||
are the same as those described under option
|
||||
.BR \-p.
|
||||
.TP
|
||||
.B \-R
|
||||
Similar to
|
||||
.BR \-r,
|
||||
except that it will not create a digest. It simply
|
||||
places the message in the work directory and stops.
|
||||
.TP
|
||||
.B \-m
|
||||
If there are any numbered files in the working
|
||||
directory, create and mail a digest. Store the
|
||||
digest in the archive directory. This is the
|
||||
option used by majordomo's mkdigest command.
|
||||
.TP
|
||||
.B \-p
|
||||
Conditionally creates a digest. If any one of the
|
||||
conditions for digest creation are met, the digest
|
||||
is created and sent. There are three conditions,
|
||||
which are connected to three limits: the digest
|
||||
size in characters, the digest length in lines, and
|
||||
the age of the oldest message in days. If one of the
|
||||
files is older than the age limit, a digest is created.
|
||||
If the sum of the messages exceeds either of the size
|
||||
limits, a digest is created. The size limit in characters
|
||||
must be configured; the other two limits are optional.
|
||||
.TP
|
||||
.B \-c configuration-file
|
||||
Use the parameters defined in
|
||||
.IR configuration-file.
|
||||
.TP
|
||||
.B \-C
|
||||
Read the majordomo configuration file
|
||||
(either /etc/majordomo.cf or ~majordomo/majordomo.cf)
|
||||
and the configuration file for the Majordomo list specified in the
|
||||
.BR \-l
|
||||
option to define operational parameters. If both
|
||||
.BR \-C
|
||||
and
|
||||
.BR \-c
|
||||
options are specified (not recommended) only the
|
||||
.BR \-C
|
||||
option will be used.
|
||||
.TP
|
||||
.B \-l majordomo-listname
|
||||
This option is ignored if used without the
|
||||
.BR \-C
|
||||
option. Specifies the Majordomo email list.
|
||||
.LP
|
||||
.SH OPERANDS
|
||||
.TP 10
|
||||
.B recipient
|
||||
Email recipient of the digest. This operand is ignored if used
|
||||
without the
|
||||
.BR \-C
|
||||
option. It specifies one of the system mail
|
||||
aliases created for the Majordomo list named in the
|
||||
.BR \-l
|
||||
option.
|
||||
.LP
|
||||
.SH MAJORDOMO DIGEST CONFIGURATION
|
||||
When used as a part of Majordomo, digest takes these parameters
|
||||
from
|
||||
.B majordomo.cf
|
||||
(either /etc/majordomo.cf or ~majordomo/majordomo.cf):
|
||||
.LP
|
||||
.PD 0
|
||||
.B $listdir
|
||||
\- the location of the mailing lists
|
||||
.LP
|
||||
.B $digest_work_dir
|
||||
\- parent directory for the digests' work directories
|
||||
.LP
|
||||
.B $filedir
|
||||
\- parent directory for archive directories
|
||||
.LP
|
||||
.B $filedir_suffix
|
||||
\- an optional identifier (may be the null string)
|
||||
.PD
|
||||
.LP
|
||||
Incoming messages for
|
||||
.B $listname-digest
|
||||
will be held in
|
||||
.B $digest_work_dir/$listname-digest.
|
||||
.LP
|
||||
Digests will be stored in
|
||||
.B $filedir/$listname-digest$filedir_suffix.
|
||||
.LP
|
||||
The list's configuration file will be
|
||||
.B $listdir/$listname-digest.config.
|
||||
.LP
|
||||
Examples of these values are given in
|
||||
.SB EXAMPLES,
|
||||
below.
|
||||
.LP
|
||||
The list's configuration file contains several digest parameters that
|
||||
are not yet implemented and/or should NOT be changed from their defaults
|
||||
(blank):
|
||||
.B digest_archive, digest_rm_footer, digest_rm_fronter, digest_work_dir.
|
||||
.LP
|
||||
The parameters which specifically deal with digest creation
|
||||
and maintenance are:
|
||||
.LP
|
||||
.PD 0
|
||||
.B digest_name
|
||||
\- the title of the digest
|
||||
.LP
|
||||
.B digest_volume
|
||||
\- volume number
|
||||
.LP
|
||||
.B digest_issue
|
||||
\- issue number
|
||||
.LP
|
||||
.B digest_maxdays
|
||||
\- age limit in days for oldest message in the digest
|
||||
.LP
|
||||
.B digest_maxlines
|
||||
\- maximum number of lines in a digest
|
||||
.LP
|
||||
.B maxlength
|
||||
\- maximum number of characters in a digest
|
||||
.LP
|
||||
.B message_fronter
|
||||
\- text prepended to the digest
|
||||
.LP
|
||||
.B message_footer
|
||||
\- text appended to the digest
|
||||
.PD
|
||||
.LP
|
||||
The last three parameters are also used in the configuration of
|
||||
an ordinary (non-digest) Majordomo list.
|
||||
.LP
|
||||
Each digest begins with the a line containing the
|
||||
.B digest_name, current date, digest_volume and digest_issue.
|
||||
. The digest script will update the issue number in the configuration file.
|
||||
.LP
|
||||
A blank line follows, and then the text from the
|
||||
.B message_fronter,
|
||||
if any. The message fronter may contain the
|
||||
.SB _SUBJECT_
|
||||
token, which will be replaced by the subject lines from the messages
|
||||
in the digest.
|
||||
.LP
|
||||
The text in the
|
||||
.B message_footer,
|
||||
if any, will be appended to the digest.
|
||||
.LP
|
||||
To embed a blank line in the
|
||||
.B message_footer
|
||||
or
|
||||
.B message_fronter,
|
||||
put a `-' as the first and ONLY character on the line. To
|
||||
preserve whitespace at the beginning of a line, put a `-'
|
||||
on the line before the whitespace to be preserved. To put
|
||||
a literal `-' at the beginning of a line, double it.
|
||||
.LP
|
||||
Both message_footer and message_fronter may also use the tokens
|
||||
.SB $LIST, $SENDER,
|
||||
and
|
||||
.SB $VERSION,
|
||||
which will be expanded to,
|
||||
respectively: the name of the current list, the sender as taken
|
||||
from the from line, and the current version of Majordomo.
|
||||
.LP
|
||||
Examples of the aliases usually used with the digest are
|
||||
given in
|
||||
.SB EXAMPLES,
|
||||
below.
|
||||
.LP
|
||||
The list owner can prompt Majordomo to build a digest by
|
||||
sending the command
|
||||
.LP
|
||||
mkdigest
|
||||
.I digest-name
|
||||
[
|
||||
.I outgoing-address
|
||||
]
|
||||
.I digest-password
|
||||
.LP
|
||||
to majordomo either via email or from cron. The cron
|
||||
command has the format:
|
||||
.LP
|
||||
echo mkdigest
|
||||
.I digest-name
|
||||
[
|
||||
.I outgoing-address
|
||||
]
|
||||
.I digest-password
|
||||
| mail majordomo@domain.com
|
||||
.LP
|
||||
.SH STANDALONE DIGEST CONFIGURATION
|
||||
The Majordomo distribution comes with a ``digest'' subdirectory.
|
||||
The sample configuration file is called firewalls-digest.cf.
|
||||
A file in this format must be used if digest is invoked in
|
||||
standalone configuration.
|
||||
.LP
|
||||
If no configuration file is specified when digest is invoked,
|
||||
it looks for a file named
|
||||
.SB $HOME/.digestrc
|
||||
that must be in the same format as the example file.
|
||||
.LP
|
||||
The configuration file defines the email addresses of the
|
||||
sender and recipient of the digest. It also locates the
|
||||
work and archive directories, the digest's size limit,
|
||||
and the names of the files that contain the digest's volume,
|
||||
number, header and footer.
|
||||
.LP
|
||||
The easiest way to configure a standalone digest is to copy
|
||||
the five files (firewalls-digest.*) and edit them to taste.
|
||||
.LP
|
||||
Incoming mail is piped to digest with the
|
||||
.B \-r
|
||||
option. This can be done from some mail-reading programs, through
|
||||
the command line, or via mail aliases similar to those
|
||||
found in
|
||||
.SB EXAMPLES,
|
||||
below.
|
||||
.LP
|
||||
.SH EXAMPLES
|
||||
.LP
|
||||
1. Example values from
|
||||
.B /etc/majordomo.cf:
|
||||
.LP
|
||||
.PD 0
|
||||
.B $listdir = ``usr/local/mail/lists'';
|
||||
.LP
|
||||
.B $digest_work_dir = ``usr/local/mail/digest'';
|
||||
.LP
|
||||
.B $filedir = ``listdir'';
|
||||
.LP
|
||||
.B $filedir_suffix ``archive'';
|
||||
.PD
|
||||
.LP
|
||||
If our digest's name is banjo-digest, the work directory will
|
||||
be /usr/local/mail/digest/banjo-digest; the archive directory
|
||||
will be /usr/local/mail/lists/banjo-digest.archive. Note
|
||||
that these are names of directories, not files.
|
||||
.LP
|
||||
2. Typical aliases for Majordomo digests:
|
||||
.LP
|
||||
Usually a Majordomo digest is associated to a regular (non-digest)
|
||||
list. The digest's name is the regular listname plus ``-digest''.
|
||||
The list ``banjo'' will have the digest ``banjo-digest''.
|
||||
.LP
|
||||
.PD 0
|
||||
.B banjo-digest-approval: kevink
|
||||
.LP
|
||||
.B banjo-digest-outgoing: :include:/usr/local/lists/banjo-digest
|
||||
.LP
|
||||
.B owner-banjo-digest-outgoing: kevink
|
||||
.LP
|
||||
.B banjo-digestify: ``|usr/majordomo/wrapper digest \-r
|
||||
.B \-C \-l banjo-digest banjo-digest-outgoing''
|
||||
.LP
|
||||
.B banjo-digest: banjo
|
||||
.PD
|
||||
.LP
|
||||
Note that mail to ``banjo-digest'' is routed to the regular list.
|
||||
The ``digestify'' alias must be added to the regular list's outgoing
|
||||
alias:
|
||||
.LP
|
||||
.B banjo-outgoing: :include:/usr/local/lists/banjo,banjo-digestify
|
||||
.LP
|
||||
.SH NOTES
|
||||
The volume number does not change automatically; it must be
|
||||
incremented manually.
|
||||
.LP
|
||||
For testing/debugging purposes there is a ``hidden'' option
|
||||
.B -d
|
||||
that creates the digest as /tmp/testdigest.nnn
|
||||
(where
|
||||
.I nnn
|
||||
is the current digest number). Since it is for testing and
|
||||
debugging purposes, it does not mail the digest, it does not
|
||||
place the digest in the archive directory, and it does not
|
||||
update the digest number.
|
||||
.LP
|
||||
.SH EXIT STATUS
|
||||
The following exit values are returned:
|
||||
.TP 10
|
||||
.B 0
|
||||
Successful completion.
|
||||
.TP
|
||||
.B >0
|
||||
An error occurred.
|
||||
.LP
|
||||
.SH FILES
|
||||
.PD 0
|
||||
.TP 20
|
||||
.B /etc/aliases
|
||||
.TP
|
||||
.B /etc/majordomo.cf
|
||||
.PD
|
||||
.LP
|
||||
.SH SEE ALSO
|
||||
.B majordomo(8)
|
||||
.LP
|
||||
.SH AUTHOR
|
||||
The digest script was written by Brent Chapman <brent@GreatCircle.COM>.
|
||||
It is available with distributions of Majordomo via anonymous FTP
|
||||
from FTP.GreatCircle.COM, in the directory pub/majordomo. This
|
||||
man page was written by Kevin Kelleher <fury@world.std.com>.
|
||||
396
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/digest.man
vendored
Normal file
396
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/digest.man
vendored
Normal file
@@ -0,0 +1,396 @@
|
||||
|
||||
|
||||
|
||||
ddddiiiiggggeeeesssstttt((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ddddiiiiggggeeeesssstttt((((1111))))
|
||||
|
||||
|
||||
|
||||
NNNNAAAAMMMMEEEE
|
||||
digest - receive a file for a digest, or create and mail a
|
||||
digest
|
||||
|
||||
SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
|
||||
ddddiiiiggggeeeesssstttt ----rrrr||||RRRR||||mmmm||||pppp ----CCCC ----llll _m_a_j_o_r_d_o_m_o-_l_i_s_t_n_a_m_e _r_e_c_i_p_i_e_n_t
|
||||
|
||||
ddddiiiiggggeeeesssstttt ----rrrr||||RRRR||||mmmm||||pppp [ ----cccc _c_o_n_f_i_g_u_r_a_t_i_o_n-_f_i_l_e ]
|
||||
|
||||
AAAAVVVVAAAAIIIILLLLAAAABBBBIIIILLLLIIIITTTTYYYY
|
||||
Provided with distributions of Majordomo.
|
||||
|
||||
DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
|
||||
The digest script is a perl script which automates the
|
||||
management of digests of electronic mail. It can be run in
|
||||
a standalone configuration or as part of Majordomo.
|
||||
|
||||
It requires two directories: a work directory and an archive
|
||||
directory. Incoming email messages are held in the work
|
||||
directory until they are collected into a digest. The
|
||||
digests are created and stored in the archive directory.
|
||||
|
||||
Incoming email messages are given numerical names starting
|
||||
with ``001'' and are numbered in order of arrival. The
|
||||
digests are named according to volume and number. For
|
||||
example, the filename ``v01.n028'' indicates volume 1,
|
||||
number 28 of the digest.
|
||||
|
||||
It should be noted that digest needs a configuration file to
|
||||
define all of its operating parameters. If no such file is
|
||||
specified, digest will use the file.
|
||||
|
||||
Several aspects of digest configuration determine how and
|
||||
when a digest is created. A digest can be created at
|
||||
regular intervals (as long as there are incoming messages)
|
||||
or whenever certain configurable conditions are met. These
|
||||
conditions are: how large the digest can be (in
|
||||
characters), how long the digest can be (in lines), and how
|
||||
old the messages in the digest can be (in days).
|
||||
|
||||
OOOOPPPPTTTTIIIIOOOONNNNSSSS
|
||||
----rrrr Receive an email message via standard input and
|
||||
place the file into the working directory. If any
|
||||
one of the conditions for digest creation are met,
|
||||
create and mail a digest. These conditions are
|
||||
the same as those described under option ----pppp....
|
||||
|
||||
----RRRR Similar to ----rrrr,,,, except that it will not create a
|
||||
digest. It simply places the message in the work
|
||||
directory and stops.
|
||||
|
||||
----mmmm If there are any numbered files in the working
|
||||
|
||||
|
||||
|
||||
Page 1 (printed 9/23/96)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ddddiiiiggggeeeesssstttt((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ddddiiiiggggeeeesssstttt((((1111))))
|
||||
|
||||
|
||||
|
||||
directory, create and mail a digest. Store the
|
||||
digest in the archive directory. This is the
|
||||
option used by majordomo's mkdigest command.
|
||||
|
||||
----pppp Conditionally creates a digest. If any one of the
|
||||
conditions for digest creation are met, the digest
|
||||
is created and sent. There are three conditions,
|
||||
which are connected to three limits: the digest
|
||||
size in characters, the digest length in lines,
|
||||
and the age of the oldest message in days. If one
|
||||
of the files is older than the age limit, a digest
|
||||
is created. If the sum of the messages exceeds
|
||||
either of the size limits, a digest is created.
|
||||
The size limit in characters must be configured;
|
||||
the other two limits are optional.
|
||||
|
||||
----cccc ccccoooonnnnffffiiiigggguuuurrrraaaattttiiiioooonnnn----ffffiiiilllleeee
|
||||
Use the parameters defined in _c_o_n_f_i_g_u_r_a_t_i_o_n-_f_i_l_e.
|
||||
|
||||
----CCCC Read the majordomo configuration file (either
|
||||
/etc/majordomo.cf or ~majordomo/majordomo.cf) and
|
||||
the configuration file for the Majordomo list
|
||||
specified in the ----llll option to define operational
|
||||
parameters. If both ----CCCC and ----cccc options are
|
||||
specified (not recommended) only the ----CCCC option
|
||||
will be used.
|
||||
|
||||
----llll mmmmaaaajjjjoooorrrrddddoooommmmoooo----lllliiiissssttttnnnnaaaammmmeeee
|
||||
This option is ignored if used without the ----CCCC
|
||||
option. Specifies the Majordomo email list.
|
||||
|
||||
OOOOPPPPEEEERRRRAAAANNNNDDDDSSSS
|
||||
rrrreeeecccciiiippppiiiieeeennnntttt Email recipient of the digest. This operand is
|
||||
ignored if used without the ----CCCC option. It
|
||||
specifies one of the system mail aliases created
|
||||
for the Majordomo list named in the ----llll option.
|
||||
|
||||
MMMMAAAAJJJJOOOORRRRDDDDOOOOMMMMOOOO DDDDIIIIGGGGEEEESSSSTTTT CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN
|
||||
When used as a part of Majordomo, digest takes these
|
||||
parameters from mmmmaaaajjjjoooorrrrddddoooommmmoooo....ccccffff (either /etc/majordomo.cf or
|
||||
~majordomo/majordomo.cf):
|
||||
|
||||
$$$$lllliiiissssttttddddiiiirrrr - the location of the mailing lists
|
||||
$$$$ddddiiiiggggeeeesssstttt____wwwwoooorrrrkkkk____ddddiiiirrrr - parent directory for the digests' work
|
||||
directories
|
||||
$$$$ffffiiiilllleeeeddddiiiirrrr - parent directory for archive directories
|
||||
$$$$ffffiiiilllleeeeddddiiiirrrr____ssssuuuuffffffffiiiixxxx - an optional identifier (may be the null
|
||||
string)
|
||||
|
||||
Incoming messages for $$$$lllliiiissssttttnnnnaaaammmmeeee----ddddiiiiggggeeeesssstttt will be held in
|
||||
$$$$ddddiiiiggggeeeesssstttt____wwwwoooorrrrkkkk____ddddiiiirrrr////$$$$lllliiiissssttttnnnnaaaammmmeeee----ddddiiiiggggeeeesssstttt....
|
||||
|
||||
|
||||
|
||||
|
||||
Page 2 (printed 9/23/96)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ddddiiiiggggeeeesssstttt((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ddddiiiiggggeeeesssstttt((((1111))))
|
||||
|
||||
|
||||
|
||||
Digests will be stored in $$$$ffffiiiilllleeeeddddiiiirrrr////$$$$lllliiiissssttttnnnnaaaammmmeeee----
|
||||
ddddiiiiggggeeeesssstttt$$$$ffffiiiilllleeeeddddiiiirrrr____ssssuuuuffffffffiiiixxxx....
|
||||
|
||||
The list's configuration file will be $$$$lllliiiissssttttddddiiiirrrr////$$$$lllliiiissssttttnnnnaaaammmmeeee----
|
||||
ddddiiiiggggeeeesssstttt....ccccoooonnnnffffiiiigggg....
|
||||
|
||||
Examples of these values are given in below.
|
||||
|
||||
The list's configuration file contains several digest
|
||||
parameters that are not yet implemented and/or should NOT be
|
||||
changed from their defaults (blank): ddddiiiiggggeeeesssstttt____aaaarrrrcccchhhhiiiivvvveeee,,,,
|
||||
ddddiiiiggggeeeesssstttt____rrrrmmmm____ffffooooooootttteeeerrrr,,,, ddddiiiiggggeeeesssstttt____rrrrmmmm____ffffrrrroooonnnntttteeeerrrr,,,, ddddiiiiggggeeeesssstttt____wwwwoooorrrrkkkk____ddddiiiirrrr....
|
||||
|
||||
The parameters which specifically deal with digest creation
|
||||
and maintenance are:
|
||||
|
||||
ddddiiiiggggeeeesssstttt____nnnnaaaammmmeeee - the title of the digest
|
||||
ddddiiiiggggeeeesssstttt____vvvvoooolllluuuummmmeeee - volume number
|
||||
ddddiiiiggggeeeesssstttt____iiiissssssssuuuueeee - issue number
|
||||
ddddiiiiggggeeeesssstttt____mmmmaaaaxxxxddddaaaayyyyssss - age limit in days for oldest message in the
|
||||
digest
|
||||
ddddiiiiggggeeeesssstttt____mmmmaaaaxxxxlllliiiinnnneeeessss - maximum number of lines in a digest
|
||||
mmmmaaaaxxxxlllleeeennnnggggtttthhhh - maximum number of characters in a digest
|
||||
mmmmeeeessssssssaaaaggggeeee____ffffrrrroooonnnntttteeeerrrr - text prepended to the digest
|
||||
mmmmeeeessssssssaaaaggggeeee____ffffooooooootttteeeerrrr - text appended to the digest
|
||||
|
||||
The last three parameters are also used in the configuration
|
||||
of an ordinary (non-digest) Majordomo list.
|
||||
|
||||
Each digest begins with the a line containing the
|
||||
ddddiiiiggggeeeesssstttt____nnnnaaaammmmeeee,,,, ccccuuuurrrrrrrreeeennnntttt ddddaaaatttteeee,,,, ddddiiiiggggeeeesssstttt____vvvvoooolllluuuummmmeeee aaaannnndddd ddddiiiiggggeeeesssstttt____iiiissssssssuuuueeee....
|
||||
|
||||
A blank line follows, and then the text from the
|
||||
mmmmeeeessssssssaaaaggggeeee____ffffrrrroooonnnntttteeeerrrr,,,, if any. The message fronter may contain
|
||||
the token, which will be replaced by the subject lines from
|
||||
the messages in the digest.
|
||||
|
||||
The text in the mmmmeeeessssssssaaaaggggeeee____ffffooooooootttteeeerrrr,,,, if any, will be appended to
|
||||
the digest.
|
||||
|
||||
To embed a blank line in the mmmmeeeessssssssaaaaggggeeee____ffffooooooootttteeeerrrr or
|
||||
mmmmeeeessssssssaaaaggggeeee____ffffrrrroooonnnntttteeeerrrr,,,, put a `-' as the first and ONLY character
|
||||
on the line. To preserve whitespace at the beginning of a
|
||||
line, put a `-' on the line before the whitespace to be
|
||||
preserved. To put a literal `-' at the beginning of a line,
|
||||
double it.
|
||||
|
||||
Both message_footer and message_fronter may also use the
|
||||
tokens and which will be expanded to, respectively: the name
|
||||
of the current list, the sender as taken from the from line,
|
||||
and the current version of Majordomo.
|
||||
|
||||
|
||||
|
||||
|
||||
Page 3 (printed 9/23/96)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ddddiiiiggggeeeesssstttt((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ddddiiiiggggeeeesssstttt((((1111))))
|
||||
|
||||
|
||||
|
||||
Examples of the aliases usually used with the digest are
|
||||
given in below.
|
||||
|
||||
The list owner can prompt Majordomo to build a digest by
|
||||
sending the command
|
||||
|
||||
mkdigest _d_i_g_e_s_t-_n_a_m_e [ _d_i_g_e_s_t-_p_a_s_s_w_o_r_d ]
|
||||
|
||||
to majordomo either via email or from cron. The cron
|
||||
command has the format:
|
||||
|
||||
echo mkdigest _d_i_g_e_s_t-_n_a_m_e [ _d_i_g_e_s_t-_p_a_s_s_w_o_r_d ] | mail
|
||||
majordomo@domain.com
|
||||
|
||||
SSSSTTTTAAAANNNNDDDDAAAALLLLOOOONNNNEEEE DDDDIIIIGGGGEEEESSSSTTTT CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN
|
||||
The Majordomo distribution comes with a ``digest''
|
||||
subdirectory. The sample configuration file is called
|
||||
firewalls-digest.cf. A file in this format must be used if
|
||||
digest is invoked in standalone configuration.
|
||||
|
||||
If no configuration file is specified when digest is
|
||||
invoked, it looks for a file named that must be in the same
|
||||
format as the example file.
|
||||
|
||||
The configuration file defines the email addresses of the
|
||||
sender and recipient of the digest. It also locates the work
|
||||
and archive directories, the digest's size limit, and the
|
||||
names of the files that contain the digest's volume, number,
|
||||
header and footer.
|
||||
|
||||
The easiest way to configure a standalone digest is to copy
|
||||
the five files (firewalls-digest.*) and edit them to taste.
|
||||
|
||||
Incoming mail is piped to digest with the ----rrrr option. This
|
||||
can be done from some mail-reading programs, through the
|
||||
command line, or via mail aliases similar to those found in
|
||||
below.
|
||||
|
||||
EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
|
||||
1. Example values from ////eeeettttcccc////mmmmaaaajjjjoooorrrrddddoooommmmoooo....ccccffff::::
|
||||
|
||||
$$$$lllliiiissssttttddddiiiirrrr ==== ````````uuuussssrrrr////llllooooccccaaaallll////mmmmaaaaiiiillll////lllliiiissssttttssss'''''''';;;;
|
||||
$$$$ddddiiiiggggeeeesssstttt____wwwwoooorrrrkkkk____ddddiiiirrrr ==== ````````uuuussssrrrr////llllooooccccaaaallll////mmmmaaaaiiiillll////ddddiiiiggggeeeesssstttt'''''''';;;;
|
||||
$$$$ffffiiiilllleeeeddddiiiirrrr ==== ````````lllliiiissssttttddddiiiirrrr'''''''';;;;
|
||||
$$$$ffffiiiilllleeeeddddiiiirrrr____ssssuuuuffffffffiiiixxxx ````````aaaarrrrcccchhhhiiiivvvveeee'''''''';;;;
|
||||
|
||||
If our digest's name is banjo-digest, the work directory
|
||||
will be /usr/local/mail/digest/banjo-digest; the archive
|
||||
directory will be /usr/local/mail/lists/banjo-
|
||||
digest.archive. Note that these are names of directories,
|
||||
not files.
|
||||
|
||||
|
||||
|
||||
|
||||
Page 4 (printed 9/23/96)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ddddiiiiggggeeeesssstttt((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ddddiiiiggggeeeesssstttt((((1111))))
|
||||
|
||||
|
||||
|
||||
2. Typical aliases for Majordomo digests:
|
||||
|
||||
Usually a Majordomo digest is associated to a regular (non-
|
||||
digest) list. The digest's name is the regular listname
|
||||
plus ``-digest''. The list ``banjo'' will have the digest
|
||||
``banjo-digest''.
|
||||
|
||||
bbbbaaaannnnjjjjoooo----ddddiiiiggggeeeesssstttt----aaaapppppppprrrroooovvvvaaaallll:::: kkkkeeeevvvviiiinnnnkkkk
|
||||
bbbbaaaannnnjjjjoooo----ddddiiiiggggeeeesssstttt----oooouuuuttttggggooooiiiinnnngggg:::: ::::iiiinnnncccclllluuuuddddeeee::::////uuuussssrrrr////llllooooccccaaaallll////lllliiiissssttttssss////bbbbaaaannnnjjjjoooo----
|
||||
ddddiiiiggggeeeesssstttt
|
||||
oooowwwwnnnneeeerrrr----bbbbaaaannnnjjjjoooo----ddddiiiiggggeeeesssstttt----oooouuuuttttggggooooiiiinnnngggg:::: kkkkeeeevvvviiiinnnnkkkk
|
||||
bbbbaaaannnnjjjjoooo----ddddiiiiggggeeeessssttttiiiiffffyyyy:::: ````````||||uuuussssrrrr////mmmmaaaajjjjoooorrrrddddoooommmmoooo////wwwwrrrraaaappppppppeeeerrrr ddddiiiiggggeeeesssstttt ----rrrr ----CCCC ----llll
|
||||
bbbbaaaannnnjjjjoooo----ddddiiiiggggeeeesssstttt bbbbaaaannnnjjjjoooo----ddddiiiiggggeeeesssstttt----oooouuuuttttggggooooiiiinnnngggg''''''''
|
||||
bbbbaaaannnnjjjjoooo----ddddiiiiggggeeeesssstttt:::: bbbbaaaannnnjjjjoooo
|
||||
|
||||
Note that mail to ``banjo-digest'' is routed to the regular
|
||||
list. The ``digestify'' alias must be added to the regular
|
||||
list's outgoing alias:
|
||||
|
||||
bbbbaaaannnnjjjjoooo----oooouuuuttttggggooooiiiinnnngggg:::: ::::iiiinnnncccclllluuuuddddeeee::::////uuuussssrrrr////llllooooccccaaaallll////lllliiiissssttttssss////bbbbaaaannnnjjjjoooo,,,,bbbbaaaannnnjjjjoooo----
|
||||
ddddiiiiggggeeeessssttttiiiiffffyyyy
|
||||
|
||||
NNNNOOOOTTTTEEEESSSS
|
||||
The volume number does not change automatically; it must be
|
||||
incremented manually.
|
||||
|
||||
For testing/debugging purposes there is a ``hidden'' option
|
||||
----dddd that creates the digest as /tmp/testdigest.nnn (where _n_n_n
|
||||
is the current digest number). Since it is for testing and
|
||||
debugging purposes, it does not mail the digest, it does not
|
||||
place the digest in the archive directory, and it does not
|
||||
update the digest number.
|
||||
|
||||
EEEEXXXXIIIITTTT SSSSTTTTAAAATTTTUUUUSSSS
|
||||
The following exit values are returned:
|
||||
|
||||
0000 Successful completion.
|
||||
|
||||
>>>>0000 An error occurred.
|
||||
|
||||
FFFFIIIILLLLEEEESSSS
|
||||
////eeeettttcccc////aaaalllliiiiaaaasssseeeessss
|
||||
////eeeettttcccc////mmmmaaaajjjjoooorrrrddddoooommmmoooo....ccccffff
|
||||
|
||||
SSSSEEEEEEEE AAAALLLLSSSSOOOO
|
||||
mmmmaaaajjjjoooorrrrddddoooommmmoooo((((8888))))
|
||||
|
||||
AAAAUUUUTTTTHHHHOOOORRRR
|
||||
The digest script was written by Brent Chapman
|
||||
<brent@GreatCircle.COM>. It is available with distributions
|
||||
of Majordomo via anonymous FTP from FTP.GreatCircle.COM, in
|
||||
the directory pub/majordomo. This man page was written by
|
||||
|
||||
|
||||
|
||||
Page 5 (printed 9/23/96)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ddddiiiiggggeeeesssstttt((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ddddiiiiggggeeeesssstttt((((1111))))
|
||||
|
||||
|
||||
|
||||
Kevin Kelleher <fury@world.std.com>.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Page 6 (printed 9/23/96)
|
||||
|
||||
|
||||
|
||||
300
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/majordomo.8
vendored
Normal file
300
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/majordomo.8
vendored
Normal file
@@ -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>.
|
||||
264
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/majordomo.man
vendored
Normal file
264
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/majordomo.man
vendored
Normal file
@@ -0,0 +1,264 @@
|
||||
|
||||
|
||||
|
||||
MAJORDOMO(8) MAINTENANCE COMMANDS MAJORDOMO(8)
|
||||
|
||||
|
||||
|
||||
NAME
|
||||
Majordomo - manage multiple mailing lists
|
||||
|
||||
SYNOPSIS
|
||||
Majordomo
|
||||
|
||||
DESCRIPTION
|
||||
Majordomo is a perl script which automates the management of
|
||||
Internet mailing lists. It is executed via electronic mail;
|
||||
users send e-mail to 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.
|
||||
|
||||
COMMANDS
|
||||
Majordomo understands the following commands (arguments in
|
||||
"[]" are optional):
|
||||
|
||||
subscribe _l_i_s_t [_a_d_d_r_e_s_s]
|
||||
Subscribe yourself (or _a_d_d_r_e_s_s if specified) to the
|
||||
named _l_i_s_t.
|
||||
|
||||
unsubscribe _l_i_s_t [_a_d_d_r_e_s_s]
|
||||
Unsubscribe yourself (or _a_d_d_r_e_s_s if specified) from the
|
||||
named _l_i_s_t.
|
||||
|
||||
get _l_i_s_t _f_i_l_e
|
||||
Get the _f_i_l_e related to _l_i_s_t.
|
||||
|
||||
index _l_i_s_t
|
||||
Return an index of the files you can _g_e_t associated
|
||||
with _l_i_s_t.
|
||||
|
||||
which [_a_d_d_r_e_s_s]
|
||||
Find out to which lists you (or _a_d_d_r_e_s_s if specified)
|
||||
are subscribed.
|
||||
|
||||
who _l_i_s_t
|
||||
Find out who is on the named _l_i_s_t.
|
||||
|
||||
info _l_i_s_t
|
||||
Retrieve the general introductory information for the
|
||||
named _l_i_s_t.
|
||||
|
||||
lists
|
||||
Show the lists served by this Majordomo server. It will
|
||||
also show a 50 character list description if one has
|
||||
been provided.
|
||||
|
||||
help Retrieve an informational message, a brief synopsis of
|
||||
the user portion of this manual page.
|
||||
|
||||
|
||||
|
||||
|
||||
Sun Release 4.1 Last change: 1
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
MAJORDOMO(8) MAINTENANCE COMMANDS MAJORDOMO(8)
|
||||
|
||||
|
||||
|
||||
end Stop processing commands (useful if your mailer adds a
|
||||
signature).
|
||||
|
||||
A command may be split across multiple lines if all of the
|
||||
lines in the command except the last end with a backslash
|
||||
"\".
|
||||
|
||||
In addition, the owner of the list can issue the following
|
||||
commands:
|
||||
|
||||
approve _p_a_s_s_w_o_r_d subscribe _l_i_s_t _a_d_d_r_e_s_s
|
||||
Instruct Majordomo to add _a_d_d_r_e_s_s to _l_i_s_t. The pass-
|
||||
word 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 Major-
|
||||
domo server.
|
||||
|
||||
approve _p_a_s_s_w_o_r_d unsubscribe _l_i_s_t _a_d_d_r_e_s_s
|
||||
Instruct Majordomo to delete _a_d_d_r_e_s_s from _l_i_s_t. The
|
||||
password is required to authenticate the list owner.
|
||||
See the comments above regarding the password.
|
||||
|
||||
newinfo _l_i_s_t _p_a_s_s_w_o_r_d
|
||||
Update the informational message for _l_i_s_t 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 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.,
|
||||
|
||||
To: majordomo
|
||||
newinfo list password
|
||||
|
||||
This is new information for the "list" list.
|
||||
|
||||
EOF
|
||||
info list
|
||||
|
||||
This will simultaneously update the information for the
|
||||
list, and then retrieve it for verification. Note that
|
||||
blank lines are preserved in the message.
|
||||
|
||||
passwd _l_i_s_t _o_l_d-_p_a_s_s_w_o_r_d _n_e_w-_p_a_s_s_w_o_r_d
|
||||
Replace the password for _l_i_s_t with _n_e_w-_p_a_s_s_w_o_r_d.
|
||||
|
||||
config _l_i_s_t _p_a_s_s_w_o_r_d
|
||||
retrieve a self-documenting configuration file for the
|
||||
list <list>. The _p_a_s_s_w_o_r_d can be the password
|
||||
|
||||
|
||||
|
||||
Sun Release 4.1 Last change: 2
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
MAJORDOMO(8) MAINTENANCE COMMANDS MAJORDOMO(8)
|
||||
|
||||
|
||||
|
||||
contained in the file <listname>.passwd or the
|
||||
admin_password in the configuration file.
|
||||
|
||||
newconfig _l_i_s_t _p_a_s_s_w_o_r_d
|
||||
Validates and installs a new configuration file. The
|
||||
config file includes everything up to the string 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 con-
|
||||
fig file (incorrect value...), the config file will not
|
||||
be accepted and the error message identifying the prob-
|
||||
lem line(s) will be returned to the sender. Note that
|
||||
only the errors are returned to the sender not the
|
||||
entire config file.
|
||||
|
||||
writeconfig _l_i_s_t _p_a_s_s_w_o_r_d
|
||||
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 major-
|
||||
domo since it will add the new keywords for people to
|
||||
change. It also updates the documentation in the file
|
||||
if that has changed.
|
||||
|
||||
mkdigest _d_i_g_e_s_t-_l_i_s_t-_n_a_m_e _p_a_s_s_w_o_r_d
|
||||
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.
|
||||
|
||||
|
||||
CONFIGURATION
|
||||
(Note that this section has not been updated to majordomo
|
||||
version 1.90). Majordomo supports _o_p_e_n and _c_l_o_s_e_d lists.
|
||||
An _o_p_e_n list is one to which anyone can subscribe them-
|
||||
selves. A subscription request sent to Majordomo for a
|
||||
_c_l_o_s_e_d list is forwarded to the owner of the list for appro-
|
||||
val. If a user tries to subscribe an address which is dif-
|
||||
ferent from their own (for example, a local list exploder),
|
||||
Majordomo will forward the request to the list owner for
|
||||
approval, regardless of the open or closed status of the
|
||||
list.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Sun Release 4.1 Last change: 3
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
MAJORDOMO(8) MAINTENANCE COMMANDS MAJORDOMO(8)
|
||||
|
||||
|
||||
|
||||
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:
|
||||
|
||||
majordomo: "|/usr/local/mail/majordomo/wrapper majordomo"
|
||||
majordomo-owner: brent
|
||||
owner-majordomo: brent
|
||||
|
||||
These next few aliases are for a list called "sample":
|
||||
|
||||
sample: :include:/usr/local/mail/lists/sample
|
||||
owner-sample: sample-owner
|
||||
sample-request: "|/usr/local/mail/majordomo/wrapper
|
||||
request-answer sample"
|
||||
owner-sample-request: sample-owner
|
||||
sample-owner: brent
|
||||
sample-approval: brent
|
||||
|
||||
|
||||
|
||||
FILES
|
||||
/etc/majordomo.cf
|
||||
/usr/local/lib/mail/majordomo/
|
||||
|
||||
|
||||
BUGS
|
||||
This man page has not been fully updated to conform to
|
||||
majordomo 1.90.
|
||||
|
||||
|
||||
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>.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Sun Release 4.1 Last change: 4
|
||||
|
||||
|
||||
|
||||
184
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/resend.1
vendored
Normal file
184
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/resend.1
vendored
Normal file
@@ -0,0 +1,184 @@
|
||||
.TH resend 1
|
||||
.SH NAME
|
||||
resend \- resend messages after evaluation
|
||||
.LP
|
||||
.SH SYNOPSIS
|
||||
.B resend
|
||||
.B [\-A]
|
||||
.B [\-C config-file]
|
||||
.B [\-I file-list]
|
||||
.B [\-M max-msg-length]
|
||||
.B [\-R]
|
||||
.B [\-a passwd]
|
||||
.B [\-d]
|
||||
.B [\-f from-addr]
|
||||
.B [\-h host-name]
|
||||
.B \-l list-name
|
||||
.B [\-n]
|
||||
.B [\-p precedence]
|
||||
.B [\-r reply-to]
|
||||
.B [\-s]
|
||||
.B destination
|
||||
.LP
|
||||
.SH AVAILABILITY
|
||||
Provided with distributions of Majordomo.
|
||||
.LP
|
||||
.SH DESCRIPTION
|
||||
.B resend
|
||||
is a perl script that is usually used to redirect mail messages to
|
||||
a mailing list after evaluating and parsing the headers. Mail is
|
||||
"resent" by handing it off to the mailer again with an alternate
|
||||
destination as specified by the final operand.
|
||||
.LP
|
||||
Any message that
|
||||
.B resend
|
||||
doesn't like is sent to the list owner (the
|
||||
"-f" address, or "<list-name>-owner" if -f isn't used) along with a
|
||||
comment indicating what "resend" didn't like about it. To go ahead
|
||||
and send the message, just feed it to resend without the flag that
|
||||
caused it to reject it (in other words, if it rejected it because it
|
||||
was too long, omit the "-M <>" flag; if it rejected it because it was
|
||||
administrivia, omit the "-s" flag).
|
||||
.LP
|
||||
If you specify "-a <passwd>" flag, this "approval" password can be
|
||||
used in an "Approved: <passwd>" line to override most of the other
|
||||
checks (those enabled by "-s", "-M", and so forth). The "Approved:
|
||||
<passwd>" line can either be one of the mail headers, or the first
|
||||
line of the body of the message. If it is in the headers, the rest
|
||||
of the headers are resent as part of the approved message. If it is
|
||||
in the body, the current headers are discarded in favor of the headers
|
||||
from the original message which should follow the "Approved:" line in
|
||||
the body.
|
||||
.LP
|
||||
The owner of a mailing list can thus post messages that were initially
|
||||
bounced by adding an "Approved: <passwd>" line and resubmitting the
|
||||
message. Any "Approved: <passwd>" line is stripped before the message
|
||||
is sent to the mailing list, so that list members won't learn the
|
||||
password. If the <passwd> argument to the "-a" flag begins with a "/",
|
||||
it is assumed to be a file name from which the actual password is read.
|
||||
.LP
|
||||
You can make a list "moderated" by specifying the "-A" flag. If the
|
||||
"-A" flag is set, then any messages not containing a valid "Approved:"
|
||||
line are sent to the list owner, rather than the whole list.; the
|
||||
list owner can then review the message, add an appropriate "Approved:"
|
||||
line, and resubmit them (these last two steps can be done easily with
|
||||
the "approve" command that comes with Majordomo). If you specify
|
||||
the "-A" flag, you must also specify the "-a <passwd>" flag, so that
|
||||
resend knows what approval password to use.
|
||||
.LP
|
||||
If you only want to accept messages from members of a list, you can
|
||||
use the "-I <file-list>" flag to do this. "<file-list>" should be a
|
||||
colon-separated list of files in the $listdir directory (specified in
|
||||
the config file) that "resend" will check the address in "From:" line
|
||||
of a message against. If the address doesn't show up in one of those
|
||||
files, and the message doesn't have a valid "approved" header on it,
|
||||
it will be bounced to the list owner.
|
||||
.LP
|
||||
.SH OPTIONS
|
||||
The following options can be used with resend:
|
||||
.LP
|
||||
.TP 10
|
||||
.B \-A
|
||||
Approve; enable list moderation by requiring an Approved: header to be
|
||||
present in the message before resending. Messages without an Approved:
|
||||
header will be redirected to the list owner for approval.
|
||||
.TP
|
||||
.B \-C config-file
|
||||
Alternate configuration file; tell resend to use the file
|
||||
.TP
|
||||
.B config-file
|
||||
instead of the default list-name.config.
|
||||
.TP
|
||||
.B \-I file-list
|
||||
Include; ensure that the message sender (as represented in the From:
|
||||
line of the incoming message) is in one of the file(s) specified in
|
||||
.BR file-list .
|
||||
.B file-list
|
||||
may contain multiple colon separated pathnames. Each pathname should
|
||||
point to a file that contains a sendmail-style mailing list.
|
||||
.TP
|
||||
.B [\-M max-msg-length]
|
||||
Maximum; Specify the maximum length of the relayed message in octets.
|
||||
.TP
|
||||
.B [\-R]
|
||||
Delete the "Received:" lines in the incoming message header. This can
|
||||
make the relayed messages considerably shorter at the expense of
|
||||
losing some potentially interesting debugging information.
|
||||
.TP
|
||||
.B [\-a passwd_file]
|
||||
Specify the pathname of the file containing the approval password for
|
||||
the list. This password is used to check Approved: headers when
|
||||
relaying messages to lists that are marked as moderated through the
|
||||
.B \-A
|
||||
option above.
|
||||
.TP
|
||||
.B [\-d]
|
||||
Debug; print what would be done, but don't do it.
|
||||
.TP
|
||||
.B [\-f from-addr]
|
||||
Set the From: address to
|
||||
.B from-addr
|
||||
.TP
|
||||
.B [\-h host-name]
|
||||
Set the name of the local host to
|
||||
.BR host-name .
|
||||
This name will be used in the From: and To: lines when updating the
|
||||
headers.
|
||||
.TP
|
||||
.B \-l list-name
|
||||
Specify the name of the mailing list as
|
||||
.BR list-name .
|
||||
This option is required, as
|
||||
.B resend
|
||||
uses this name to derive the names
|
||||
of many other files.
|
||||
.TP
|
||||
.B [\-n]
|
||||
Assign a sequence number to each message as it comes through. The next
|
||||
sequence number is stored in the file lists/list-name.seq. If the
|
||||
string $SEQNUM is found in the $subject-prefix configuration variable,
|
||||
it is replaced with the current sequence number. Thus, a
|
||||
$subject_prefix of "($LIST $SEQNUM)" would render a Subject: line of
|
||||
(list-name sequence-number).
|
||||
.TP
|
||||
.B [\-p precedence]
|
||||
Set the Precedence: header to
|
||||
.BR precedence .
|
||||
.TP
|
||||
.B [\-r reply-to]
|
||||
Set the Reply-To: header to
|
||||
.BR reply-to .
|
||||
.TP
|
||||
.B [\-s]
|
||||
Administrivia; Search the message for strings commonly found in
|
||||
administrative messages send to majordomo mailing lists (e.g.
|
||||
subscribe, unsubscribe). If these are found in the first 10 or so
|
||||
lines of the message, the message will be relayed to the list owner
|
||||
instead of being sent on to the mailing list.
|
||||
.SH OPERANDS
|
||||
.TP 10
|
||||
.B destination
|
||||
The alias to which to redirect the message if it is a proper list
|
||||
submission.
|
||||
.LP
|
||||
.SH CONFIGURATION
|
||||
.LP
|
||||
.SH FILES
|
||||
.PD 0
|
||||
.TP 20
|
||||
.B /etc/aliases
|
||||
.TP
|
||||
.B /etc/majordomo.cf
|
||||
.TP
|
||||
.B lists/list-name.config
|
||||
.PD
|
||||
.LP
|
||||
.SH SEE ALSO
|
||||
.B majordomo(8),approve(1)
|
||||
.LP
|
||||
.SH AUTHOR
|
||||
Majordomo and most of the ancillary perl code was written by
|
||||
Brent Chapman <brent@GreatCircle.COM>.
|
||||
Majordomo is available via anonymous FTP
|
||||
from FTP.GreatCircle.COM, in the directory pub/majordomo. This
|
||||
man page was written by Shane McCarron <ahby@themacs.com>.
|
||||
264
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/resend.man
vendored
Normal file
264
directadmin-1.62.4/scripts/packages/majordomo-1.94.5/Doc/man/resend.man
vendored
Normal file
@@ -0,0 +1,264 @@
|
||||
|
||||
|
||||
|
||||
rrrreeeesssseeeennnndddd((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV rrrreeeesssseeeennnndddd((((1111))))
|
||||
|
||||
|
||||
|
||||
NNNNAAAAMMMMEEEE
|
||||
resend - resend messages after evaluation
|
||||
|
||||
SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
|
||||
rrrreeeesssseeeennnndddd [[[[----AAAA]]]] [[[[----CCCC ccccoooonnnnffffiiiigggg----ffffiiiilllleeee]]]] [[[[----IIII ffffiiiilllleeee----lllliiiisssstttt]]]] [[[[----MMMM mmmmaaaaxxxx----mmmmssssgggg----
|
||||
lllleeeennnnggggtttthhhh]]]] [[[[----RRRR]]]] [[[[----aaaa ppppaaaasssssssswwwwdddd]]]] [[[[----dddd]]]] [[[[----ffff ffffrrrroooommmm----aaaaddddddddrrrr]]]] [[[[----hhhh hhhhoooosssstttt----nnnnaaaammmmeeee]]]]
|
||||
----llll lllliiiisssstttt----nnnnaaaammmmeeee [[[[----nnnn]]]] [[[[----pppp pppprrrreeeecccceeeeddddeeeennnncccceeee]]]] [[[[----rrrr rrrreeeeppppllllyyyy----ttttoooo]]]] [[[[----ssss]]]]
|
||||
ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnn
|
||||
|
||||
AAAAVVVVAAAAIIIILLLLAAAABBBBIIIILLLLIIIITTTTYYYY
|
||||
Provided with distributions of Majordomo.
|
||||
|
||||
DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
|
||||
rrrreeeesssseeeennnndddd is a perl script that is usually used to redirect
|
||||
mail messages to a mailing list after evaluating and parsing
|
||||
the headers. Mail is "resent" by handing it off to the
|
||||
mailer again with an alternate destination as specified by
|
||||
the final operand.
|
||||
|
||||
Any message that rrrreeeesssseeeennnndddd doesn't like is sent to the list
|
||||
owner (the "-f" address, or "<list-name>-owner" if -f isn't
|
||||
used) along with a comment indicating what "resend" didn't
|
||||
like about it. To go ahead and send the message, just feed
|
||||
it to resend without the flag that caused it to reject it
|
||||
(in other words, if it rejected it because it was too long,
|
||||
omit the "-M <>" flag; if it rejected it because it was
|
||||
administrivia, omit the "-s" flag).
|
||||
|
||||
If you specify "-a <passwd>" flag, this "approval" password
|
||||
can be used in an "Approved: <passwd>" line to override most
|
||||
of the other checks (those enabled by "-s", "-M", and so
|
||||
forth). The "Approved: <passwd>" line can either be one of
|
||||
the mail headers, or the first line of the body of the
|
||||
message. If it is in the headers, the rest of the headers
|
||||
are resent as part of the approved message. If it is in the
|
||||
body, the current headers are discarded in favor of the
|
||||
headers from the original message which should follow the
|
||||
"Approved:" line in the body.
|
||||
|
||||
The owner of a mailing list can thus post messages that were
|
||||
initially bounced by adding an "Approved: <passwd>" line and
|
||||
resubmitting the message. Any "Approved: <passwd>" line is
|
||||
stripped before the message is sent to the mailing list, so
|
||||
that list members won't learn the password. If the <passwd>
|
||||
argument to the "-a" flag begins with a "/", it is assumed
|
||||
to be a file name from which the actual password is read.
|
||||
|
||||
You can make a list "moderated" by specifying the "-A" flag.
|
||||
If the "-A" flag is set, then any messages not containing a
|
||||
valid "Approved:" line are sent to the list owner, rather
|
||||
than the whole list.; the list owner can then review the
|
||||
message, add an appropriate "Approved:" line, and resubmit
|
||||
|
||||
|
||||
|
||||
Page 1 (printed 12/10/96)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
rrrreeeesssseeeennnndddd((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV rrrreeeesssseeeennnndddd((((1111))))
|
||||
|
||||
|
||||
|
||||
them (these last two steps can be done easily with the
|
||||
"approve" command that comes with Majordomo). If you
|
||||
specify the "-A" flag, you must also specify the "-a
|
||||
<passwd>" flag, so that resend knows what approval password
|
||||
to use.
|
||||
|
||||
If you only want to accept messages from members of a list,
|
||||
you can use the "-I <file-list>" flag to do this. "<file-
|
||||
list>" should be a colon-separated list of files in the
|
||||
$listdir directory (specified in the config file) that
|
||||
"resend" will check the address in "From:" line of a message
|
||||
against. If the address doesn't show up in one of those
|
||||
files, and the message doesn't have a valid "approved"
|
||||
header on it, it will be bounced to the list owner.
|
||||
|
||||
OOOOPPPPTTTTIIIIOOOONNNNSSSS
|
||||
The following options can be used with resend:
|
||||
|
||||
----AAAA Approve; enable list moderation by requiring an
|
||||
Approved: header to be present in the message
|
||||
before resending. Messages without an Approved:
|
||||
header will be redirected to the list owner for
|
||||
approval.
|
||||
|
||||
----CCCC ccccoooonnnnffffiiiigggg----ffffiiiilllleeee
|
||||
Alternate configuration file; tell resend to use
|
||||
the file
|
||||
|
||||
ccccoooonnnnffffiiiigggg----ffffiiiilllleeee
|
||||
instead of the default list-name.config.
|
||||
|
||||
----IIII ffffiiiilllleeee----lllliiiisssstttt
|
||||
Include; ensure that the message sender (as
|
||||
represented in the From: line of the incoming
|
||||
message) is in one of the file(s) specified in
|
||||
ffffiiiilllleeee----lllliiiisssstttt. ffffiiiilllleeee----lllliiiisssstttt may contain multiple colon
|
||||
separated pathnames. Each pathname should point to
|
||||
a file that contains a sendmail-style mailing
|
||||
list.
|
||||
|
||||
[[[[----MMMM mmmmaaaaxxxx----mmmmssssgggg----lllleeeennnnggggtttthhhh]]]]
|
||||
Maximum; Specify the maximum length of the relayed
|
||||
message in octets.
|
||||
|
||||
[[[[----RRRR]]]] Delete the "Received:" lines in the incoming
|
||||
message header. This can make the relayed messages
|
||||
considerably shorter at the expense of losing some
|
||||
potentially interesting debugging information.
|
||||
|
||||
[[[[----aaaa ppppaaaasssssssswwwwdddd____ffffiiiilllleeee]]]]
|
||||
Specify the pathname of the file containing the
|
||||
approval password for the list. This password is
|
||||
|
||||
|
||||
|
||||
Page 2 (printed 12/10/96)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
rrrreeeesssseeeennnndddd((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV rrrreeeesssseeeennnndddd((((1111))))
|
||||
|
||||
|
||||
|
||||
used to check Approved: headers when relaying
|
||||
messages to lists that are marked as moderated
|
||||
through the ----AAAA option above.
|
||||
|
||||
[[[[----dddd]]]] Debug; print what would be done, but don't do it.
|
||||
|
||||
[[[[----ffff ffffrrrroooommmm----aaaaddddddddrrrr]]]]
|
||||
Set the From: address to ffffrrrroooommmm----aaaaddddddddrrrr
|
||||
|
||||
[[[[----hhhh hhhhoooosssstttt----nnnnaaaammmmeeee]]]]
|
||||
Set the name of the local host to hhhhoooosssstttt----nnnnaaaammmmeeee. This
|
||||
name will be used in the From: and To: lines when
|
||||
updating the headers.
|
||||
|
||||
----llll lllliiiisssstttt----nnnnaaaammmmeeee
|
||||
Specify the name of the mailing list as lllliiiisssstttt----nnnnaaaammmmeeee.
|
||||
This option is required, as rrrreeeesssseeeennnndddd uses this name
|
||||
to derive the names of many other files.
|
||||
|
||||
[[[[----nnnn]]]] Assign a sequence number to each message as it
|
||||
comes through. The next sequence number is stored
|
||||
in the file lists/list-name.seq. If the string
|
||||
$SEQNUM is found in the $subject-prefix
|
||||
configuration variable, it is replaced with the
|
||||
current sequence number. Thus, a $subject_prefix
|
||||
of "($LIST $SEQNUM)" would render a Subject: line
|
||||
of (list-name sequence-number).
|
||||
|
||||
[[[[----pppp pppprrrreeeecccceeeeddddeeeennnncccceeee]]]]
|
||||
Set the Precedence: header to pppprrrreeeecccceeeeddddeeeennnncccceeee.
|
||||
|
||||
[[[[----rrrr rrrreeeeppppllllyyyy----ttttoooo]]]]
|
||||
Set the Reply-To: header to rrrreeeeppppllllyyyy----ttttoooo.
|
||||
|
||||
[[[[----ssss]]]] Administrivia; Search the message for strings
|
||||
commonly found in administrative messages send to
|
||||
majordomo mailing lists (e.g. subscribe,
|
||||
unsubscribe). If these are found in the first 10
|
||||
or so lines of the message, the message will be
|
||||
relayed to the list owner instead of being sent on
|
||||
to the mailing list.
|
||||
|
||||
OOOOPPPPEEEERRRRAAAANNNNDDDDSSSS
|
||||
ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnn
|
||||
The alias to which to redirect the message if it
|
||||
is a proper list submission.
|
||||
|
||||
CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN
|
||||
FFFFIIIILLLLEEEESSSS
|
||||
////eeeettttcccc////aaaalllliiiiaaaasssseeeessss
|
||||
////eeeettttcccc////mmmmaaaajjjjoooorrrrddddoooommmmoooo....ccccffff
|
||||
lllliiiissssttttssss////lllliiiisssstttt----nnnnaaaammmmeeee....ccccoooonnnnffffiiiigggg
|
||||
|
||||
|
||||
|
||||
Page 3 (printed 12/10/96)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
rrrreeeesssseeeennnndddd((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV rrrreeeesssseeeennnndddd((((1111))))
|
||||
|
||||
|
||||
|
||||
SSSSEEEEEEEE AAAALLLLSSSSOOOO
|
||||
mmmmaaaajjjjoooorrrrddddoooommmmoooo((((8888)))),,,,aaaapppppppprrrroooovvvveeee((((1111))))
|
||||
|
||||
AAAAUUUUTTTTHHHHOOOORRRR
|
||||
Majordomo and most of the ancillary perl code was written by
|
||||
Brent Chapman <brent@GreatCircle.COM>. Majordomo is
|
||||
available via anonymous FTP from FTP.GreatCircle.COM, in the
|
||||
directory pub/majordomo. This man page was written by Shane
|
||||
McCarron <ahby@themacs.com>.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Page 4 (printed 12/10/96)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user