diff share/man/man1/roundup-mailgw.1 @ 4706:a5a9b81f8f6b

issue2550760: Several improvements to the manpages (thanks Kai Storbeck) - include downstream Debian man page patches
author John Kristensen <john@jerrykan.com>
date Tue, 18 Dec 2012 15:16:14 +1100
parents ab542607f2fb
children 76e270b35e63
line wrap: on
line diff
--- a/share/man/man1/roundup-mailgw.1	Mon Dec 17 19:15:21 2012 +0530
+++ b/share/man/man1/roundup-mailgw.1	Tue Dec 18 15:16:14 2012 +1100
@@ -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 @@
 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
 <calvin@debian.org> for the Debian distribution of roundup.

Roundup Issue Tracker: http://roundup-tracker.org/