From ce44f0e01e881d542aee4c1672762150033bdd26 Mon Sep 17 00:00:00 2001 From: Stephan Bosch <stephan@rename-it.nl> Date: Mon, 12 Dec 2011 09:01:53 +0100 Subject: [PATCH] Updated man pages with recent extension configuration changes. --- doc/man/sieve-dump.1.in | 21 ++++++++++++--------- doc/man/sieve-filter.1.in | 20 +++++++++++--------- doc/man/sieve-test.1.in | 21 ++++++++++++--------- doc/man/sievec.1.in | 19 +++++++++++-------- 4 files changed, 46 insertions(+), 35 deletions(-) diff --git a/doc/man/sieve-dump.1.in b/doc/man/sieve-dump.1.in index 4a07e35cd..a165c885e 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-11-19" "Pigeonhole for Dovecot v2.1" "Pigeonhole" +.TH "SIEVE\-DUMP" 1 "2011-12-12" "Pigeonhole for Dovecot v2.1" "Pigeonhole" .\"------------------------------------------------------------------------ .SH NAME sieve\-dump \- Pigeonhole\(aqs Sieve script binary dump tool @@ -47,16 +47,19 @@ human\-readable output. .BI \-x\ extensions 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. +\fB\-\fP, extensions can be included or excluded relative to the configured set +of active 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. For example \fB\-x\fP \(dq+imapflags \-enotify\(dq will enable the deprecated -imapflags extension along with all extensions that are available by default, -except for the enotify extension. +imapflags extension and disable the enotify extension. The rest of the active +extensions depends on the \fIsieve_extensions\fP and +\fIsieve_global_extensions\fP settings. By default, i.e. +when \fIsieve_extensions\fP and \fIsieve_global_extensions\fP remain +unconfigured, all supported extensions are available, except for deprecated +extensions or those that are still under development. + .\"------------------------------------------------------------------------ .SH ARGUMENTS .TP diff --git a/doc/man/sieve-filter.1.in b/doc/man/sieve-filter.1.in index bb3421ee9..e05cd2af0 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-11-19" "Pigeonhole for Dovecot v2.1" "Pigeonhole" +.TH "SIEVE\-FILTER" 1 "2011-12-12" "Pigeonhole for Dovecot v2.1" "Pigeonhole" .SH NAME sieve\-filter \- Pigeonhole\(aqs Sieve mailbox filter tool @@ -125,16 +125,18 @@ keywords. .BI \-x\ extensions 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. +\fB\-\fP, extensions can be included or excluded relative to the configured set +of active 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. For example \fB\-x\fP \(dq+imapflags \-enotify\(dq will enable the deprecated -imapflags extension along with all extensions that are available by default, -except for the enotify extension. +imapflags extension and disable the enotify extension. The rest of the active +extensions depends on the \fIsieve_extensions\fP and +\fIsieve_global_extensions\fP settings. By default, i.e. +when \fIsieve_extensions\fP and \fIsieve_global_extensions\fP remain +unconfigured, all supported extensions are available, except for deprecated +extensions or those that are still under development. .\"------------------------------------------------------------------------ .SH ARGUMENTS diff --git a/doc/man/sieve-test.1.in b/doc/man/sieve-test.1.in index 9caf39316..2220c8332 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-11-19" "Pigeonhole for Dovecot v2.1" "Pigeonhole" +.TH "SIEVE\-TEST" 1 "2011-12-12" "Pigeonhole for Dovecot v2.1" "Pigeonhole" .SH NAME sieve\-test \- Pigeonhole\(aqs Sieve script tester .\"------------------------------------------------------------------------ @@ -112,16 +112,19 @@ Refer to the runtime trace debugging section below. .BI \-x\ extensions 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. +\fB\-\fP, extensions can be included or excluded relative to the configured set +of active 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. For example \fB\-x\fP \(dq+imapflags \-enotify\(dq will enable the deprecated -imapflags extension along with all extensions that are available by default, -except for the enotify extension. +imapflags extension and disable the enotify extension. The rest of the active +extensions depends on the \fIsieve_extensions\fP and +\fIsieve_global_extensions\fP settings. By default, i.e. +when \fIsieve_extensions\fP and \fIsieve_global_extensions\fP remain +unconfigured, all supported extensions are available, except for deprecated +extensions or those that are still under development. + .\"------------------------------------------------------------------------ .SH ARGUMENTS .TP diff --git a/doc/man/sievec.1.in b/doc/man/sievec.1.in index 188875924..209789f67 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-11-19" "Pigeonhole for Dovecot v2.1" "Pigeonhole" +.TH "SIEVEC" 1 "2011-12-12" "Pigeonhole for Dovecot v2.1" "Pigeonhole" .\"------------------------------------------------------------------------ .SH NAME sievec \- Pigeonhole\(aqs Sieve script compiler @@ -60,16 +60,19 @@ for a compiled Sieve binary file. Note that this option is not allowed when the .BI \-x\ extensions 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 +\fB\-\fP, extensions can be included or excluded relative to the configured set +of active 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. +are ignored and a warning is produced. For example \fB\-x\fP \(dq+imapflags \-enotify\(dq will enable the deprecated -imapflags extension along with all extensions that are available by default, -except for the enotify extension. +imapflags extension and disable the enotify extension. The rest of the active +extensions depends on the \fIsieve_extensions\fP and +\fIsieve_global_extensions\fP settings. By default, i.e. +when \fIsieve_extensions\fP and \fIsieve_global_extensions\fP remain +unconfigured, all supported extensions are available, except for deprecated +extensions or those that are still under development. + .\"------------------------------------------------------------------------ .SH ARGUMENTS .TP -- GitLab