dovecot-2.0-pigeonhole: Updated documentation: Sieve tools are n...

[pigeonhole at rename-it.nl]

details:   http://hg.rename-it.nl/dovecot-2.0-pigeonhole/rev/cdd4c08c2f85
changeset: 1326:cdd4c08c2f85
user:      Stephan Bosch <stephan at rename-it.nl>
date:      Sun Jul 11 12:40:00 2010 +0200
description:
Updated documentation: Sieve tools are now using Dovecot configuration by default.

diffstat:

 TODO                   |  2 +-
 doc/man/sieve-filter.1 |  7 +++++--
 doc/man/sieve-test.1   |  6 +++++-
 doc/man/sievec.1       |  7 +++++--
 doc/man/sieved.1       |  7 +++++--
 5 files changed, 21 insertions(+), 8 deletions(-)

diffs (112 lines):

diff -r 1e66eb33873f -r cdd4c08c2f85 TODO
--- a/TODO	Sat Jul 10 18:53:40 2010 +0200
+++ b/TODO	Sun Jul 11 12:40:00 2010 +0200
@@ -7,7 +7,7 @@
 
 Next (in order of descending priority/precedence):
 
-* Make command line tools use Dovecot settings API
+* Update man pages to match style of Dovecot man pages.
 * Cleanup the test suite
 	- Make uniform command implementations
 	- Cleanup test scripts
diff -r 1e66eb33873f -r cdd4c08c2f85 doc/man/sieve-filter.1
--- a/doc/man/sieve-filter.1	Sat Jul 10 18:53:40 2010 +0200
+++ b/doc/man/sieve-filter.1	Sun Jul 11 12:40:00 2010 +0200
@@ -1,4 +1,4 @@
-.TH "SIEVE\-FILTER" "1" "5 August 2009"
+.TH "SIEVE\-FILTER" "1" "11 July 2010"
 .SH NAME
 sieve\-filter \- Sieve mailbox filter tool for the Dovecot secure IMAP server
 .PP
@@ -6,7 +6,7 @@
 features! The behavior described in this manual page represents the design and not necessarily what the tool currently implements.
 
 .SH SYNOPSIS
-sieve\-filter [\fIoptions\fR] \fIscript\-file\fR \fIsource\-location\fR \fIsource\-mailbox\fR [\fIinbox\-namespace\fR [\fInamespace\fR ...]]
+sieve\-filter [\fB\-c\fR \fIconfig-file\fR] [\fIoptions\fR] \fIscript\-file\fR \fIsource\-location\fR \fIsource\-mailbox\fR [\fIinbox\-namespace\fR [\fInamespace\fR ...]]
 .TP
 \fInamepace\fR = [prefix=]location[;option=value,option=value,...]
 .TP
@@ -65,6 +65,9 @@
 Sieve script decides to do so.
 
 .SH OPTIONS
+.TP
+\fB\-c\fP \fIconfig-file\fP
+Alternative Dovecot configuration file path.
 .TP 
 \fB\-D\fP \fIsource\-action\fP
 By default, the sieve\-filter command does not delete the messages from the source mailbox. This means that
diff -r 1e66eb33873f -r cdd4c08c2f85 doc/man/sieve-test.1
--- a/doc/man/sieve-test.1	Sat Jul 10 18:53:40 2010 +0200
+++ b/doc/man/sieve-test.1	Sun Jul 11 12:40:00 2010 +0200
@@ -1,8 +1,9 @@
-.TH "SIEVE\-TEST" "1" "4 July 2009"
+.TH "SIEVE\-TEST" "1" "11 July 2010"
 .SH NAME
 sieve\-test \- Sieve script tester for the Dovecot secure IMAP server
 .SH SYNOPSIS
 sieve\-test
+[\fB\-c\fR \fIconfig-file\fR]
 [\fB\-C\fR]
 [\fB\-D\fR]
 [\fB\-d\fR \fIdump\-file\fR]
@@ -44,6 +45,9 @@
 behavior by forcing the script to be compiled into a new binary.  
 .SH OPTIONS
 .TP 
+\fB\-c\fP \fIconfig-file\fP
+Alternative Dovecot configuration file path.
+.TP
 \fB\-C\fP
 Force compilation. By default, the compiled binary is stored on disk. When this binary is found
 during the next execution of \fBsieve\-test\fP and its modification time is more recent than the
diff -r 1e66eb33873f -r cdd4c08c2f85 doc/man/sievec.1
--- a/doc/man/sievec.1	Sat Jul 10 18:53:40 2010 +0200
+++ b/doc/man/sievec.1	Sun Jul 11 12:40:00 2010 +0200
@@ -1,8 +1,8 @@
-.TH "SIEVEC" "1" "4 July 2009"
+.TH "SIEVEC" "1" "11 July 2010"
 .SH NAME
 sievec \- Sieve script compiler for the Dovecot secure IMAP server
 .SH SYNOPSIS
-sievec [\fB\-d\fR] [\fB\-x\fR "\fIextension extension ...\fR"] \fIscript\-file\fR [\fIout\-file\fR]
+sievec [\fB\-c\fR \fIconfig-file\fR] [\fB\-d\fR] [\fB\-x\fR "\fIextension extension ...\fR"] \fIscript\-file\fR [\fIout\-file\fR]
 .SH DESCRIPTION
 .PP
 The \fBsievec\fP command is part of the Pigeonhole Sieve implementation for the Dovecot secure 
@@ -42,6 +42,9 @@
 for a stored binary file. This output is mainly useful to find bugs in the compiler that yield corrupt 
 binaries.
 .SH OPTIONS
+.TP
+\fB\-c\fP \fIconfig-file\fP
+Alternative Dovecot configuration file path.
 .TP 
 \fB\-d\fP 
 Don't write the binary to \fIout\-file\fP, but write a textual dump of the binary in 
diff -r 1e66eb33873f -r cdd4c08c2f85 doc/man/sieved.1
--- a/doc/man/sieved.1	Sat Jul 10 18:53:40 2010 +0200
+++ b/doc/man/sieved.1	Sun Jul 11 12:40:00 2010 +0200
@@ -1,8 +1,8 @@
-.TH "SIEVED" "1" "4 July 2009"
+.TH "SIEVED" "1" "11 July 2010"
 .SH NAME
 sieved \- Sieve script binary dump tool for the Dovecot secure IMAP server
 .SH SYNOPSIS
-sieved [\fB\-x\fR "\fIextension extension ...\fR"] \fIsieve\-binary\fR [\fIout\-file\fR]
+sieved [\fB\-c\fR \fIconfig-file\fR] [\fB\-x\fR "\fIextension extension ...\fR"] \fIsieve\-binary\fR [\fIout\-file\fR]
 .br
 .SH DESCRIPTION
 .PP
@@ -34,6 +34,9 @@
 on the language extensions used when compiling the binary. 
 .SH OPTIONS
 .TP
+\fB\-c\fP \fIconfig-file\fP
+Alternative Dovecot configuration file path.
+.TP
 \fB\-x\fP "\fIextension extension ...\fP"
 Set the available extensions. The parameter is a space\-separated list of the active extensions. By
 prepending the extension identifiers with \fB+\fP or \fB\-\fP, extensions can be included or excluded