Update of /cvsroot/mailman/mailman/doc/man
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv15745
Modified Files:
add_members.1
Added Files:
find_member.1 list_members.1 remove_members.1 sync_members.1
Log Message:
More man pages for Mailman 2.1: find_member, list_members, remove_members and
sync_members.
--- NEW FILE: find_member.1 ---
add.\"
.\" GNU Mailman Manual
.\"
.\" remove_members
.\"
.\" Documenter: Terri Oda
.\" terri (at) zone12.com
.\" Created: September 13, 2004
.\" Last Updated: September 13, 2004
.\"
.TH find_member 1 "September 13, 2004" "Mailman 2.1" "GNU Mailman Manual"
.\"=====================================================================
.SH NAME
find_member \- Find all Mailman mailing lists to which a given address is
subscribed.
.\"=====================================================================
.SH SYNOPSIS
.B find_member
[-l \fIlistname\fP]
[-x \fIlistname\fP]
[-w]
[-h]
regex
.\"=====================================================================
.SH DESCRIPTION
Finds all Mailman mailing lists to which a member's address is subscribed.
.PP
The interaction between -l and -x is as follows. If any -l option is given
then only the named list will be included in the search. If any -x option is
given but no -l option is given, then all lists will be search except those
specifically excluded.
.PP
Regular expression syntax is Perl5-like, using the Python re module. Complete
specifications are at:
.PP
http://www.python.org/doc/current/lib/module-re.html
.PP
Address matches are case-insensitive, but case-preserved addresses are
displayed.
.\"=====================================================================
.SH OPTIONS
.IP "--listname=\fIlistname\fP, -l \fIlistname\fP"
Include only the named list in the search.
.IP "--exclude=\fIlistname\fP, -x \fIlistname\fP"
Exclude the named list from the search.
.IP "--owners, -w"
Search list owners as well as members.
.IP "--help, -h"
Print this help message and exit.
.IP regex
A Python regular expression to match.
.\"=====================================================================
.SH SEE ALSO
.BR add_members (1),
.BR list_members(1),
.BR remove_members (1)
.PP
The Mailman website: http://www.list.org
.\"=====================================================================
.SH AUTHOR
This man page was created by Terri Oda <terri (at) zone12.com>.
Use <[EMAIL PROTECTED]> to contact the developers.
--- NEW FILE: list_members.1 ---
add.\"
.\" GNU Mailman Manual
.\"
.\" remove_members
.\"
.\" Documenter: Terri Oda
.\" terri (at) zone12.com
.\" Created: September 13, 2004
.\" Last Updated: September 13, 2004
.\"
.TH list_member 1 "September 13, 2004" "Mailman 2.1" "GNU Mailman Manual"
.\"=====================================================================
.SH NAME
list_member \- List all the members of a Mailman mailing list.
.\"=====================================================================
.SH SYNOPSIS
.B list_member
[-o \fIfile\fP]
[-r]
[-d [\fIkind\fP]]
[-n [\fIwhy\fI]]
[-f]
[-p]
[-i]
[-u]
[-h]
listname
.\"=====================================================================
.SH DESCRIPTION
Lists all members of a mailing list.
.PP
Note that if neither -r or -d is supplied, both regular members are printed
first, followed by digest members, but no indication is given as to address
status.
.\"=====================================================================
.SH OPTIONS
.IP "--output \fIfile\fP, -o \fIfile\fP"
Write output to specified file instead of standard out.
.IP "--regular, -r"
Print just the regular (non-digest) members.
.IP "--digest[=\fIkind\fP], -d [\fIkind\fP]"
Print just the digest members. Optional argument can be "mime" or
"plain" which prints just the digest members receiving that kind of
digest.
.IP "--nomail[=\fIwhy\fP], -n[\fIwhy\fP]"
Print the members that have delivery disabled. Optional argument can
be "byadmin", "byuser", "bybounce", or "unknown" which prints just the
users who have delivery disabled for that reason. It can also be
"enabled" which prints just those member for whom delivery is
enabled.
.IP "--fullnames, -f"
Include the full names in the output.
.IP "--preserve, -p"
Output member addresses case preserved the way they were added to the
list. Otherwise, addresses are printed in all lowercase.
.IP "--invalid, -i"
Print only the addresses in the membership list that are invalid.
Ignores -r, -d, -n.
.IP "--unicode, -u"
Print addresses which are stored as Unicode objects instead of normal
string objects. Ignores -r, -d, -n.
.IP "--help, -h"
Print this help message and exit.
.IP "listname"
The name of the mailing list to use.
.\"=====================================================================
.SH SEE ALSO
.BR add_members (1),
.BR find_member(1),
.BR remove_members (1)
.PP
The Mailman website: http://www.list.org
.\"=====================================================================
.SH AUTHOR
This man page was created by Terri Oda <terri (at) zone12.com>.
Use <[EMAIL PROTECTED]> to contact the developers.
--- NEW FILE: remove_members.1 ---
add.\"
.\" GNU Mailman Manual
.\"
.\" remove_members
.\"
.\" Documenter: Terri Oda
.\" terri (at) zone12.com
.\" Created: September 13, 2004
.\" Last Updated: September 13, 2004
.\"
.TH remove_members 1 "September 13, 2004" "Mailman 2.1" "GNU Mailman Manual"
.\"=====================================================================
.SH NAME
remove_members \- Remove members from a Mailman mailing list.
.\"=====================================================================
.SH SYNOPSIS
.B remove_members
[-f \fIfile\fP]
[-a]
[--fromall]
[-n]
[-N]
[-h]
[listname]
[addr1 ...]
.\"=====================================================================
.SH DESCRIPTION
Remove members from a Mailman mailing list from the command line.
.\"=====================================================================
.SH OPTIONS
.IP "---file=\fIfile\fP, -f \fIfile\fP"
Remove member addresses found in the given file. If file is
`-', read stdin.
.IP "--all, -a"
Remove all members of the mailing list.
(mutually exclusive with --fromall)
.IP "--fromall"
Removes the given addresses from all the lists on this system
regardless of virtual domains if you have any. This option cannot be
used -a/--all. Also, you should not specify a listname when
using this option.
.IP "--nouserack, -n"
Don't send the admin acknowledgements. If not specified, the list
default value is used.
.IP "--help, -h"
Print this help message and exit.
.IP listname
The name of the mailing list to use.
.IP addr1 ...
Additional addresses to remove.
.\"=====================================================================
.SH SEE ALSO
.BR add_members (1),
.BR find_member(1),
.BR list_members (1)
.PP
The Mailman website: http://www.list.org
.\"=====================================================================
.SH AUTHOR
This man page was created by Terri Oda <terri (at) zone12.com>.
Use <[EMAIL PROTECTED]> to contact the developers.
--- NEW FILE: sync_members.1 ---
add.\"
.\" GNU Mailman Manual
.\"
.\" remove_members
.\"
.\" Documenter: Terri Oda
.\" terri (at) zone12.com
.\" Created: September 13, 2004
.\" Last Updated: September 13, 2004
.\"
.TH sync_members 1 "September 13, 2004" "Mailman 2.1" "GNU Mailman Manual"
.\"=====================================================================
.SH NAME
sync_members \- Synchronize a Mailman mailing list's membership with a flat file.
.\"=====================================================================
.SH SYNOPSIS
.B sync_members
[-n]
[-w <\fIyes|no\fP>]
[-g <\fIyes|no\fP>]
[-d <\fIyes|no\fP>]
[-a <\fIyes|no\fP>]
[-h]
-f \fIfilename\fP
listname
.\"=====================================================================
.SH DESCRIPTION
Synchronizes a Mailman mailing list's membership with a flat file.
.PP
This script is useful if you have a Mailman mailing list and a sendmail
:include: style list of addresses (also as is used in Majordomo). For every
address in the file that does not appear in the mailing list, the address is
added. For every address in the mailing list that does not appear in the
file, the address is removed. Other options control what happens when an
address is added or removed.
.\"=====================================================================
.SH OPTIONS
.IP "--no-change -n"
Don't actually make the changes. Instead, print out what would be
done to the list.
.IP "-welcome-msg[=<\fIyes|no\fP>], -w[=<\fIyes|no\fP>]"
Sets whether or not to send the newly added members a welcome
message, overriding whatever the list's `send_welcome_msg' setting
is. With -w=yes or -w, the welcome message is sent. With -w=no, no
message is sent.
.IP "--goodbye-msg[=<\fIyes|no\fP>], -g[=<\fIyes|no\fP>]"
Sets whether or not to send the goodbye message to removed members,
overriding whatever the list's `send_goodbye_msg' setting is. With
-g=yes or -g, the goodbye message is sent. With -g=no, no message is
sent.
.IP "--digest[=<\fIyes|no\fP>], -d[=<\fIyes|no\fP>]"
Selects whether to make newly added members receive messages in
digests. With -d=yes or -d, they become digest members. With -d=no
(or if no -d option given) they are added as regular members.
.IP "--notifyadmin[=<\fIyes|no\fP>], -a[=<\fIyes|no\fP>]"
Specifies whether the admin should be notified for each subscription
or unsubscription. If you're adding a lot of addresses, you
definitely want to turn this off! With -a=yes or -a, the admin is
notified. With -a=no, the admin is not notified. With no -a option,
the default for the list is used.
.IP "--file <\fIfilename | -\fp>, -f <\fIfilename | -\fP>"
This option is required. It specifies the flat file to synchronize
against. Email addresses must appear one per line. If filename is
`-' then stdin is used.
.IP "--help, -h"
Print this message.
.IP listname
Required. This specifies the list to synchronize.
.\"=====================================================================
.SH SEE ALSO
.BR add_members (1),
.BR list_members(1),
.BR remove_members (1)
.PP
The Mailman website: http://www.list.org
.\"=====================================================================
.SH AUTHOR
This man page was created by Terri Oda <terri (at) zone12.com>.
Use <[EMAIL PROTECTED]> to contact the developers.
Index: add_members.1
===================================================================
RCS file: /cvsroot/mailman/mailman/doc/man/add_members.1,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- add_members.1 12 Sep 2004 07:14:02 -0000 1.1
+++ add_members.1 13 Sep 2004 20:39:04 -0000 1.2
@@ -15,8 +15,8 @@
.\"=====================================================================
.SH SYNOPSIS
.B add_members
--r \fIfile\fP
--d \fIfile\fP
+[-r \fIfile\fP]
+[-d \fIfile\fP]
[-w <\fIy|n\fP>]
[-a <\fIy|n\fP>]
[-h]
@@ -47,9 +47,9 @@
The name of the list to which you wish to add members.
.\"=====================================================================
.SH SEE ALSO
-.BR remove_members (1),
-.BR list_members (1),
.BR find_member(1),
+.BR list_members (1),
+.BR remove_members (1)
.PP
The Mailman website: http://www.list.org
.\"=====================================================================
_______________________________________________
Mailman-checkins mailing list
[EMAIL PROTECTED]
Unsubscribe: http://mail.python.org/mailman/options/mailman-checkins/archive%40jab.org