dovecot-2.2-pigeonhole: Adjusted documentation to mention LDAP s...

[pigeonhole at rename-it.nl]

details:   http://hg.rename-it.nl/dovecot-2.2-pigeonhole/rev/8a793175f4ab
changeset: 1888:8a793175f4ab
user:      Stephan Bosch <stephan at rename-it.nl>
date:      Thu Jul 24 09:27:14 2014 +0200
description:
Adjusted documentation to mention LDAP support can be compiled as a plugin.

diffstat:

 INSTALL                      |  11 +++++++++--
 doc/script-location-ldap.txt |  11 ++++++++++-
 2 files changed, 19 insertions(+), 3 deletions(-)

diffs (52 lines):

diff -r 10de71577ed3 -r 8a793175f4ab INSTALL
--- a/INSTALL	Thu Jul 24 09:17:07 2014 +0200
+++ b/INSTALL	Thu Jul 24 09:27:14 2014 +0200
@@ -48,6 +48,12 @@
    In fact, it may not compile at all. Enable this only when you are eager to
    test some of the new development functionality.
 
+ --with-ldap=no
+   Controls wether Sieve LDAP support is built. This allows retrieving Sieve
+   scripts from an LDAP database. When set to `yes', support is built in. When
+   set to `plugin', LDAP support is compiled into a Sieve plugin called
+   `sieve_storage_ldap'.
+
 Configuration
 =============
 
@@ -184,8 +190,9 @@
    The Pigeonhole Sieve interpreter can have plugins of its own. Using this
    setting, the used plugins can be specified. Check the Dovecot wiki
    (wiki2.dovecot.org) or the pigeonhole website (http://pigeonhole.dovecot.org)
-   for available plugins. The sieve_extprograms plugin is included in this
-   release.
+   for available plugins. The `sieve_extprograms' plugin is included in this
+   release. LDAP support may also be compiled as a plugin called
+   `sieve_storage_ldap'.
 
  sieve_user_log =
    The path to the file where the user log file is written. If not configured, a
diff -r 10de71577ed3 -r 8a793175f4ab doc/script-location-ldap.txt
--- a/doc/script-location-ldap.txt	Thu Jul 24 09:17:07 2014 +0200
+++ b/doc/script-location-ldap.txt	Thu Jul 24 09:27:14 2014 +0200
@@ -17,10 +17,19 @@
 location specification. Refer to the INSTALL file for more general information
 about configuration of script locations.
 
+Depending on how Pigeonhole was configured and compiled (refer to INSTALL file
+for more information), LDAP support may only be available from a plugin called
+`sieve_storage_ldap'.
+
 Configuration
 =============
 
-The script location syntax is specialized as follows:
+If support for the LDAP location type is compiled as a plugin, it needs to be
+added to the sieve_plugins setting before it can be used, e.g.:
+
+sieve_plugins = sieve_storage_ldap
+
+The script location syntax is specified as follows:
 
 location = ldap:<config-file>[;<option>[=<value>][;...]]