From: Pierangelo Masarati <ando@openldap.org>
Date: Tue, 24 Oct 2006 19:49:48 +0000 (+0000)
Subject: document the network-timeout directive (ITS#4718)
X-Git-Tag: OPENLDAP_REL_ENG_2_3_MP~37
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=53cd4a88d7621cb379fc1d41c9a5d366228346ee;p=openldap

document the network-timeout directive (ITS#4718)
---

diff --git a/doc/man/man5/slapd-ldap.5 b/doc/man/man5/slapd-ldap.5
index 28bcc7ebf6..a8aae31d80 100644
--- a/doc/man/man5/slapd-ldap.5
+++ b/doc/man/man5/slapd-ldap.5
@@ -347,6 +347,16 @@ and
 This directive causes a cached connection to be dropped an recreated
 after it has been idle for the specified time.
 
+.TP
+.B network-timeout <time>
+Sets the network timeout value after which
+.BR poll (2)/ select (2) 
+following a 
+.BR connect (2) 
+returns in case of no activity.
+The value is in seconds, and it can be specified as for
+.BR idle-timeout .
+
 .TP
 .B protocol\-version {0,2,3}
 This directive indicates what protocol version must be used to contact
diff --git a/doc/man/man5/slapd-meta.5 b/doc/man/man5/slapd-meta.5
index 95a1603552..ba2653820d 100644
--- a/doc/man/man5/slapd-meta.5
+++ b/doc/man/man5/slapd-meta.5
@@ -86,6 +86,11 @@ should be defined first for clarity, including those that are common
 to all backends.
 They are:
 
+.TP
+.B conn-ttl <time>
+This directive causes a cached connection to be dropped an recreated
+after a given ttl, regardless of being idle or not.
+
 .TP
 .B default-target none
 This directive forces the backend to reject all those operations
@@ -109,11 +114,6 @@ illustrated for the
 .B idle-timeout
 directive.
 
-.TP
-.B conn-ttl <time>
-This directive causes a cached connection to be dropped an recreated
-after a given ttl, regardless of being idle or not.
-
 .TP
 .B onerr {CONTINUE|stop}
 This directive allows to select the behavior in case an error is returned
@@ -282,6 +282,18 @@ This maps object classes and attributes as in the LDAP backend.
 See
 .BR slapd-ldap (5).
 
+.TP
+.B network-timeout <time>
+Sets the network timeout value after which
+.BR poll (2)/ select (2) 
+following a 
+.BR connect (2) 
+returns in case of no activity.
+The value is in seconds, and it can be specified as for
+.BR idle-timeout .
+If set before any target specification, it affects all targets, unless
+overridden by any per-target directive.
+
 .TP
 .B nretries {forever|never|<nretries>}
 This directive defines how many times a bind should be retried