From a594d8f1fcf7763dad230eae894e16d1c0d2fcdd Mon Sep 17 00:00:00 2001
From: Stephan Bosch <stephan@rename-it.nl>
Date: Sat, 1 Aug 2009 13:33:35 +0200
Subject: [PATCH] Updated man pages.
---
doc/man/sieve-test.1 | 13 ++++++++++---
doc/man/sievec.1 | 11 +++++++++--
doc/man/sieved.1 | 11 +++++++++--
3 files changed, 28 insertions(+), 7 deletions(-)
diff --git a/doc/man/sieve-test.1 b/doc/man/sieve-test.1
index 0db6710ee..6e17c69b0 100644
--- a/doc/man/sieve-test.1
+++ b/doc/man/sieve-test.1
@@ -88,8 +88,15 @@ Enable simple trace debugging; prints all encountered byte code instructions to
currently only intelligible for developers.
.TP
\fB-x\fP "\fIextension extension ...\fP"
-Set the available extensions. The option's parameter is a space-separated list of the active
-extensions. Unknown extensions are ignored, but a warning is produced.
+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
+relative to the default set of extensions. If no extensions have a \fB+\fP or \fB-\fP prefix, only
+those extensions that are explicitly listed will be enabled. Unknown extensions are ignored and a
+warning is produced. By default, all supported extensions are available, except for deprecated extensions
+or those that are still under development.
+
+For example \fB-x\fP "+imapflags -enotify" will enable the deprecated imapflags extension along with all
+extensions that are available by default, except for the enotify extension.
.SH DEBUG SUPPORT
.PP
To improve script debugging, the Sieve command line tools such as \fBsieve-test\fP support a custom
@@ -107,7 +114,7 @@ if header :contains "subject" "hello" {
}
.PP
Other tools like \fBsievec\fP and \fBsieved\fP also recognize the vnd.dovecot.debug extension. In contrast,
-the actual Sieve plugin for Deliver does not allow the use of the debug extension. So, keep in mind that
+the actual Sieve plugin for the Dovecot LDA does not allow the use of the debug extension. So, keep in mind that
scripts and compiled binaries that refer to de debug extension will fail to be run by the Sieve plugin itself.
.PP
Note that it is not necessary to enable nor possible to disable the availability of the debug extension with
diff --git a/doc/man/sievec.1 b/doc/man/sievec.1
index 84781a118..d6c103955 100644
--- a/doc/man/sievec.1
+++ b/doc/man/sievec.1
@@ -52,8 +52,15 @@ a compiled Sieve binary file. Note that this option is not allowed when the \fIo
is a directory.
.TP
\fB-x\fP "\fIextension extension ...\fP"
-Set the available extensions. The \fIextensions\fP parameter is a space-separated list of the
-active extensions. Unknown extensions are ignored, but a warning is produced.
+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
+relative to the default set of extensions. If no extensions have a \fB+\fP or \fB-\fP prefix, only
+those extensions that are explicitly listed will be enabled. Unknown extensions are ignored
+and a warning is produced. By default, all supported extensions are available, except for deprecated
+extensions or those that are still under development.
+
+For example \fB-x\fP "+imapflags -enotify" will enable the deprecated imapflags extension along with all
+extensions that are available by default, except for the enotify extension.
.SH AUTHOR
.PP
The Sieve implementation for Dovecot was written by Stephan Bosch <stephan@rename-it.nl>.
diff --git a/doc/man/sieved.1 b/doc/man/sieved.1
index 3758f7b0d..27ef268ab 100644
--- a/doc/man/sieved.1
+++ b/doc/man/sieved.1
@@ -35,8 +35,15 @@ on the language extensions used when compiling the binary.
.SH OPTIONS
.TP
\fB-x\fP "\fIextension extension ...\fP"
-Set the available extensions. The option's parameter is a space-separated list of the active
-extensions. Unknown extensions are ignored, but a warning is produced.
+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
+relative to the default set of extensions. If no extensions have a \fB+\fP or \fB-\fP prefix, only
+those extensions that are explicitly listed will be enabled. Unknown extensions are ignored and a
+warning is produced. By default, all supported extensions are available, except for deprecated
+extensions or those that are still under development.
+
+For example \fB-x\fP "+imapflags -enotify" will enable the deprecated imapflags extension along with all
+extensions that are available by default, except for the enotify extension.
.SH AUTHOR
.PP
The Sieve implementation for Dovecot was written by Stephan Bosch <stephan@rename-it.nl>.
--
GitLab