Add Debian directory
[mspang/vmailman.git] / debian / manpages / config_list.8
1 .TH CONFIG_LIST 8 2001-03-10
2 .SH NAME
3 config_list \- Configure a Mailman list from a text file description
4
5 .SH SYNOPSIS
6 config_list [options] listname
7
8 .SH DESCRIPTION
9
10 This is a very powerful script which lets you view and modify a list's
11 configuration variables from the command line.  E.g.  you can dump out
12 all the list options into a plain text file (actually a valid Python
13 file!), complete with comments explaining each variable.  Or you can
14 apply the configuration from such a file to a particular list.
15
16 .SH OPTIONS
17
18 .PP
19 .TP
20 \fB\-i\fB \fIfilename\fI, \fB\-\-inputfile\fB=\fIfilename\fI
21 Configure the list by assigning each module-global variable in the
22 file to an attribute on the list object, then saving the list.  The
23 named file is loaded with execfile() and must be legal Python code.
24 Any variable that isn't already an attribute of the list object is
25 ignored (a warning message is printed).  See also the \-c option.
26
27 A special variable named `mlist' is put into the globals during the
28 execfile, which is bound to the actual MailList object.  This lets you
29 do all manner of bizarre thing to the list object, but BEWARE!  Using
30 this can severely (and possibly irreparably) damage your mailing list!
31
32 .TP
33 \fB\-o\fB \fIfilename\fI, \fB\-\-\fBoutputfile\fB=\fIfilename\fI
34 Instead of configuring the list, print out a list's configuration
35 variables in a format suitable for input using this script.  In this
36 way, you can easily capture the configuration settings for a
37 particular list and imprint those settings on another list.  filename
38 is the file to output the settings to.  If filename is `-', standard
39 out is used.
40
41 .TP
42 \fB\-c\fB, \fB\-\-checkonly\fB 
43 The modified list is not actually changed.  Only useful with \-i.
44
45 .TP
46 \fB\-v\fB, \fB\-\-verbose\fB
47 Print the name of each attribute as it is being changed.  Only useful
48 with \-i.
49
50 .TP
51 \fB\-h\fB, \fB\-\-help\fB
52 Print a small help text and exit
53 .PP
54
55 .SH NOTES
56 The options \-o and \-i are mutually exclusive.
57
58 .SH AUTHOR
59 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
60 information.  This manpage is written by Tollef Fog Heen
61 <tfheen@debian.org> for Debian
62
63 .SH SEE ALSO
64 Mailman documentation on http://www.list.org/ and in
65 /usr/share/doc/mailman.