[Pkg-mailman-hackers] Pkg-mailman commit - rev 299 - in
trunk/debian: . manpages
Thijs Kinkhorst
thijs at costa.debian.org
Fri Aug 11 07:57:50 UTC 2006
Author: thijs
Date: 2006-08-11 07:57:47 +0000 (Fri, 11 Aug 2006)
New Revision: 299
Modified:
trunk/debian/changelog
trunk/debian/manpages/add_members.8
trunk/debian/manpages/check_db.8
trunk/debian/manpages/list_lists.8
trunk/debian/manpages/mmarch.8
trunk/debian/manpages/mmsitepass.8
trunk/debian/manpages/newlist.8
trunk/debian/manpages/remove_members.8
trunk/debian/manpages/rmlist.8
trunk/debian/manpages/sync_members.8
Log:
* Update all man pages to be in line with current mailman functionality
(Closes: #286607, #276952).
Modified: trunk/debian/changelog
===================================================================
--- trunk/debian/changelog 2006-08-11 07:54:05 UTC (rev 298)
+++ trunk/debian/changelog 2006-08-11 07:57:47 UTC (rev 299)
@@ -2,11 +2,13 @@
* Add example apache.conf under /etc/mailman
(Closes: #282460, #135148, #178543, #179253).
+ * Update all man pages to be in line with current mailman functionality
+ (Closes: #286607, #276952).
* Add suggests on lynx (Closes: #296781).
* Checked for policy 3.7.2, no changes necessary.
* Add watch file.
- -- Thijs Kinkhorst <thijs at debian.org> Fri, 11 Aug 2006 09:53:00 +0200
+ -- Thijs Kinkhorst <thijs at debian.org> Fri, 11 Aug 2006 09:54:15 +0200
mailman (2.1.8-1) unstable; urgency=low
Modified: trunk/debian/manpages/add_members.8
===================================================================
--- trunk/debian/manpages/add_members.8 2006-08-11 07:54:05 UTC (rev 298)
+++ trunk/debian/manpages/add_members.8 2006-08-11 07:57:47 UTC (rev 299)
@@ -1,9 +1,9 @@
-.TH ADD_MEMBERS 8 2001-03-10
+.TH ADD_MEMBERS 8 2006-08-09
.SH NAME
add_members \- Add members to a list from the command line.
.SH SYNOPSIS
-add_members [\-n <file>] [\-d <file>] [\-c <y|n>] [\-w <y|n>] [\-h] listname
+add_members [\-r <file>] [\-d <file>] [\-y <y|n>] [\-w <y|n>] [\-h] listname
.SH DESCRIPTION
@@ -13,27 +13,29 @@
.SH OPTIONS
.TP
-\fB\-n\fB \fIfile\fI, \fB\-\-\fBnon-digest-members-file\fB \fIfile\fI
+\fB\-r\fB \fIfile\fI, \fB\-\-\fBregular-members-file=\fB\fIfile\fI
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.
+`-', read addresses from stdin. Note that -n/--non-digest-members-file
+are deprecated synonyms for this option.
.TP
-\fB\-d\fB \fIfile\fI, \fB\-\-\fBdigest-members-file\fB \fIfile\fI
+\fB\-d\fB \fIfile\fI, \fB\-\-\fBdigest-members-file=\fB\fIfile\fI
Similar to above, but these people become digest members.
.TP
-\fB\-c [y|n]\fB, \fB\-\-changes-msg [y|n]\fB
+\fB\-a [y|n]\fB, \fB\-\-admin-notify=[y|n]\fB
-Whether or not to send the list members the `there's going to be big
-changes to your list' message. defaults to no.
+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.
.TP
-\fB\-w [y|n]\fB, \fB\-\-welcome-msg [y|n]\fB
+\fB\-w [y|n]\fB, \fB\-\-welcome-msg=[y|n]\fB
-set whether or not to send the list members a welcome message,
+Set whether or not to send the list members a welcome message,
overriding whatever the list's `send_welcome_msg' setting is.
.TP
@@ -43,7 +45,7 @@
.SH NOTES
-You must supply at least one of -n and -d options. At most one of the
+You must supply at least one of -r and -d options. At most one of the
files can be `-'.
.SH AUTHOR
Modified: trunk/debian/manpages/check_db.8
===================================================================
--- trunk/debian/manpages/check_db.8 2006-08-11 07:54:05 UTC (rev 298)
+++ trunk/debian/manpages/check_db.8 2006-08-11 07:57:47 UTC (rev 299)
@@ -1,15 +1,34 @@
-.TH CHECK_DB 8 2001-03-10
+.TH CHECK_DB 8 2006-08-09
.SH NAME
check_db \- Check the integrity of a list's database file
.SH SYNOPSIS
-check_db listname
+check_db [options] [listname [listname ...]]
.SH DESCRIPTION
check_db checks the integrity of a list's config.db and
config.db.last database files.
+.SH OPTIONS
+
+.TP
+\fB\-a\fB, \fB\-\-\fBall\fB
+
+Check the databases for all lists. Otherwise only the lists named on
+the command line are checked.
+
+.TP
+\fB\-v\fB, \fB\-\-\fBverbose\fB
+
+Verbose output. The state of every tested file is printed.
+Otherwise only corrupt files are displayed.
+
+.TP
+\fB\-h\fB, \fB\-\-\fBhelp\fB
+
+Print a help text and exit.
+
.SH AUTHOR
Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
information. This manpage is written by Tollef Fog Heen
Modified: trunk/debian/manpages/list_lists.8
===================================================================
--- trunk/debian/manpages/list_lists.8 2006-08-11 07:54:05 UTC (rev 298)
+++ trunk/debian/manpages/list_lists.8 2006-08-11 07:57:47 UTC (rev 299)
@@ -1,4 +1,4 @@
-.TH LIST_LISTS 8 2001-03-10
+.TH LIST_LISTS 8 2006-08-09
.SH NAME
list_lists \- List all Mailman mailing lists on this host
@@ -16,6 +16,8 @@
List only those mailing lists that are homed to the given virtual
domain. This only works if the VIRTUAL_HOST_OVERVIEW variable is
set.
+\fB\-b\fB, \fB\-\-\fBbare\fB
+Displays only the list name, with no description.
\fB\-h\fB, \fB\-\-help\fB
Print a small help text and exit
.PP
Modified: trunk/debian/manpages/mmarch.8
===================================================================
--- trunk/debian/manpages/mmarch.8 2006-08-11 07:54:05 UTC (rev 298)
+++ trunk/debian/manpages/mmarch.8 2006-08-11 07:57:47 UTC (rev 299)
@@ -1,9 +1,9 @@
-.TH MMARCH 8 2001-03-10
+.TH MMARCH 8 2006-08-09
.SH NAME
mmarch \- Rebuild a Mailman list's archive.
.SH SYNOPSIS
-mmarch listname [mbox] [-h]
+mmarch listname [options] <listname> [<mbox>]
.SH DESCRIPTION
@@ -11,6 +11,33 @@
do this if you edit some messages in an archive, or remove some messages from
an archive.
+\fB\-h\fB, \fB\-\-\fBhelp\fB
+
+Print this error message and exit.
+
+\fB\-q\fB, \fB\-\-\fBquiet\fB
+
+Make the archiver output less verbose.
+
+\fB\-\-\fBwipe\fB
+
+First wipe out the original archive before regenerating. You usually
+want to specify this argument unless you're generating the archive in
+chunks.
+
+\fB\-s\fB \fIN\fI, \fB\-\-\fBstart=\fB\fIN\fI
+
+Start indexing at article N, where article 0 is the first in the mbox.
+Defaults to 0.
+
+\fB\-e\fB \fIM\fI, \fB\-\-\fBend=\fB\fIM\fI
+
+End indexing at article M. This script is not very efficient with
+respect to memory management, and for large archives, it may not be
+possible to index the mbox entirely. For that reason, you can specify
+the start and end article numbers.
+
+
mbox is the path to a list's complete mbox archive. Usually this will
be some path in the archives/private directory. For example:
Modified: trunk/debian/manpages/mmsitepass.8
===================================================================
--- trunk/debian/manpages/mmsitepass.8 2006-08-11 07:54:05 UTC (rev 298)
+++ trunk/debian/manpages/mmsitepass.8 2006-08-11 07:57:47 UTC (rev 299)
@@ -1,4 +1,4 @@
-.TH MMSITEPASS 8 2001-03-10
+.TH MMSITEPASS 8 2006-08-09
.SH NAME
mmsitepass \- Set the Mailman site password, prompting from the terminal.
@@ -8,6 +8,11 @@
.SH OPTIONS
.PP
+\fB\-c\fB, \fB\-\-listcreator\fB
+Set the list creator password instead of the site password. The list
+creator is authorized to create and remove lists, but does not have
+the total power of the site administrator.
+
\fB\-h\fB, \fB\-\-help\fB
Print a small help text and exit
.PP
Modified: trunk/debian/manpages/newlist.8
===================================================================
--- trunk/debian/manpages/newlist.8 2006-08-11 07:54:05 UTC (rev 298)
+++ trunk/debian/manpages/newlist.8 2006-08-11 07:57:47 UTC (rev 299)
@@ -1,4 +1,4 @@
-.TH NEWLIST 8 2004-10-17
+.TH NEWLIST 8 2006-08-09
.SH NAME
newlist \- Create a new, unpopulated mailing list.
@@ -9,10 +9,16 @@
.PP
.TP
-\fB\-l\fR \fIlanguage\fR, \fB\-\-language\fR \fIlanguage\fR
+\fB\-l\fR \fIlanguage\fR, \fB\-\-language\fR=\fIlanguage\fR
Make the list's preferred language `\fIlanguage\fR', which must be a two
letter language code.
.TP
+\fB\-u\fR \fIurlhost\fR, \fB\-\-urlhost=\fR\fIurlhost\fR
+Gives the list's web interface host name.
+.TP
+\fB\-e\fR \fIemailhost\fR, \fB\-\-emailhost=\fR\fIemailhost\fR
+Gives the list's email domain name.
+.TP
\fB\-q\fB, \fB\-\-quiet\fB
Normally the administrator is notified by email (after a prompt) that
their list has been created. This option suppresses that
@@ -31,9 +37,52 @@
You can specify as many of the arguments as you want on the command
line: you will be prompted for the missing ones.
-Listnames are forced to lowercase.
+Every Mailman list has two parameters which define the default host name for
+outgoing email, and the default URL for all web interfaces. When you
+configured Mailman, certain defaults were calculated, but if you are running
+multiple virtual Mailman sites, then the defaults may not be appropriate for
+the list you are creating.
+You also specify the domain to create your new list in by typing the command
+like so:
+ newlist \-\-urlhost=www.mydom.ain mylist
+
+where `www.mydom.ain' should be the base hostname for the URL to this virtual
+hosts's lists. E.g. with this setting people will view the general list
+overviews at http://www.mydom.ain/mailman/listinfo. Also, www.mydom.ain
+should be a key in the VIRTUAL_HOSTS mapping in mm_cfg.py/Defaults.py if
+the email hostname to be automatically determined.
+
+If you want the email hostname to be different from the one looked up by the
+VIRTUAL_HOSTS or if urlhost is not registered in VIRTUAL_HOSTS, you can specify
+`emailhost' like so:
+
+ newlist \-\-urlhost=www.mydom.ain \-\-emailhost=mydom.ain mylist
+
+where `mydom.ain' is the mail domain name. If you don't specify emailhost but
+urlhost is not in the virtual host list, then mm_cfg.DEFAULT_EMAIL_HOST will
+be used for the email interface.
+
+For backward compatibility, you can also specify the domain to create your
+new list in by spelling the listname like so:
+
+ mylist at www.mydom.ain
+
+where www.mydom.ain is used for `urlhost' but it will also be used for
+`emailhost' if it is not found in the virtual host table. Note that
+'\-\-urlhost' and '\-\-emailhost' have precedence to this notation.
+
+If you spell the list name as just `mylist', then the email hostname will be
+taken from DEFAULT_EMAIL_HOST and the url will be taken from DEFAULT_URL (as
+defined in your Defaults.py file or overridden by settings in mm_cfg.py).
+
+Note that listnames are forced to lowercase.
+
+The list admin address need to be a fully-qualified address, like
+owner at example.com, not just owner.
+
+
.SH AUTHOR
Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
information. This manpage is written by Tollef Fog Heen
Modified: trunk/debian/manpages/remove_members.8
===================================================================
--- trunk/debian/manpages/remove_members.8 2006-08-11 07:54:05 UTC (rev 298)
+++ trunk/debian/manpages/remove_members.8 2006-08-11 07:57:47 UTC (rev 299)
@@ -1,4 +1,4 @@
-.TH REMOVE_MEMBERS 8 2001-03-10
+.TH REMOVE_MEMBERS 8 2006-08-09
.SH NAME
remove_members \- Remove members from a list.
@@ -14,7 +14,22 @@
\fB\-a\fB, \fB\-\-all\fB
Remove all members of the mailing list.
+(mutually exclusive with \-\-fromall)
+\fB\-\-fromall\fB
+Removes the given addresses from all the lists on this system
+regardless of virtual domains if you have any. This option cannot be
+used with \-a/\-\-all. Also, you should not specify a listname when
+using this option.
+
+\fB\-n\fB, \fB\-\-nouserack\fB
+Don't send the user acknowledgements. If not specified, the list
+default value is used.
+
+\fB\-N\fB, \fB\-\-noadminack\fB
+Don't send the admin acknowledgements. If not specified, the list
+default value is used.
+
\fB\-h\fB, \fB\-\-help\fB
Print a small help text and exit
.PP
Modified: trunk/debian/manpages/rmlist.8
===================================================================
--- trunk/debian/manpages/rmlist.8 2006-08-11 07:54:05 UTC (rev 298)
+++ trunk/debian/manpages/rmlist.8 2006-08-11 07:57:47 UTC (rev 299)
@@ -1,4 +1,4 @@
-.TH RMLIST 8 2001-03-10
+.TH RMLIST 8 2006-08-09
.SH NAME
rmlist \- Remove the components of a mailing list with impunity \- beware!
@@ -15,7 +15,8 @@
.PP
.TP
\fB\-a\fB, \fB\-\-archives\fB
-remove the lists archives too
+Remove the list's archives too, or if the list has already been
+deleted, remove any residual archives.
.TP
\fB\-h\fB, \fB\-\-help\fB
Modified: trunk/debian/manpages/sync_members.8
===================================================================
--- trunk/debian/manpages/sync_members.8 2006-08-11 07:54:05 UTC (rev 298)
+++ trunk/debian/manpages/sync_members.8 2006-08-11 07:57:47 UTC (rev 299)
@@ -1,4 +1,4 @@
-.TH SYNC_MEMBERS 8 2001-03-10
+.TH SYNC_MEMBERS 8 2006-08-09
.SH NAME
sync_members \- Synchronize a mailing list's membership with a flat file.
@@ -30,6 +30,13 @@
\fB\-w=no\fB, no message is sent.
.TP
+\fB\-g\fB=\fI{ yes | no }\fI, \fB\-\-goodbye\-msg\fB=\fI{ yes | no }\fI
+Sets whether or not to send the goodbye message to removed members,
+overriding whatever the list's `send_goodbye_msg' setting is. With
+\fB\-g=yes\fB or \fB\-g\fB, the goodbye message is sent. With
+\fB\-g=no\fB, no message is sent.
+
+.TP
\fB\-d\fB=\fI{ yes | no }\fI, \fB\-\-digest\fB=\fI{ yes | no }\fI
Selects whether to make newly added members receive messages in
digests. With \fB\-d=yes\fB or \fB\-d\fB, they become digest members.
More information about the Pkg-mailman-hackers
mailing list