dovecot-2.1-pigeonhole: sieve-refilter: improved man page docume...

[pigeonhole at rename-it.nl]

details:   http://hg.rename-it.nl/dovecot-2.1-pigeonhole/rev/b1bedb88e615
changeset: 1642:b1bedb88e615
user:      Stephan Bosch <stephan at rename-it.nl>
date:      Sun Sep 09 10:45:46 2012 +0200
description:
sieve-refilter: improved man page documentation by explicitly specifying the syntax used for mailbox arguments.

diffstat:

 doc/man/sieve-filter.1.in |  21 ++++++++++++++++-----
 1 files changed, 16 insertions(+), 5 deletions(-)

diffs (45 lines):

diff -r ff55c9946366 -r b1bedb88e615 doc/man/sieve-filter.1.in
--- a/doc/man/sieve-filter.1.in	Thu Aug 16 22:28:06 2012 +0200
+++ b/doc/man/sieve-filter.1.in	Sun Sep 09 10:45:46 2012 +0200
@@ -92,7 +92,8 @@
 is equal to the \fIsource\-mailbox\fP by default. Specifying a different folder
 will have the effect of moving (or copying if \fB\-W\fP is omitted) all kept
 messages to the indicated folder, instead of just leaving them in the
-\fIsource\-mailbox\fP.
+\fIsource\-mailbox\fP. Refer to the explanation of the \fIsource\-mailbox\fP
+argument for more information on mailbox naming.
 .TP
 .BI \-q\  output\-mailbox\  \fB[not\ implemented\ yet]\fP
 Store outgoing e\-mail into the indicated \fIoutput\-mailbox\fP. By default,
@@ -153,9 +154,18 @@
 into a new binary.
 .TP
 .I source\-mailbox
-The name of the source mailbox containing the messages that the Sieve filter
-will act upon. This mailbox is not modified unless the \fB\-W\fP option is
-specified.
+Specifies the source mailbox containing the messages that the Sieve filter will
+act upon.
+
+This is the name of a mailbox, as visible to IMAP clients, except in UTF-8
+format. The hierarchy separator between a parent and child mailbox is commonly
+.RB \(aq / \(aq
+or
+.RB \(aq . \(aq,
+but this depends on your selected mailbox storage format and
+namespace configuration. The mailbox names may also require a namespace prefix.
+
+This mailbox is not modified unless the \fB\-W\fP option is specified.
 .TP
 .I discard\-action
 Specifies what is done with messages in the \fIsource\-mailbox\fP that where not
@@ -169,7 +179,8 @@
 .TP
 .BI move\  mailbox
 Move discarded messages to the indicated \fImailbox\fP. This is for instance
-useful to move messages to a Trash mailbox.
+useful to move messages to a Trash mailbox. Refer to the explanation of
+the \fIsource\-mailbox\fP argument for more information on mailbox naming.
 .TP
 .B delete
 Flag discarded messages as \\DELETED.