Add Debian directory
[mspang/vmailman.git] / debian / manpages / sync_members.8
1 .TH SYNC_MEMBERS 8 2006-08-09
2 .SH NAME
3 sync_members \- Synchronize a mailing list's membership with a flat file.
4
5 .SH SYNOPSIS
6 sync_members [options] \-f file listname
7
8 .SH DESCRIPTION
9
10 This script is useful if you have a Mailman mailing list and a sendmail
11 :include: style list of addresses (also as is used in Majordomo).  For every
12 address in the file that does not appear in the mailing list, the address is
13 added.  For every address in the mailing list that does not appear in the
14 file, the address is removed.  Other options control what happens when an
15 address is added or removed.
16
17 .SH OPTIONS
18
19 .PP
20 .TP
21 \fB\-n\fB, \fB\-\-no\-change\fB
22 Don't actually make the changes.  Instead, print out what would be
23 done to the list.
24
25 .TP
26 \fB\-w\fB=\fI{ yes | no }\fI, \fB\-\-welcome\-msg\fB=\fI{ yes | no }\fI
27 Sets whether or not to send the newly added members a welcome message,
28 overriding whatever the list's `send_welcome_msg' setting is.  With
29 \fB\-w=yes\fB or \fB\-w\fB, the welcome message is sent.  With
30 \fB\-w=no\fB, no message is sent.
31
32 .TP
33 \fB\-g\fB=\fI{ yes | no }\fI, \fB\-\-goodbye\-msg\fB=\fI{ yes | no }\fI
34 Sets whether or not to send the goodbye message to removed members,
35 overriding whatever the list's `send_goodbye_msg' setting is.  With
36 \fB\-g=yes\fB or \fB\-g\fB, the goodbye message is sent.  With
37 \fB\-g=no\fB, no message is sent.
38
39 .TP
40 \fB\-d\fB=\fI{ yes | no }\fI, \fB\-\-digest\fB=\fI{ yes | no }\fI
41 Selects whether to make newly added members receive messages in
42 digests.  With \fB\-d=yes\fB or \fB\-d\fB, they become digest members.
43 With \fB\-d=no\fB (or if no \-d option given) they are added as
44 regular members.
45
46 .TP
47 \fB\-a\fB=\fI{ yes | no }\fI, \fB\-\-notifyadmin\fB=\fI{ yes | no }\fI
48 Specifies whether the admin should be notified for each subscription
49 or unsubscription.  If you're adding a lot of addresses, you
50 definitely want to turn this off!  With \fB\-a=yes\fB or \fB\-a\fB,
51 the admin is notified.  With \fB\-a=no\fB, the admin is not notified.
52 With no \fB\-a\fB option, the default for the list is used.
53
54 .TP
55 \fB\-f\fB=\fIfilename\fI, \fB\-\-file\fB=\fIfilename\fI
56 This option is required.  It specifies the flat file to synchronize
57 against.  Email addresses must appear one per line.  If filename is
58 `\-' then stdin is used.
59
60 .TP
61 \fB\-h\fB, \fB\-\-help\fB
62 Print a small help text and exit
63 .PP
64
65 listname specifies the list to synchronize.
66
67 .SH AUTHOR
68 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
69 information.  This manpage is written by Tollef Fog Heen
70 <tfheen@debian.org> for Debian
71
72 .SH SEE ALSO
73 Mailman documentation on http://www.list.org/ and in
74 /usr/share/doc/mailman.