[Pkg-mailman-hackers] Pkg-mailman commit - rev 506 - in trunk/debian: . manpages

Sat Jul 14 16:34:39 UTC 2007

Author: thijs
Date: 2007-07-14 16:34:38 +0000 (Sat, 14 Jul 2007)
New Revision: 506

Modified:
   trunk/debian/changelog
   trunk/debian/manpages/add_members.8
   trunk/debian/manpages/check_db.8
   trunk/debian/manpages/check_perms.8
   trunk/debian/manpages/clone_member.8
   trunk/debian/manpages/config_list.8
   trunk/debian/manpages/find_member.8
   trunk/debian/manpages/list_admins.8
   trunk/debian/manpages/list_lists.8
   trunk/debian/manpages/list_members.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
   trunk/debian/manpages/withlist.8
Log:
* Fix formatting of man pages (Closes: #432848).

Modified: trunk/debian/changelog
===================================================================

--- trunk/debian/changelog	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/changelog	2007-07-14 16:34:38 UTC (rev 506)
@@ -2,8 +2,9 @@
 
   * Drop suggests for obsolete python-*-codecs and drop versioned
     dependencies for pre-oldstable versions.
+  * Fix formatting of man pages (Closes: #432848).
 
- -- Thijs Kinkhorst <thijs at debian.org>  Mon,  9 Jul 2007 15:17:05 +0200
+ -- Thijs Kinkhorst <thijs at debian.org>  Sat, 14 Jul 2007 18:34:11 +0200
 
 mailman (1:2.1.9-8) unstable; urgency=low
 

Modified: trunk/debian/manpages/add_members.8
===================================================================
--- trunk/debian/manpages/add_members.8	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/manpages/add_members.8	2007-07-14 16:34:38 UTC (rev 506)
@@ -50,8 +50,8 @@
 
 .SH AUTHOR
 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
-information.  This manpage is written by Tollef Fog Heen
-<tfheen at debian.org> for Debian
+information. This manpage is written by Tollef Fog Heen
+<tfheen at debian.org> for Debian, but may be used by others.
 
 .SH SEE ALSO
 Mailman documentation on http://www.list.org/ and in

Modified: trunk/debian/manpages/check_db.8
===================================================================
--- trunk/debian/manpages/check_db.8	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/manpages/check_db.8	2007-07-14 16:34:38 UTC (rev 506)
@@ -32,7 +32,7 @@
 .SH AUTHOR
 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
 information.  This manpage is written by Tollef Fog Heen
-<tfheen at debian.org> for Debian
+<tfheen at debian.org> for Debian, but may be used by others.
 
 .SH SEE ALSO
 Mailman documentation on http://www.list.org/ and in

Modified: trunk/debian/manpages/check_perms.8
===================================================================
--- trunk/debian/manpages/check_perms.8	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/manpages/check_perms.8	2007-07-14 16:34:38 UTC (rev 506)
@@ -1,4 +1,4 @@
-.TH CHECK_PERMS 8 2001-03-10
+.TH CHECK_PERMS 8 2007-07-14
 .SH NAME
 check_perms \- Check permissions of Mailman's files
 
@@ -13,6 +13,9 @@
 .TP
 \fB\-v\fB
 Be verbose
+.TP
+\fB\-h\fB
+Print a help message and exit
 .PP
 
 .SH DESCRIPTION
@@ -23,7 +26,7 @@
 .SH AUTHOR
 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
 information.  This manpage is written by Tollef Fog Heen
-<tfheen at debian.org> for Debian
+<tfheen at debian.org> for Debian, but may be used by others.
 
 .SH SEE ALSO
 Mailman documentation on http://www.list.org/ and in

Modified: trunk/debian/manpages/clone_member.8
===================================================================
--- trunk/debian/manpages/clone_member.8	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/manpages/clone_member.8	2007-07-14 16:34:38 UTC (rev 506)
@@ -1,4 +1,4 @@
-.TH CLONE_MEMBER 8 2001-03-10
+.TH CLONE_MEMBER 8 2007-07-14
 .SH NAME
 clone_member \- Clone a Mailman subscriber address
 
@@ -16,10 +16,7 @@
 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
-    clone_member [options] fromoldaddr tonewaddr
 
 .PP
 .TP
@@ -54,7 +51,7 @@
 .SH AUTHOR
 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
 information.  This manpage is written by Tollef Fog Heen
-<tfheen at debian.org> for Debian
+<tfheen at debian.org> for Debian, but may be used by others.
 
 .SH SEE ALSO
 Mailman documentation on http://www.list.org/ and in

Modified: trunk/debian/manpages/config_list.8
===================================================================
--- trunk/debian/manpages/config_list.8	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/manpages/config_list.8	2007-07-14 16:34:38 UTC (rev 506)
@@ -57,8 +57,8 @@
 
 .SH AUTHOR
 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
-information.  This manpage is written by Tollef Fog Heen
-<tfheen at debian.org> for Debian
+information. This manpage is written by Tollef Fog Heen
+<tfheen at debian.org> for Debian, but may be used by others.
 
 .SH SEE ALSO
 Mailman documentation on http://www.list.org/ and in

Modified: trunk/debian/manpages/find_member.8
===================================================================
--- trunk/debian/manpages/find_member.8	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/manpages/find_member.8	2007-07-14 16:34:38 UTC (rev 506)
@@ -46,8 +46,8 @@
 
 .SH AUTHOR
 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
-information.  This manpage is written by Tollef Fog Heen
-<tfheen at debian.org> for Debian
+information. This manpage is written by Tollef Fog Heen
+<tfheen at debian.org> for Debian but may be used by others.
 
 .SH SEE ALSO
 Mailman documentation on http://www.list.org/ and in

Modified: trunk/debian/manpages/list_admins.8
===================================================================
--- trunk/debian/manpages/list_admins.8	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/manpages/list_admins.8	2007-07-14 16:34:38 UTC (rev 506)
@@ -22,8 +22,8 @@
 
 .SH AUTHOR
 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
-information.  This manpage is written for Debian by Bernd S. Brentrup
-<bsb at debian.org>.
+information. This manpage is written for Debian by Bernd S. Brentrup
+<bsb at debian.org>, but may be used by others.
 
 .SH SEE ALSO
 Mailman documentation on http://www.list.org/ and in

Modified: trunk/debian/manpages/list_lists.8
===================================================================
--- trunk/debian/manpages/list_lists.8	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/manpages/list_lists.8	2007-07-14 16:34:38 UTC (rev 506)
@@ -1,4 +1,4 @@
-.TH LIST_LISTS 8 2006-08-09
+.TH LIST_LISTS 8 2007-07-14
 .SH NAME
 list_lists \- List all Mailman mailing lists on this host
 
@@ -14,18 +14,20 @@
 .TP
 \fB\-V\fB \fIdomain\fI, \fB\-\-\fBvirtual-host-overview\fB=\fIdomain\fI
 List only those mailing lists that are homed to the given virtual
-domain.  This only works if the VIRTUAL_HOST_OVERVIEW variable is
+domain. This only works if the VIRTUAL_HOST_OVERVIEW variable is
 set.
+.TP
 \fB\-b\fB, \fB\-\-\fBbare\fB
 Displays only the list name, with no description.
+.TP
 \fB\-h\fB, \fB\-\-help\fB
 Print a small help text and exit
 .PP
 
 .SH AUTHOR
 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
-information.  This manpage is written by Tollef Fog Heen
-<tfheen at debian.org> for Debian
+information. This manpage is written by Tollef Fog Heen
+<tfheen at debian.org> for Debian, but may be used by others.
 
 .SH SEE ALSO
 Mailman documentation on http://www.list.org/ and in

Modified: trunk/debian/manpages/list_members.8
===================================================================
--- trunk/debian/manpages/list_members.8	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/manpages/list_members.8	2007-07-14 16:34:38 UTC (rev 506)
@@ -65,8 +65,8 @@
 
 .SH AUTHOR
 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
-information.  This manpage is written by Tollef Fog Heen
-<tfheen at debian.org> for Debian GNU/Linux.
+information. This manpage is written by Tollef Fog Heen
+<tfheen at debian.org> for Debian, but may be used by others.
 
 .SH SEE ALSO
 Mailman documentation on http://www.list.org/ and in

Modified: trunk/debian/manpages/mmarch.8
===================================================================
--- trunk/debian/manpages/mmarch.8	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/manpages/mmarch.8	2007-07-14 16:34:38 UTC (rev 506)
@@ -1,4 +1,4 @@
-.TH MMARCH 8 2006-08-09
+.TH MMARCH 8 2007-07-14
 .SH NAME
 mmarch \- Rebuild a Mailman list's archive.
 
@@ -11,25 +11,30 @@
 do this if you edit some messages in an archive, or remove some messages from
 an archive.
 
+.TP
 \fB\-h\fB, \fB\-\-\fBhelp\fB
 
 Print this error message and exit.
 
+.TP
 \fB\-q\fB, \fB\-\-\fBquiet\fB
 
 Make the archiver output less verbose.
 
+.TP
 \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.
 
+.TP
 \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.
 
+.TP
 \fB\-e\fB \fIM\fI, \fB\-\-\fBend=\fB\fIM\fI
 
 End indexing at article M.  This script is not very efficient with
@@ -37,7 +42,7 @@
 possible to index the mbox entirely.  For that reason, you can specify
 the start and end article numbers.
 
-
+.PP
 mbox is the path to a list's complete mbox archive.  Usually this will 
 be some path in the archives/private directory.  For example:
 
@@ -47,8 +52,8 @@
 
 .SH AUTHOR
 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
-information.  This manpage is written by Tollef Fog Heen
-<tfheen at debian.org> for Debian
+information. This manpage is written by Tollef Fog Heen
+<tfheen at debian.org> for Debian, but may be used by others.
 
 .SH SEE ALSO
 Mailman documentation on http://www.list.org/ and in

Modified: trunk/debian/manpages/mmsitepass.8
===================================================================
--- trunk/debian/manpages/mmsitepass.8	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/manpages/mmsitepass.8	2007-07-14 16:34:38 UTC (rev 506)
@@ -1,4 +1,4 @@
-.TH MMSITEPASS 8 2006-08-09
+.TH MMSITEPASS 8 2007-07-14
 .SH NAME
 mmsitepass \- Set the Mailman site password, prompting from the terminal.
 
@@ -8,12 +8,16 @@
 .SH OPTIONS
 
 .PP
+.TP
 \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.
 
+.TP
 \fB\-h\fB, \fB\-\-help\fB
+
 Print a small help text and exit
 .PP
 
@@ -29,8 +33,8 @@
 
 .SH AUTHOR
 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
-information.  This manpage is written by Tollef Fog Heen
-<tfheen at debian.org> for Debian
+information. This manpage is written by Tollef Fog Heen
+<tfheen at debian.org> for Debian but may be used by others.
 
 .SH SEE ALSO
 Mailman documentation on http://www.list.org/ and in

Modified: trunk/debian/manpages/newlist.8
===================================================================
--- trunk/debian/manpages/newlist.8	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/manpages/newlist.8	2007-07-14 16:34:38 UTC (rev 506)
@@ -1,4 +1,4 @@
-.TH NEWLIST 8 2006-08-09
+.TH NEWLIST 8 2007-07-14
 .SH NAME
 newlist \- Create a new, unpopulated mailing list.
 
@@ -46,30 +46,30 @@
 You also specify the domain to create your new list in by typing the command
 like so:
 
-    newlist \-\-urlhost=www.mydom.ain mylist
+    newlist \-\-urlhost=www.example.com 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.
+where `www.example.com' 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.example.com/mailman/listinfo.  Also,
+www.example.com 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
+    newlist \-\-urlhost=www.example.com \-\-emailhost=example.com 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.
+where `example.com' 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
+    mylist at www.example.com
 
-where www.mydom.ain is used for `urlhost' but it will also be used for
+where www.example.com is used for `urlhost' but it will also be used for
 `emailhost' if it is not found in the virtual host table. Note
 `\-\-urlhost' and `\-\-emailhost' have precedence to this notation.
 
@@ -85,8 +85,8 @@
 
 .SH AUTHOR
 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
-information.  This manpage is written by Tollef Fog Heen
-<tfheen at debian.org> for Debian GNU/Linux.
+information. This manpage is written by Tollef Fog Heen
+<tfheen at debian.org> for Debian, but may be used by others.
 
 .SH SEE ALSO
 Mailman documentation on http://www.list.org/ and in

Modified: trunk/debian/manpages/remove_members.8
===================================================================
--- trunk/debian/manpages/remove_members.8	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/manpages/remove_members.8	2007-07-14 16:34:38 UTC (rev 506)
@@ -1,4 +1,4 @@
-.TH REMOVE_MEMBERS 8 2006-08-09
+.TH REMOVE_MEMBERS 8 2007-07-14
 .SH NAME
 remove_members \- Remove members from a list.
 
@@ -8,30 +8,44 @@
 .SH OPTIONS
 
 .PP
+
+.TP
 \fB\-f\fB \fIfile\fI, \fB\-\-file\fB=\fIfile\fI
+
 Remove member addresses found in the given file.  If file is
 `-', read stdin.
 
+.TP
 \fB\-a\fB, \fB\-\-all\fB
+
 Remove all members of the mailing list.
 (mutually exclusive with \-\-fromall)
 
+.TP
 \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
+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.
 
+.TP
 \fB\-n\fB, \fB\-\-nouserack\fB
-Don't send the user acknowledgements.  If not specified, the list
+
+Don't send the user acknowledgements. If not specified, the list
 default value is used.
 
+.TP
 \fB\-N\fB, \fB\-\-noadminack\fB
-Don't send the admin acknowledgements.  If not specified, the list
+
+Don't send the admin acknowledgements. If not specified, the list
 default value is used.
 
+.TP
 \fB\-h\fB, \fB\-\-help\fB
+
 Print a small help text and exit
+
 .PP
 
 listname is the name of the mailing list to use.
@@ -40,8 +54,8 @@
 
 .SH AUTHOR
 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
-information.  This manpage is written by Tollef Fog Heen
-<tfheen at debian.org> for Debian
+information. This manpage is written by Tollef Fog Heen
+<tfheen at debian.org> for Debian, but may be used by others.
 
 .SH SEE ALSO
 Mailman documentation on http://www.list.org/ and in

Modified: trunk/debian/manpages/rmlist.8
===================================================================
--- trunk/debian/manpages/rmlist.8	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/manpages/rmlist.8	2007-07-14 16:34:38 UTC (rev 506)
@@ -27,8 +27,8 @@
 
 .SH AUTHOR
 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
-information.  This manpage is written by Tollef Fog Heen
-<tfheen at debian.org> for Debian
+information. This manpage is written by Tollef Fog Heen
+<tfheen at debian.org> for Debian, but may be used by others.
 
 .SH SEE ALSO
 Mailman documentation on http://www.list.org/ and in

Modified: trunk/debian/manpages/sync_members.8
===================================================================
--- trunk/debian/manpages/sync_members.8	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/manpages/sync_members.8	2007-07-14 16:34:38 UTC (rev 506)
@@ -1,4 +1,4 @@
-.TH SYNC_MEMBERS 8 2006-08-09
+.TH SYNC_MEMBERS 8 2007-07-14
 .SH NAME
 sync_members \- Synchronize a mailing list's membership with a flat file.
 
@@ -26,30 +26,30 @@
 \fB\-w\fB=\fI{ yes | no }\fI, \fB\-\-welcome\-msg\fB=\fI{ yes | no }\fI
 Sets whether or not to send the newly added members a welcome message,
 overriding whatever the list's `send_welcome_msg' setting is.  With
-\fB\-w=yes\fB or \fB\-w\fB, the welcome message is sent.  With
-\fB\-w=no\fB, no message is sent.
+\-w=yes or \-w, the welcome message is sent.  With
+\-w=no, 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.
+\-g=yes or \-g, the goodbye message is sent.  With
+\-g=no, 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.
-With \fB\-d=no\fB (or if no \-d option given) they are added as
+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.
 
 .TP
 \fB\-a\fB=\fI{ yes | no }\fI, \fB\-\-notifyadmin\fB=\fI{ yes | no }\fI
 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 \fB\-a=yes\fB or \fB\-a\fB,
-the admin is notified.  With \fB\-a=no\fB, the admin is not notified.
-With no \fB\-a\fB option, the default for the list is used.
+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.
 
 .TP
 \fB\-f\fB=\fIfilename\fI, \fB\-\-file\fB=\fIfilename\fI
@@ -59,15 +59,15 @@
 
 .TP
 \fB\-h\fB, \fB\-\-help\fB
-Print a small help text and exit
+Print a small help text and exit.
 .PP
 
 listname specifies the list to synchronize.
 
 .SH AUTHOR
 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
-information.  This manpage is written by Tollef Fog Heen
-<tfheen at debian.org> for Debian
+information. This manpage is written by Tollef Fog Heen
+<tfheen at debian.org> for Debian, but may be used by others.
 
 .SH SEE ALSO
 Mailman documentation on http://www.list.org/ and in

Modified: trunk/debian/manpages/withlist.8
===================================================================
--- trunk/debian/manpages/withlist.8	2007-07-09 13:18:11 UTC (rev 505)
+++ trunk/debian/manpages/withlist.8	2007-07-14 16:34:38 UTC (rev 506)
@@ -1,4 +1,4 @@
-.TH withlist 8 2004-03-24
+.TH withlist 8 2007-07-14
 .SH NAME
 withlist \- General framework for interacting with a mailing list object.
 
@@ -56,7 +56,7 @@
 Suppress all status messages.
 .TP
 \fB\-h\fB, \fB\-\-help\fB
-Print a small help text and exit
+Print a small help text and exit.
 .PP
 
 .SH EXAMPLES
@@ -77,7 +77,7 @@
   Loading list: mylist (unlocked)
   Importing listaddr ...
   Running listaddr.listaddr() ...
-  mylist at myhost.com
+  mylist at example.com
 
 And you can print the list's request address by running:
 
@@ -85,7 +85,7 @@
   Loading list: mylist (unlocked)
   Importing listaddr ...
   Running listaddr.requestaddr() ...
-  mylist-request at myhost.com
+  mylist-request at example.com
 
 As another example, say you wanted to change the password for a particular
 user on a particular list.  You could put the following function in a file
@@ -101,13 +101,13 @@
           print 'No address matched:', addr
 
  and run this from the command line:
- % bin/withlist \-l \-r changepw mylist somebody at somewhere.org foobar
+ % bin/withlist \-l \-r changepw mylist somebody at example.org foobar
 .PP
 
 .SH AUTHOR
 Author of Mailman is the Mailman Cabal, see http://www.list.org/ for
-information.  This manpage is written for Debian by Bernd S. Brentrup
-<bsb at debian.org>.
+information. This manpage is written for Debian by Bernd S. Brentrup
+<bsb at debian.org>, but may be used by others.
 
 .SH SEE ALSO
 Mailman documentation on http://www.list.org/ and in


