Added max-depth/return-error to slapo-chain(5)

diff --git a/CHANGES b/CHANGES
index 6df7a3cf3c743ecc8cb6d85a8a258fa69bd31a0a..32790775ed25018d91e935a9f6bc1871b51fa578 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -11,6 +11,7 @@ OpenLDAP 2.3.39 Engineering
        Fixed libldap ppolicy control creation (ITS#5103)
        Documentation
                Added slapd-sql empty oc mapping workaround (ITS#4785)
+               Added max-depth/return-error to slapo-chain(5)
                Fixed Admin Guide URL in README (ITS#5107)
 
 OpenLDAP 2.3.38 Release (2007/08/20)

diff --git a/doc/man/man5/slapo-chain.5 b/doc/man/man5/slapo-chain.5
index 264655edd96531bc0c667b56a7c9dbb38f5aef06..02715242601fd07852a832a9aff13778d5b80219 100644 (file)
--- a/doc/man/man5/slapo-chain.5
+++ b/doc/man/man5/slapo-chain.5
@@ -53,6 +53,14 @@ feature.
 [Note: this may change in the future, as the \fBldap\fP(5) and 
 \fBmeta\fP(5) backends might no longer chase referrals on their own.]
 .TP
+.B chain-cache-uri {FALSE|true}
+This directive instructs the \fIchain\fP overlay to cache
+connections to URIs parsed out of referrals that are not predefined,
+to be reused for later chaining.
+These URIs inherit the properties configured for the underlying 
+\fBslapd-ldap\fP(5) before any occurrence of the \fBchain-uri\fP
+directive; basically, they are chained anonymously.
+.TP
 .B chain-chaining [resolve=<r>] [continuation=<c>] [critical]
 This directive enables the \fIchaining\fP control
 (see \fIdraft-sermersheim-ldap-chaining\fP for details)
@@ -71,13 +79,18 @@ The values \fBr\fP and \fBc\fP can be any of
 If the \fBcritical\fP flag affects the control criticality if provided.
 [This control is experimental and its support may change in the future.]
 .TP
-.B chain-cache-uri {FALSE|true}
-This directive instructs the \fIchain\fP overlay to cache
-connections to URIs parsed out of referrals that are not predefined,
-to be reused for later chaining.
-These URIs inherit the properties configured for the underlying 
-\fBslapd-ldap\fP(5) before any occurrence of the \fBchain-uri\fP
-directive; in detail, they are essentially chained anonymously.
+.B chain-max-depth <n>
+In case a referral is returned during referral chasing, further chasing
+occurs at most \fB<n>\fP levels deep.  Set to \fB1\fP (the default) 
+to disable further referral chasing.
+.TP
+.B chain-return-error {FALSE|true}
+In case referral chasing fails, the real error is returned instead
+of the original referral.  In case multiple referral URIs are present,
+only the first error is returned.  This behavior may not be always
+appropriate nor desirable, since failures in referral chasing might be
+better resolved by the client (e.g. when caused by distributed 
+authentication issues).
 .TP
 .B chain-uri <ldapuri>
 This directive instantiates a new underlying \fIldap\fP database