dovecot-2.0-pigeonhole: Restructured extension-specific install ...

[pigeonhole at rename-it.nl]

details:   http://hg.rename-it.nl/dovecot-2.0-pigeonhole/rev/2e1ce7cf1b19
changeset: 1490:2e1ce7cf1b19
user:      Stephan Bosch <stephan at rename-it.nl>
date:      Thu Apr 14 21:26:42 2011 +0200
description:
Restructured extension-specific install documentation.

diffstat:

 doc/spamtest-virustest.txt |  21 +++++++++++++++------
 doc/vacation.txt           |  35 +++++++++++++++++++++++++++++------
 2 files changed, 44 insertions(+), 12 deletions(-)

diffs (95 lines):

diff -r 5a485986b032 -r 2e1ce7cf1b19 doc/spamtest-virustest.txt
--- a/doc/spamtest-virustest.txt	Wed Apr 13 01:00:10 2011 +0200
+++ b/doc/spamtest-virustest.txt	Thu Apr 14 21:26:42 2011 +0200
@@ -1,5 +1,12 @@
 Spamtest and Virustest Extensions
-=================================
+
+Relevant Specifications
+=======================
+
+	RFC5235 - doc/rfc/spamvirustest.rfc5235.txt
+
+Description
+===========
 
 Using the spamtest and virustest extensions (RFC 5235), the Sieve language 
 provides a uniform and standardized command interface for evaluating spam and
@@ -8,12 +15,14 @@
 field value. They only need to know how to use the spamtest (spamtestplus) and 
 virustest extensions. This also gives GUI-based Sieve editors the means to 
 provide a portable and easy to install interface for spam and virus filter 
-configuration.
+configuration. The burden of specifying which headers need to be checked and
+how the scanner output is represented falls onto the Sieve administrator.
 
-The burden of specifying which headers need to be checked and how the scanner
-output is represented falls onto the Sieve administrator. The spamtest, 
-spamtestplus and virustest extensions are not enabled by default and thus need
-to be enabled explicitly using the sieve_extensions setting. 
+Configuration
+=============
+
+The spamtest, spamtestplus and virustest extensions are not enabled by default
+and thus need to be enabled explicitly using the sieve_extensions setting. 
 
 The following settings need to be configured for using the spamtest and
 spamtestplus extensions. The virustest extension has identical configuration
diff -r 5a485986b032 -r 2e1ce7cf1b19 doc/vacation.txt
--- a/doc/vacation.txt	Wed Apr 13 01:00:10 2011 +0200
+++ b/doc/vacation.txt	Thu Apr 14 21:26:42 2011 +0200
@@ -1,7 +1,29 @@
 Vacation Extension
-==================
 
-The vacation extension is available by default. In contrast, the (draft)
+Relevant specifications
+=======================
+
+	RFC5230 - doc/rfc/vacation.rfc5230.txt
+	RFC6131 - doc/rfc/vacation-seconds.rfc6131.txt
+
+Description
+===========
+
+The Sieve vacation extension [RFC5230] defines a mechanism to generate
+automatic replies to incoming email messages. It takes various
+precautions to make sure replies are only sent when appropriate. Script
+authors specify how often replies are sent to a particular contact. 
+In the original vacation extension, this interval is specified in days
+with a minimum of one day. When more granularity is necessary and 
+particularly when replies must be sent more frequently than one day, 
+the vacation-seconds extension [RFC6131] can be used. This allows 
+specifying the minimum reply interval in seconds with a minimum of zero
+(reply is then always sent), depending on administrator configuration.
+
+Configuration
+=============
+
+The vacation extension is available by default. In contrast, the
 vacation-seconds extension - which implies the vacation extension when 
 used - is not available by default and needs to be enabled explicitly by
 adding it to the sieve_extensions setting. The configuration also needs
@@ -13,17 +35,18 @@
 are specified in s(econds), unless followed by a d(ay), h(our) or m(inute)
 specifier character. 
 
-The following settings can be configured for using the vacation extension:
+The following settings can be configured the vacation extension (default
+values are indicated):
 
 sieve_vacation_min_period = 1d
   This specifies the minimum period that can be specified for the :days
   and :seconds tags of the vacation command. A minimum of 0 indicates that
   users are allowed to make the Sieve interpreter send a vacation response
-  message for every incoming message that meets the other criteria (not
-  recommended). 
+  message for every incoming message that meets the other reply criteria
+  (refer to RFC5230). A value of zero is however not recommended. 
 
 sieve_vacation_max_period = 0
-  This specifies the minimum period that can be specified for the :days tag
+  This specifies the maximum period that can be specified for the :days tag
   of the vacation command. The configured value must be larger than the
   sieve_vacation_min_period setting. A value of 0 has a special meaning: it
   indicates that there is no upper limit.