Add Debian directory
[mspang/vmailman.git] / debian / manpages / list_members.8
1 .TH LIST_MEMBERS 8 2004-10-17
2 .SH NAME
3 list_members \- List all the members of a Mailman list
4
5 .SH SYNOPSIS
6 list_members [\-o file] [\-r] [\-d] [\-p] [\-h] listname
7
8 .SH OPTIONS
9
10 .PP
11 .TP
12 \fB\-o\fB \fIfile\fI, \fB\-\-\fBoutput\fB \fIfile\fI
13 Write output to specified file instead of standard out.
14
15 .TP
16 \fB\-r\fB, \fB\-\-\fBregular\fB
17 Print just the regular (non-digest) members.
18
19 .TP
20 \fB\-d\fR [\fIkind\fR], \fB\-\-digest\fR[=\fIkind\fR]
21 Print just the digest members.  Optional argument can be "\fImime\fR" or
22 "\fIplain\fR" which prints just the digest members receiving that kind of
23 digest.
24
25 .TP
26 \fB\-\-nomail\fR[=\fIwhy\fR], \fB\-n\fR [\fIwhy\fR]
27 Print the members that have delivery disabled.  Optional argument can
28 be "\fIbyadmin\fR", "\fIbyuser\fR", "\fIbybounce\fR", or "\fIunknown\fR"
29 which prints just the users who have delivery disabled for that reason.
30 It can also be "\fIenabled\fR" which prints just those member for whom
31 delivery is enabled.
32
33 .TP
34 \fB\-f\fR, \fB\-\-fullnames\fR
35 Include the full names in the output.
36
37 .TP
38 \fB\-p\fB, \fB\-\-\fBpreserve\fB
39 Output member addresses case preserved the way they were added to the
40 list.  Otherwise, addresses are printed in all lowercase.
41
42 .TP
43 \fB\-i\fR, \fB\-\-invalid\fR
44 Print only the addresses in the membership list that are invalid.
45 Ignores \-r, \-d, \-n.
46
47 .TP
48 \fB\-u\fR, \fB\-\-unicode\fR
49 Print addresses which are stored as Unicode objects instead of normal
50 string objects.  Ignores \-r, \-d, \-n.
51
52 .TP
53 \fB\-h\fB, \fB\-\-help\fB
54 Print a small help text and exit
55 .TP
56 .PP
57
58 listname is the name of the mailing list to use.
59
60 .SH NOTES
61
62 Note that if neither \-r or \-d is supplied, both regular members are printed
63 first, followed by digest members, but no indication is given as to address
64 status.
65
66 .SH AUTHOR
67 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
68 information.  This manpage is written by Tollef Fog Heen
69 <tfheen@debian.org> for Debian GNU/Linux.
70
71 .SH SEE ALSO
72 Mailman documentation on http://www.list.org/ and in
73 /usr/share/doc/mailman.