From 68a275beb1961c7f24842532935cd06f2165d526 Mon Sep 17 00:00:00 2001 From: Stephan Bosch <stephan@rename-it.nl> Date: Sun, 11 Jul 2010 12:40:00 +0200 Subject: [PATCH] Updated documentation: Sieve tools are now using Dovecot configuration by default. --- 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(-) diff --git a/TODO b/TODO index c65707ceb..e727b0ecb 100644 --- a/TODO +++ b/TODO @@ -7,7 +7,7 @@ Current activities: 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 --git a/doc/man/sieve-filter.1 b/doc/man/sieve-filter.1 index 8ca703185..a69710a32 100644 --- a/doc/man/sieve-filter.1 +++ b/doc/man/sieve-filter.1 @@ -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 @@ sieve\-filter \- Sieve mailbox filter tool for the Dovecot secure IMAP server 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 @@ e\-mails. However, it can still litter other mailboxes with spurious copies of y 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 --git a/doc/man/sieve-test.1 b/doc/man/sieve-test.1 index 03d270e6f..222abaa60 100644 --- a/doc/man/sieve-test.1 +++ b/doc/man/sieve-test.1 @@ -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 @@ with basename and path identical to the specified script. Use the \fB\-C\fP opti 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 --git a/doc/man/sievec.1 b/doc/man/sievec.1 index 34492720c..c89be696a 100644 --- a/doc/man/sievec.1 +++ b/doc/man/sievec.1 @@ -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 @@ code to the specified file. The output is then identical to what the \fBsieved\f 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 --git a/doc/man/sieved.1 b/doc/man/sieved.1 index 48d8a22fe..8bc6143f3 100644 --- a/doc/man/sieved.1 +++ b/doc/man/sieved.1 @@ -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 @@ new operations and use additional blocks. Therefore, the output of \fBsieved\fP 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 -- GitLab