From: Karolin Seeger <kseeger@samba.org>
Date: Tue, 3 Jun 2008 14:44:59 +0000 (+0200)
Subject: man pages: Add documentation for new parameter 'ldap connection timeout'.
X-Git-Tag: samba-4.0.0alpha6~801^2~1181
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a307e90f3f274cd307a5e7377bae4b27ae3a5c69;p=thirdparty%2Fsamba.git

man pages: Add documentation for new parameter 'ldap connection timeout'.

Karolin
(This used to be commit f7bfa1330cef34b1bbe7969bddbce2ff895321ed)
---

diff --git a/docs-xml/smbdotconf/ldap/ldapconnectiontimeout.xml b/docs-xml/smbdotconf/ldap/ldapconnectiontimeout.xml
new file mode 100644
index 00000000000..31713c9cb50
--- /dev/null
+++ b/docs-xml/smbdotconf/ldap/ldapconnectiontimeout.xml
@@ -0,0 +1,22 @@
+<samba:parameter name="ldap connection timeout"
+		 context="G"
+		 advanced="1" developer="1"
+			type="integer"
+		 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+<description>
+	<para>
+	This parameter tells the LDAP library calls which timeout in seconds
+	they should honor during initial connection establishments to LDAP servers.
+	It is very useful in failover scenarios in particular. If one or more LDAP
+	servers are not reachable at all, we do not have to wait until TCP
+	timeouts are over. This feature must be supported by your LDAP library.
+	</para>
+
+	<para>
+	This parameter is different from <smbconfoption name="ldap timeout"/>
+	which affects operations on LDAP servers using an existing connection
+	and not establishing an initial connection.
+	</para>
+</description>
+<value type="default">2</value>
+</samba:parameter>