diff options
Diffstat (limited to 'doc/man')
| -rw-r--r-- | doc/man/add_members.1 | 10 | ||||
| -rw-r--r-- | doc/man/check_db.1 | 60 | ||||
| -rw-r--r-- | doc/man/check_perms.1 | 46 | ||||
| -rw-r--r-- | doc/man/clone_member.1 | 71 | ||||
| -rw-r--r-- | doc/man/find_member.1 | 14 | ||||
| -rw-r--r-- | doc/man/list_members.1 | 14 | ||||
| -rw-r--r-- | doc/man/remove_members.1 | 16 | ||||
| -rw-r--r-- | doc/man/sync_members.1 | 14 | ||||
| -rw-r--r-- | doc/man/transcheck.1 | 41 |
9 files changed, 257 insertions, 29 deletions
diff --git a/doc/man/add_members.1 b/doc/man/add_members.1 index eb3c020b0..d442a2b66 100644 --- a/doc/man/add_members.1 +++ b/doc/man/add_members.1 @@ -20,10 +20,11 @@ add_members \- Remove members from a Mailman mailing list. [-w <\fIy|n\fP>] [-a <\fIy|n\fP>] [-h] -listname +\fIlistname\fP .\"===================================================================== .SH DESCRIPTION -Adds members to a Mailman mailing list from the command line. +.B add_members +adds members to a Mailman mailing list from the command line. .PP You must supply at least one of -r and -d options. At most one of the files can be `-'. @@ -43,11 +44,12 @@ overriding whatever the list's `send_welcome_msg' setting is. Set whether or not to send the list administrators a notification on the success/failure of these subscriptions, overriding whatever the list's `admin_notify_mchanges' setting is. -.IP listname +.IP \fIlistname\fP The name of the list to which you wish to add members. .\"===================================================================== .SH SEE ALSO -.BR find_member(1), +.BR clone_member (1), +.BR find_member (1), .BR list_members (1), .BR remove_members (1) .PP diff --git a/doc/man/check_db.1 b/doc/man/check_db.1 new file mode 100644 index 000000000..28a3b8149 --- /dev/null +++ b/doc/man/check_db.1 @@ -0,0 +1,60 @@ +.\" +.\" GNU Mailman Manual +.\" +.\" check_db +.\" +.\" Documenter: Terri Oda +.\" terri (at) zone12.com +.\" Created: September 14, 2004 +.\" Last Updated: September 14, 2004 +.\" +.TH check_db 1 "September 14, 2004" "Mailman 2.1" "GNU Mailman Manual" +.\"===================================================================== +.SH NAME +check_db \- Check a Mailman mailing list's config database file for integrity. +.\"===================================================================== +.SH SYNOPSIS +.B check_db +[-a] +[-v] +[-h] +[\fIlistname\fP [\fIlistname\fP ...]] +.\"===================================================================== +.SH DESCRIPTION +.B check_db +checks a list's config database file for integrity. +.PP +All of the following files are checked: +.RS + config.pck + config.pck.last + config.db + config.db.last + config.safety +.RE +.PP +It's okay if any of these are missing. config.pck and config.pck.last are +pickled versions of the config database file for 2.1a3 and beyond. config.db +and config.db.last are used in all earlier versions, and these are Python +marshals. config.safety is a pickle written by 2.1a3 and beyond when the +primary config.pck file could not be read. +.\"===================================================================== +.SH OPTIONS +.IP "--all, -a" +Check the databases for all lists. Otherwise only the lists named on +the command line are checked. +.IP "--verbose, -v" +Verbose output. The state of every tested file is printed. +Otherwise only corrupt files are displayed. +.IP "--help, -h" +Print help text and exit. +.\"===================================================================== +.SH SEE ALSO +.BR check_perms (1), +.BR transcheck (1) +.PP +The Mailman website: http://www.list.org +.\"===================================================================== +.SH AUTHOR +This man page was created by Terri Oda <terri (at) zone12.com>. +Use <mailman-developers@python.org> to contact the developers. diff --git a/doc/man/check_perms.1 b/doc/man/check_perms.1 new file mode 100644 index 000000000..76966a87c --- /dev/null +++ b/doc/man/check_perms.1 @@ -0,0 +1,46 @@ +.\" +.\" GNU Mailman Manual +.\" +.\" check_perms +.\" +.\" Documenter: Terri Oda +.\" terri (at) zone12.com +.\" Created: September 14, 2004 +.\" Last Updated: September 14, 2004 +.\" +.TH check_perms 1 "September 14, 2004" "Mailman 2.1" "GNU Mailman Manual" +.\"===================================================================== +.SH NAME +check_perms \- Check the permissions for the Mailman installation. +.\"===================================================================== +.SH SYNOPSIS +.B check_perms +[-f] +[-v] +[-h] +.\"===================================================================== +.SH DESCRIPTION +.B check_perms +checks the permissions for the Mailman installation. +.PP +With no arguments, just check and report all the files that have bogus +permissions or group ownership. With -f (and run as root), fix all the +permission problems found. With -v be verbose. +.\"===================================================================== +.SH OPTIONS +.IP "-f" +Run as root and fix all the permission problems found. +.IP "-v" +Verbose output. +.IP "--help, -h" +Print help message and exit. +.\"===================================================================== +.SH SEE ALSO +.BR check_db (1), +.BR transcheck (1) +.PP +The Mailman website: http://www.list.org +.\"===================================================================== +.SH AUTHOR +This man page was created by Terri Oda <terri (at) zone12.com>. +Use <mailman-developers@python.org> to contact the developers. diff --git a/doc/man/clone_member.1 b/doc/man/clone_member.1 new file mode 100644 index 000000000..35148f6af --- /dev/null +++ b/doc/man/clone_member.1 @@ -0,0 +1,71 @@ +.\" +.\" GNU Mailman Manual +.\" +.\" clone_member +.\" +.\" Documenter: Terri Oda +.\" terri (at) zone12.com +.\" Created: September 14, 2004 +.\" Last Updated: September 14, 2004 +.\" +.TH clone_member 1 "September 14, 2004" "Mailman 2.1" "GNU Mailman Manual" +.\"===================================================================== +.SH NAME +clone_member \- Clone a Mailman mailing list member address. +.\"===================================================================== +.SH SYNOPSIS +.B clone_member +[-l \fIlistname\fP] +[-r] +[-a] +[-q] +[-n] +[-h] +\fIfromoldaddr\fP \fItonewaddr\fP +.\"===================================================================== +.SH DESCRIPTION +.B clone_member +clones a member address. +.PP +Cloning a member address means that a new member will be added who has all the +same options and passwords as the original member address. Note that this +operation is fairly trusting of the user who runs it -- it does no +verification to the new address, it does not send out a welcome message, etc. +.PP +The existing member's subscription is usually not modified in any way. If you +want to remove the old address, use the -r flag. If you also want to change +any list admin addresses, use the -a flag. +.\"===================================================================== +.SH OPTIONS +.IP "--listname=\fIlistname\fP, -l \fIlistname\fP" +Check and modify only the named mailing lists. If -l is not given, +then all mailing lists are scanned from the address. Multiple -l +options can be supplied. +.IP "--remove, -r" +Remove the old address from the mailing list after it's been cloned. +.IP "--admin, -a" +Scan the list admin addresses for the old address, and clone or change +them too. +.IP "--quiet, -q" +Do the modifications quietly. +.IP "--nomodify, -n" +Print what would be done, but don't actually do it. Inhibits the +--quiet flag. +.IP "--help, -h" +Print help message and exit. +.IP \fIfromoldaddr\fP +(`from old address') is the old address of the user. +.IP \fItonewaddr\fP +(`to new address') is the new address of the user. +.\"===================================================================== +.SH SEE ALSO +.BR add_member (1), +.BR find_member (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 <mailman-developers@python.org> to contact the developers. diff --git a/doc/man/find_member.1 b/doc/man/find_member.1 index c9f3fa05d..9d76bf5db 100644 --- a/doc/man/find_member.1 +++ b/doc/man/find_member.1 @@ -1,7 +1,7 @@ add.\" .\" GNU Mailman Manual .\" -.\" remove_members +.\" find_member .\" .\" Documenter: Terri Oda .\" terri (at) zone12.com @@ -20,10 +20,11 @@ subscribed. [-x \fIlistname\fP] [-w] [-h] -regex +\fIregex\fP .\"===================================================================== .SH DESCRIPTION -Finds all Mailman mailing lists to which a member's address is subscribed. +.B find_member +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 @@ -46,13 +47,14 @@ 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 +Print help message and exit. +.IP \fIregex\fP A Python regular expression to match. .\"===================================================================== .SH SEE ALSO .BR add_members (1), -.BR list_members(1), +.BR clone_member (1), +.BR list_members (1), .BR remove_members (1) .PP The Mailman website: http://www.list.org diff --git a/doc/man/list_members.1 b/doc/man/list_members.1 index 45b4f3e46..cbf338a40 100644 --- a/doc/man/list_members.1 +++ b/doc/man/list_members.1 @@ -1,7 +1,7 @@ add.\" .\" GNU Mailman Manual .\" -.\" remove_members +.\" list_members .\" .\" Documenter: Terri Oda .\" terri (at) zone12.com @@ -24,10 +24,11 @@ list_member \- List all the members of a Mailman mailing list. [-i] [-u] [-h] -listname +\fIlistname\fP .\"===================================================================== .SH DESCRIPTION -Lists all members of a mailing list. +.B list_member +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 @@ -60,13 +61,14 @@ Ignores -r, -d, -n. 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" +Print help message and exit. +.IP "\fIlistname\fP" The name of the mailing list to use. .\"===================================================================== .SH SEE ALSO .BR add_members (1), -.BR find_member(1), +.BR clone_member (1), +.BR find_member (1), .BR remove_members (1) .PP The Mailman website: http://www.list.org diff --git a/doc/man/remove_members.1 b/doc/man/remove_members.1 index a717415f8..69ed545d6 100644 --- a/doc/man/remove_members.1 +++ b/doc/man/remove_members.1 @@ -21,11 +21,12 @@ remove_members \- Remove members from a Mailman mailing list. [-n] [-N] [-h] -[listname] -[addr1 ...] +[\fIlistname\fP] +[\fIaddr1\fP ...] .\"===================================================================== .SH DESCRIPTION -Remove members from a Mailman mailing list from the command line. +.B remove_members +removes members from a Mailman mailing list from the command line. .\"===================================================================== .SH OPTIONS .IP "---file=\fIfile\fP, -f \fIfile\fP" @@ -43,15 +44,16 @@ using this option. 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 +Print help message and exit. +.IP \fPlistname\fI The name of the mailing list to use. -.IP addr1 ... +.IP \fPaddr1\fI ... Additional addresses to remove. .\"===================================================================== .SH SEE ALSO .BR add_members (1), -.BR find_member(1), +.BR clone_member (1), +.BR find_member (1), .BR list_members (1) .PP The Mailman website: http://www.list.org diff --git a/doc/man/sync_members.1 b/doc/man/sync_members.1 index 0f3665b49..b185ae3c1 100644 --- a/doc/man/sync_members.1 +++ b/doc/man/sync_members.1 @@ -1,7 +1,7 @@ add.\" .\" GNU Mailman Manual .\" -.\" remove_members +.\" list_members .\" .\" Documenter: Terri Oda .\" terri (at) zone12.com @@ -22,10 +22,11 @@ sync_members \- Synchronize a Mailman mailing list's membership with a flat file [-a <\fIyes|no\fP>] [-h] -f \fIfilename\fP -listname +\fIlistname\fP .\"===================================================================== .SH DESCRIPTION -Synchronizes a Mailman mailing list's membership with a flat file. +.B sync_members +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 @@ -63,13 +64,14 @@ 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 +Print help message. +.IP \fIlistname\fP Required. This specifies the list to synchronize. .\"===================================================================== .SH SEE ALSO .BR add_members (1), -.BR list_members(1), +.BR clone_member (1), +.BR list_members (1), .BR remove_members (1) .PP The Mailman website: http://www.list.org diff --git a/doc/man/transcheck.1 b/doc/man/transcheck.1 new file mode 100644 index 000000000..6e16a10f8 --- /dev/null +++ b/doc/man/transcheck.1 @@ -0,0 +1,41 @@ +.\" +.\" GNU Mailman Manual +.\" +.\" transcheck +.\" +.\" Documenter: Terri Oda +.\" terri (at) zone12.com +.\" Created: September 18, 2004 +.\" Last Updated: September 18, 2004 +.\" +.TH transcheck 1 "September 18, 2004" "Mailman 2.1" "GNU Mailman Manual" +.\"===================================================================== +.SH NAME +transcheck \- Check a given Mailman translation +.\"===================================================================== +.SH SYNOPSIS +.B transcheck +[-q] +\fIlang\fP +.\"===================================================================== +.SH DESCRIPTION +.B transcheck +checks a given Mailman translation, making sure that variables and +tags referenced in translation are the same variables and tags in +the original templates and catalog. +.\"===================================================================== +.SH OPTIONS +.IP "-q" +Asks for a brief summary. +.IP "\fIlang\fP" +Your country code. (e.g. 'it' for Italy) +.\"===================================================================== +.SH SEE ALSO +.BR check_perms (1), +.BR check_db (1) +.PP +The Mailman website: http://www.list.org +.\"===================================================================== +.SH AUTHOR +This man page was created by Terri Oda <terri (at) zone12.com>. +Use <mailman-developers@python.org> to contact the developers. |
