issue2550760: Several improvements to the manpages (thanks Kai Storbeck)

 - include downstream Debian man page patches

Author: jerrykan

CHANGES.txt

@@ -76,6 +76,8 @@ Fixed:
   their own documentation in html, thanks Kai Storbeck (John Kristensen)
 - issue2550774: Update website/www/Makefile to symlink COPYING.txt so "make"
   works again, thanks Kai Storbeck (John Kristensen)
+- issue2550760: Several improvements to the manpages
+  thanks Kai Storbeck & Bastian Kleineidam (John Kristensen)
 
 2012-05-15: 1.4.20
 

share/man/man1/roundup-admin.1

@@ -8,11 +8,19 @@ roundup-admin \- administrate roundup trackers
 \fB-i\fP \fIinstance home\fP
 specify the issue tracker "home directory" to administer
 .TP
-\fB-u\fP
-the user[:password] to use for commands
+\fB-u\fP \fIuser\fP[\fB:\fP\fIpassword\fP]
+the user and password to use for commands
 .TP
 \fB-c\fP
-when outputting lists of data, just comma-separate them
+When outputting lists of data, comma-separate them. Same as
+\fB-S ","\fP.
+.TP
+\fB-S\fP \fIstring\fP
+When outputting lists of data, separate items with given string.
+.TP
+\fB-s\fP
+When outputting lists of data, space-separate them. Same as
+\fB-S " "\fP.
 .SH FURTHER HELP
  roundup-admin -h
  roundup-admin help                       -- this help

share/man/man1/roundup-mailgw.1

@@ -2,14 +2,17 @@
 .SH NAME
 roundup-mailgw \- mail gateway for roundup
 .SH SYNOPSIS
-\fBroundup-mailgw\fP \fI<instance home>\fP [\fImethod\fP]
+\fBroundup-mailgw\fP \fIinstance_home\fP [\fImethod\fP]
 .SH OPTIONS
 .TP
+\fB-v\fP
+Print version and exit.
+.TP
 \fB-C\fP \fIhyperdb class\fP
 specify a tracker class - one of msg (the default), issue, file, user - to
 manipulate with -S options
 .TP
-\fB-S\fP \fIproperty=value[;property=value] pairs\fP
+\fB-S\fP \fIproperty\fP\fB=\fP\fIvalue\fP[\fB;\fP\fIproperty\fP\fB=\fP\fIvalue\fP] \fIpairs\fP
 specify the values to set on the class specified by -C using the same
 format as the Subject line property manipulations
 .SH DESCRIPTION
@@ -46,17 +49,35 @@ the command-line or in ~/.netrc.
 In the third case, the gateway reads all messages from the POP server
 specified and submits each in turn to the roundup.mailgw module. The
 server is specified as:
- \fIpop username:password@server\fP
+ \fBpop\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP
 .br
 The username and password may be omitted:
- \fIpop username@server\fP
- \fIpop server\fP
+ \fBpop\fP \fIusername\fP\fB@\fP\fIserver\fP
+ \fBpop\fP \fIserver\fP
 .br
-are both valid.
+are both valid. The username and/or password will be prompted for if
+not supplied on the command-line.
 
 \fBAPOP\fP
+.br
 Same as POP, but using Authenticated POP:
- \fIapop username:password@server\fP
+ \fBapop\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP
+
+\fBIMAP\fP
+.br
+Connect to an IMAP server. This supports the same notation as that of
+POP mail.
+ \fBimap\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP
+.br
+It also allows you to specify a specific mailbox other than INBOX using
+this format:
+ \fBimap\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver mailbox\fP
+
+\fBIMAPS\fP
+.br
+Connect to an IMAP server over ssl.
+This supports the same notation as IMAP.
+ \fBimaps\fP \fIusername\fP\fB:\fP\fIpassword\fP\fB@\fP\fIserver\fP [\fImailbox\fP]
 .SH AUTHOR
 This manpage was written by Bastian Kleineidam
 <[email protected]> for the Debian distribution of roundup.

share/man/man1/roundup-server.1

@@ -9,10 +9,10 @@ roundup-server \- start roundup web server
 Use options read from the configuration file (see below).
 .TP
 \fB-n\fP \fIhostname\fP
-Sets the host name.
+Sets the host name or IP address to listen on
 .TP
 \fB-p\fP \fIport\fP
-Sets the port to listen on.
+Sets the port to listen on (default: 8080).
 .TP
 \fB-d\fP \fIfile\fP
 Daemonize, and write the server's PID to the nominated file.
@@ -33,8 +33,25 @@ Enables to use of SSL.
 Sets a filename containing the PEM file to use for SSL. If left blank, a
 temporary self-signed certificate will be used.
 .TP
+\fB-N\fP
+Log client machine names instead of IP addresses (much slower).
+.TP
+\fB-u\fP \fIUID\fP
+Runs the Roundup web server as this UID.
+.TP
+\fB-g\fP \fIGID\fP
+Runs the Roundup web server as this GID.
+.TP
+\fB-d\fP \fIPIDfile\fP
+Run the server in the background and write the server's PID
+to the file indicated by PIDfile. The -l option \fBmust\fP be
+specified if -d is used.
+.TP
+\fB-v\fP
+Print version and exit.
+.TP
 \fB-h\fP
-print help
+Print help and exit.
 .TP
 \fBname=\fP\fItracker home\fP
 Sets the tracker home(s) to use. The \fBname\fP variable is how the tracker is