Add Debian directory
[mspang/vmailman.git] / debian / manpages / newlist.8
1 .TH NEWLIST 8 2006-08-09
2 .SH NAME
3 newlist \- Create a new, unpopulated mailing list.
4
5 .SH SYNOPSIS
6 newlist [options] listname listadmin-addr admin-password
7
8 .SH OPTIONS
9
10 .PP
11 .TP
12 \fB\-l\fR \fIlanguage\fR, \fB\-\-language\fR=\fIlanguage\fR
13 Make the list's preferred language `\fIlanguage\fR', which must be a two
14 letter language code.
15 .TP
16 \fB\-u\fR \fIurlhost\fR, \fB\-\-urlhost=\fR\fIurlhost\fR
17 Gives the list's web interface host name.
18 .TP
19 \fB\-e\fR \fIemailhost\fR, \fB\-\-emailhost=\fR\fIemailhost\fR
20 Gives the list's email domain name.
21 .TP
22 \fB\-q\fB, \fB\-\-quiet\fB
23 Normally the administrator is notified by email (after a prompt) that
24 their list has been created.  This option suppresses that
25 notification and the prompting.
26 .TP
27 \fB\-h\fB, \fB\-\-help\fB
28 Print a small help text and exit
29 .PP
30
31 .SH SECURITY
32 Including the admin-password on the command line is a small security
33 risk if you have untrusted users on the system.
34
35 .SH NOTES
36
37 You can specify as many of the arguments as you want on the command
38 line: you will be prompted for the missing ones.
39
40 Every Mailman list has two parameters which define the default host name for
41 outgoing email, and the default URL for all web interfaces.  When you
42 configured Mailman, certain defaults were calculated, but if you are running
43 multiple virtual Mailman sites, then the defaults may not be appropriate for
44 the list you are creating.
45
46 You also specify the domain to create your new list in by typing the command
47 like so:
48
49     newlist \-\-urlhost=www.mydom.ain mylist
50
51 where `www.mydom.ain' should be the base hostname for the URL to this virtual
52 hosts's lists.  E.g. with this setting people will view the general list
53 overviews at http://www.mydom.ain/mailman/listinfo.  Also, www.mydom.ain
54 should be a key in the VIRTUAL_HOSTS mapping in mm_cfg.py/Defaults.py if
55 the email hostname to be automatically determined.
56
57 If you want the email hostname to be different from the one looked up by the
58 VIRTUAL_HOSTS or if urlhost is not registered in VIRTUAL_HOSTS, you can specify
59 `emailhost' like so:
60
61     newlist \-\-urlhost=www.mydom.ain \-\-emailhost=mydom.ain mylist
62
63 where `mydom.ain' is the mail domain name. If you don't specify emailhost but
64 urlhost is not in the virtual host list, then mm_cfg.DEFAULT_EMAIL_HOST will
65 be used for the email interface.
66
67 For backward compatibility, you can also specify the domain to create your
68 new list in by spelling the listname like so:
69
70     mylist@www.mydom.ain
71
72 where www.mydom.ain is used for `urlhost' but it will also be used for
73 `emailhost' if it is not found in the virtual host table. Note
74 `\-\-urlhost' and `\-\-emailhost' have precedence to this notation.
75
76 If you spell the list name as just `mylist', then the email hostname will be
77 taken from DEFAULT_EMAIL_HOST and the url will be taken from DEFAULT_URL (as
78 defined in your Defaults.py file or overridden by settings in mm_cfg.py).
79
80 Note that listnames are forced to lowercase.
81
82 The list admin address need to be a fully-qualified address, like
83 owner@example.com, not just owner.
84
85
86 .SH AUTHOR
87 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
88 information.  This manpage is written by Tollef Fog Heen
89 <tfheen@debian.org> for Debian GNU/Linux.
90
91 .SH SEE ALSO
92 Mailman documentation on http://www.list.org/ and in
93 /usr/share/doc/mailman.