File: listadmin.man

package info (click to toggle)
listadmin 2.24-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 76 kB
  • ctags: 43
  • sloc: perl: 850; makefile: 74
file content (202 lines) | stat: -rw-r--r-- 6,921 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
.TH LISTADMIN 1 "24 Feb 2005"
.\" turn off hyphenation
.hy 0
.\" turn on ragged right if run through nroff
.if n .na
.SH NAME
listadmin \- process messages held by Mailman for approval

.SH SYNOPSIS
.B "listadmin [-f \fIconfigfile\fP] [-t \fIminutes\fP] [\fIlistname\fP]"

.SH DESCRIPTION
.I listadmin
is a textual alternative to Mailman's WWW interface for administering
mailing lists.

.SH OPTIONS
.IP "-f \fIconfigfile\fP"
Fetch list of mailing lists from \fIconfigfile\fP rather than the
default (\fB~/.listadmin.ini\fP).
.IP "-t \fIminutes\fP"
Stop processing after \fIminutes\fP has passed.  Mostly useful for
completely automated configurations of \fBlistadmin\fP.

.IP "\fIlistname\fP"
Only process the lists matching \fIlistname\fP.  Specify a complete
address, a substring or a regular expression.

.SH CONFIGURATION SYNTAX
The configuration file contains lines which can contain either a
comment, a directive, or a mailing list address.
.PP
A line can be continued by putting a backslash character at the end of
the line.  Any leading whitespace on the following line is removed.
.PP
Comments begin with the character # and extend to the end of line.
Backslash continuation is not applied to comments.
.PP
The argument to the directive can be put in double quotes to protect
space characters.  Inside double quotes, \\" can be used to include a \""
literal double quote, and \\\\ for a literal backslash.
.PP
.SH DIRECTIVES
A directive affects all the mailing lists addresses which follow after
it in the configuration file.  The directives are:
.RS
.IP "username \fIusername\fP"
Specifies the username to use for authentication.
.IP "password \fIpassword\fP"
Specifies the password to use for authentication.
.IP "adminurl \fIurl\fP"
The URL for maintaining Mailman requests.  Some substitutions are
performed: (examples below refer to the hypothetical list
\fIfoo-devel@example.net\fP)
.RS
.IP "{list}"
The local part of the list name, e.g., "foo-devel".
.IP "{domain}"
The domain part of the list name, e.g., "example.net".
.IP "{subdomain}"
The first component of the domain part, e.g., "example".
.RE
.IP "default \fIaction\fP"
Specifies the action to take when the user presses just Return.
Available actions are:
.RS
.IP "approve"
The message will be sent to all member of the list.
.IP "reject"
Notify sender that the message was rejected.
.IP "discard"
Throw message away, don't notify sender.
.IP "skip"
Don't decide now, leave it for later.
.IP "none"
Reset to no default action.
.RE
.IP "action \fIaction\fP"
This action will be taken for all messages where none of the other
rules apply (e.g., \fIspamlevel\fP, \fIdiscard_if_from\fP etc.), ie.,
whenever the user would have been asked what to do.  The same actions
as for \fIdefault\fP are available, although reject isn't very useful.
.IP "spamlevel \fInumber\fP"
This specifies the threshold for automatic discard of suspected spam
messages.  12 is unlikely to have false positives.  No user
confirmation is needed, so it is best to play it safe.  Less than 5 is
not recommended.
.IP "not_spam_if_from \fIpattern\fP"
If the message's From header matches the pattern, all automatic
actions will be cancelled and you will be asked what action to take
explicitly.  The pattern can use Perl regexp syntax.  If enclosed in
slashes, some modifiers can be added, a typical example being
\fB/pattern/i\fP to match case-insensitively.
.IP "not_spam_if_subject \fIpattern\fP"
As above, but matches against the Subject header.
.IP "discard_if_from \fIpattern\fP"
If the message's From header matches the pattern, it will be discarded
automatically.
.IP "discard_if_subject \fIpattern\fP"
As above, but matches against the Subject header.
.IP "discard_if_reason \fIpattern\fP"
As above, but matches against Mailman's reason for holding the message
for approval.
.IP "subscription_default \fIaction\fP"
Specifies the action to take when the user presses just Return while
processing subscriptions.  Available actions are:
.RS
.IP "accept"
The new subscriber will be added.
.IP "reject"
Notify sender that s/he was not allowed to join the list.
.IP "skip"
Don't decide now, leave it for later.
.IP "none"
Reset to no default action.
.RE
.IP "subscription_action \fIaction\fP"
This action will be taken \fBalways\fP for all new subscribers in the
relevant lists, no user interaction will take place.  The same actions
as for \fIsubscription_default\fP are available, although only skip is
very useful.  It is better to get automatic accept and reject
behaviour by changing the Mailman configuration.
.IP "confirm \fIyes|no\fP"
Before submitting changes, ask for confirmation.  Default is "yes".
.IP "log \fIfilename\fP"
Changes submitted to the web interface are logged.  All the changes
for one list are sent in batches at the end of processing.  The format
in the log is first a line containing the list name and a time stamp
in local time.  Then one line for each message, in the format
.IP
\fIaction\fP D:[\fIdate\fP] F:[\fIsender\fP] S:[\fIsubject\fP]
.IP
This batch of lines are terminated by a line saying \fBchanges sent to
server\fP.
.IP
The filename \fBnone\fP turns off logging.
.RE
.SH EXAMPLE
An example configuration file:
.nf
.ta +3m +4n
	# A comment, it must appear on a line by itself.
	#
	# Settings affect all lists being listed after it.

	username jdoe
	password Geheim
	default discard
	# This one works for Sourceforge:
	adminurl http://{domain}/lists/admindb/{list}

	slartibartfast@lists.sourceforge.net

	# This is how the default Mailman URLs look:
	adminurl http://{domain}/mailman/admindb/{list}

	# If the password contains quotes or spaces, you may need
	# to put it in quotes.  A complex example:
	password "\\"lise\\\\ "\""

	# These lists will still use the username [jdoe], but the
	# password is now ["lise\\ ].\""

	default approve
	discard_if_reason "Message has implicit|Too many recipients"
	discard_if_from ^(postmaster|mailer(-daemon)?|listproc|no-reply)@

	foo-devel@example.net

	# No one should ever send e-mail to the next list, so throw it
	# all away, without asking any questions
	action discard
	confirm no
	foo-announce@example.net
.fi

.SH FILES
\fB$HOME/.listadmin.ini\fP
.PP
The default configuration file.

.SH BUGS
.PP
The default behaviour with no adminurl specified in the configuration
file is only useful at the University of Oslo.
.PP
The SpamAssassin score is fetched from the header X-Spam-Level, the
value is the number of asterisks following.  It will also check a
header specific to the University of Oslo.  If this does not match
your setup, you will need to change the Perl code.  I'd be interested
in ideas on how to best make this configurable.
.PP
The HTML parser is quite fragile and depends on Mailman not to change
the format of its generated code.
.PP
Mailman 2.1 is not supported.
.PP
ISO 8859-1 environment is assumed.

.SH AUTHOR
Kjetil T. Homme <kjetilho+listadmin@ifi.uio.no>
.br