From 3c4d93f264a68365ad74d5ba0c17113da59ac8b4 Mon Sep 17 00:00:00 2001 From: Stephan Bosch <stephan@rename-it.nl> Date: Sat, 17 Dec 2011 00:08:01 +0100 Subject: [PATCH] Updated man pages. --- doc/man/pigeonhole.7.in | 6 +++++- doc/man/sieve-dump.1.in | 3 ++- doc/man/sieve-filter.1.in | 27 +++++++++++++++------------ doc/man/sieve-test.1.in | 3 ++- doc/man/sievec.1.in | 3 ++- 5 files changed, 26 insertions(+), 16 deletions(-) diff --git a/doc/man/pigeonhole.7.in b/doc/man/pigeonhole.7.in index 9ad107944..719c81dda 100644 --- a/doc/man/pigeonhole.7.in +++ b/doc/man/pigeonhole.7.in @@ -1,5 +1,5 @@ .\" Copyright (c) 2010-2011 Pigeonhole authors, see the included COPYING file -.TH "PIGEONHOLE" 7 "2011-11-19" "Pigeonhole for Dovecot v2.1" "Pigeonhole" +.TH "PIGEONHOLE" 7 "2011-12-17" "Pigeonhole for Dovecot v2.1" "Pigeonhole" .\"------------------------------------------------------------------------ .SH NAME pigeonhole \- Overview of the Pigeonhole project\(aqs Sieve support for the @@ -60,6 +60,9 @@ Compiles Sieve scripts into a binary representation for later execution. The universal Sieve test tool for testing the effect of a Sieve script on a particular message. .TP +.BR sieve\-filter (1) +Filters all messages in a particular source mailbox through a Sieve script. +.TP .BR sieve\-dump (1) Dumps the content of a Sieve binary file for (development) debugging purposes. .\"------------------------------------------------------------------------ @@ -77,6 +80,7 @@ LGPLv2.1 license, which is the same license as Dovecot, see .BR dovecot\-lda (1), .BR sieve\-dump (1), .BR sieve\-test (1), +.BR sieve\-filter (1), .BR sievec (1) .\"------------------------------------- .PP diff --git a/doc/man/sieve-dump.1.in b/doc/man/sieve-dump.1.in index a165c885e..1b22741cd 100644 --- a/doc/man/sieve-dump.1.in +++ b/doc/man/sieve-dump.1.in @@ -1,5 +1,5 @@ .\" Copyright (c) 2010-2011 Pigeonhole authors, see the included COPYING file -.TH "SIEVE\-DUMP" 1 "2011-12-12" "Pigeonhole for Dovecot v2.1" "Pigeonhole" +.TH "SIEVE\-DUMP" 1 "2011-12-17" "Pigeonhole for Dovecot v2.1" "Pigeonhole" .\"------------------------------------------------------------------------ .SH NAME sieve\-dump \- Pigeonhole\(aqs Sieve script binary dump tool @@ -97,6 +97,7 @@ Sieve interpreter settings (included from Dovecot\(aqs main configuration file) .SH "SEE ALSO" .BR dovecot (1), .BR dovecot\-lda (1), +.BR sieve\-filter (1), .BR sieve\-test (1), .BR sievec (1), .BR pigeonhole (7) diff --git a/doc/man/sieve-filter.1.in b/doc/man/sieve-filter.1.in index e05cd2af0..b282bb153 100644 --- a/doc/man/sieve-filter.1.in +++ b/doc/man/sieve-filter.1.in @@ -1,5 +1,5 @@ .\" Copyright (c) 2010-2011 Pigeonhole authors, see the included COPYING file -.TH "SIEVE\-FILTER" 1 "2011-12-12" "Pigeonhole for Dovecot v2.1" "Pigeonhole" +.TH "SIEVE\-FILTER" 1 "2011-12-17" "Pigeonhole for Dovecot v2.1" "Pigeonhole" .SH NAME sieve\-filter \- Pigeonhole\(aqs Sieve mailbox filter tool @@ -27,10 +27,10 @@ already stored in a mailbox, for instance when a bug in a Sieve script caused many messages to be delivered incorrectly. Using the sieve\-filter tool it is possible to apply a Sieve script on all messages in a particular \fIsource\-mailbox\fP, making it possible to delete messages, to store them in a -different mailbox and to change the assigned IMAP flags and keywords. Attempts -to send messages to the outside world are ignored by default for obvious -reasons, but, using the proper command line options, it is possible to capture -and handle outgoing mail as well. +different mailbox, to change their content, and to change the assigned IMAP +flags and keywords. Attempts to send messages to the outside world are ignored +by default for obvious reasons, but, using the proper command line options, it +is possible to capture and handle outgoing mail as well. .PP If no options are specified, the sieve\-filter command runs in a simulation mode in which it only prints what would be performed, without actually doing @@ -44,8 +44,12 @@ are only potentially modified or moved to a different folder. Messages are never lost unless a \fIdiscard\-action\fP argument other than \fBkeep\fP (the default) is specified. If the Sieve filter decides to store the message in the \fIsource\-mailbox\fP, where it obviously already exists, it is never duplicated -there. However, in that case, the IMAP flags of the original message can be -modified by the Sieve interpreter, provided that \fB\-W\fP is specified. +there. In that case, the IMAP flags of the original message can be modified by +the Sieve interpreter using the \fIimap4flags\fP extension, provided that +\fB\-W\fP is specified. If the message itself is modified by the Sieve +interpreter (e.g. using the \fIeditheader\fP extension), a new message is stored +and the old one is expunged. However, if \fB-W\fP is omitted, the original +message is left untouched and the modifications are discarded. .SS CAUTION Although this is a very useful tool, it can also be very destructive when used @@ -108,19 +112,18 @@ what you are doing, \fBDO NOT USE THIS TO FEED MAIL TO SENDMAIL!\fP. .BI \-s\ script\-file\ \fB[not\ implemented\ yet]\fP Specify additional scripts to be executed before the main script. Multiple \fB\-s\fP arguments are allowed and the specified scripts are executed -sequentially in the order specified at the command -line. +sequentially in the order specified at the command line. .TP .BI \-u\ user Run the Sieve script for the given \fIuser\fP. .TP -.B \-v\ +.B \-v Produce verbose output during filtering. .TP .B \-W Enables write access to the \fIsource\-mailbox\fP. This allows (re)moving the -messages from the \fIsource\-mailbox\fP and changing the assigned IMAP flags and -keywords. +messages from the \fIsource\-mailbox\fP, changing their contents, and changing +the assigned IMAP flags and keywords. .TP .BI \-x\ extensions Set the available extensions. The parameter is a space\-separated list of the diff --git a/doc/man/sieve-test.1.in b/doc/man/sieve-test.1.in index 2220c8332..a71baf684 100644 --- a/doc/man/sieve-test.1.in +++ b/doc/man/sieve-test.1.in @@ -1,5 +1,5 @@ .\" Copyright (c) 2010-2011 Pigeonhole authors, see the included COPYING file -.TH "SIEVE\-TEST" 1 "2011-12-12" "Pigeonhole for Dovecot v2.1" "Pigeonhole" +.TH "SIEVE\-TEST" 1 "2011-12-17" "Pigeonhole for Dovecot v2.1" "Pigeonhole" .SH NAME sieve\-test \- Pigeonhole\(aqs Sieve script tester .\"------------------------------------------------------------------------ @@ -236,5 +236,6 @@ Sieve interpreter settings (included from Dovecot\(aqs main configuration file) .BR dovecot (1), .BR dovecot\-lda (1), .BR sieve\-dump (1), +.BR sieve\-filter (1), .BR sievec (1), .BR pigeonhole (7) diff --git a/doc/man/sievec.1.in b/doc/man/sievec.1.in index 209789f67..287f28bcb 100644 --- a/doc/man/sievec.1.in +++ b/doc/man/sievec.1.in @@ -1,5 +1,5 @@ .\" Copyright (c) 2010-2011 Pigeonhole authors, see the included COPYING file -.TH "SIEVEC" 1 "2011-12-12" "Pigeonhole for Dovecot v2.1" "Pigeonhole" +.TH "SIEVEC" 1 "2011-12-17" "Pigeonhole for Dovecot v2.1" "Pigeonhole" .\"------------------------------------------------------------------------ .SH NAME sievec \- Pigeonhole\(aqs Sieve script compiler @@ -118,5 +118,6 @@ Sieve interpreter settings (included from Dovecot\(aqs main configuration file) .BR dovecot (1), .BR dovecot\-lda (1), .BR sieve\-dump (1), +.BR sieve\-filter (1), .BR sieve\-test (1), .BR pigeonhole (7) -- GitLab