summaryrefslogtreecommitdiff
path: root/docs/man
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/add_members.160
-rw-r--r--docs/man/check_db.160
-rw-r--r--docs/man/check_perms.146
-rw-r--r--docs/man/clone_member.171
-rw-r--r--docs/man/find_member.164
-rw-r--r--docs/man/list_members.178
-rw-r--r--docs/man/remove_members.163
-rw-r--r--docs/man/sync_members.181
-rw-r--r--docs/man/transcheck.141
9 files changed, 564 insertions, 0 deletions
diff --git a/docs/man/add_members.1 b/docs/man/add_members.1
new file mode 100644
index 000000000..d442a2b66
--- /dev/null
+++ b/docs/man/add_members.1
@@ -0,0 +1,60 @@
+.\"
+.\" GNU Mailman Manual
+.\"
+.\" add_members
+.\"
+.\" Documenter: Terri Oda
+.\" terri (at) zone12.com
+.\" Created: September 12, 2004
+.\" Last Updated: September 12, 2004
+.\"
+.TH add_members 1 "September 12, 2004" "Mailman 2.1" "GNU Mailman Manual"
+.\"=====================================================================
+.SH NAME
+add_members \- Remove members from a Mailman mailing list.
+.\"=====================================================================
+.SH SYNOPSIS
+.B add_members
+[-r \fIfile\fP]
+[-d \fIfile\fP]
+[-w <\fIy|n\fP>]
+[-a <\fIy|n\fP>]
+[-h]
+\fIlistname\fP
+.\"=====================================================================
+.SH DESCRIPTION
+.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 `-'.
+.\"=====================================================================
+.SH OPTIONS
+.IP "--regular-members-file=\fIfile\fP, -r \fIfile\fP"
+A file containing addresses of the members to be added, one
+address per line. This list of people become non-digest
+members. If file is `-', read addresses from stdin. Note that
+-n/--non-digest-members-file are deprecated synonyms for this option.
+.IP "--digest-members-file=\fIfile\fP, -d \fIfile\fP"
+Similar to above, but these people become digest members.
+.IP "--welome-msg=<\fIy|n\fP>, -w <\fIy|n\fP>"
+Set whether or not to send the list members a welcome message,
+overriding whatever the list's `send_welcome_msg' setting is.
+.IP "--admin-notify=<\fIy|n\fP>, -a <\fIy|n\fP>"
+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 \fIlistname\fP
+The name of the list to which you wish to add members.
+.\"=====================================================================
+.SH SEE ALSO
+.BR clone_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/docs/man/check_db.1 b/docs/man/check_db.1
new file mode 100644
index 000000000..28a3b8149
--- /dev/null
+++ b/docs/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/docs/man/check_perms.1 b/docs/man/check_perms.1
new file mode 100644
index 000000000..76966a87c
--- /dev/null
+++ b/docs/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/docs/man/clone_member.1 b/docs/man/clone_member.1
new file mode 100644
index 000000000..35148f6af
--- /dev/null
+++ b/docs/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/docs/man/find_member.1 b/docs/man/find_member.1
new file mode 100644
index 000000000..9d76bf5db
--- /dev/null
+++ b/docs/man/find_member.1
@@ -0,0 +1,64 @@
+add.\"
+.\" GNU Mailman Manual
+.\"
+.\" find_member
+.\"
+.\" 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]
+\fIregex\fP
+.\"=====================================================================
+.SH DESCRIPTION
+.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
+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 help message and exit.
+.IP \fIregex\fP
+A Python regular expression to match.
+.\"=====================================================================
+.SH SEE ALSO
+.BR add_members (1),
+.BR clone_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/docs/man/list_members.1 b/docs/man/list_members.1
new file mode 100644
index 000000000..cbf338a40
--- /dev/null
+++ b/docs/man/list_members.1
@@ -0,0 +1,78 @@
+add.\"
+.\" GNU Mailman Manual
+.\"
+.\" list_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]
+\fIlistname\fP
+.\"=====================================================================
+.SH DESCRIPTION
+.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
+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 help message and exit.
+.IP "\fIlistname\fP"
+The name of the mailing list to use.
+.\"=====================================================================
+.SH SEE ALSO
+.BR add_members (1),
+.BR clone_member (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 <mailman-developers@python.org> to contact the developers.
diff --git a/docs/man/remove_members.1 b/docs/man/remove_members.1
new file mode 100644
index 000000000..69ed545d6
--- /dev/null
+++ b/docs/man/remove_members.1
@@ -0,0 +1,63 @@
+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]
+[\fIlistname\fP]
+[\fIaddr1\fP ...]
+.\"=====================================================================
+.SH DESCRIPTION
+.B remove_members
+removes 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 help message and exit.
+.IP \fPlistname\fI
+The name of the mailing list to use.
+.IP \fPaddr1\fI ...
+Additional addresses to remove.
+.\"=====================================================================
+.SH SEE ALSO
+.BR add_members (1),
+.BR clone_member (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 <mailman-developers@python.org> to contact the developers.
diff --git a/docs/man/sync_members.1 b/docs/man/sync_members.1
new file mode 100644
index 000000000..b185ae3c1
--- /dev/null
+++ b/docs/man/sync_members.1
@@ -0,0 +1,81 @@
+add.\"
+.\" GNU Mailman Manual
+.\"
+.\" list_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
+\fIlistname\fP
+.\"=====================================================================
+.SH DESCRIPTION
+.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
+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 help message.
+.IP \fIlistname\fP
+Required. This specifies the list to synchronize.
+.\"=====================================================================
+.SH SEE ALSO
+.BR add_members (1),
+.BR clone_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/docs/man/transcheck.1 b/docs/man/transcheck.1
new file mode 100644
index 000000000..6e16a10f8
--- /dev/null
+++ b/docs/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.