diff --git a/doc/man/sieve-test.1 b/doc/man/sieve-test.1 index 0db6710ee6f36592b9ffa7fb8a34147f25c0749f..6e17c69b031d1923a2d9d018c4b3efea103fc90a 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 84781a11826debd1e15e37c2683aa4276dc7a737..d6c103955fe26e5488f94a1feab86cf12282547f 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 3758f7b0d29f725810655fe72dbb237bc41d3b6a..27ef268abe6d1c10671b03e324c2053f19d4225d 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>.