Integer indexing - handle huge values

[openldap] / doc / man / man3 / ldap_get_option.3

diff --git a/doc/man/man3/ldap_get_option.3 b/doc/man/man3/ldap_get_option.3
index 567fb3459b67f98a221636cad579e010dbed5072..62b76866c8df53471db643d18ed6338c96650b65 100644 (file)
--- a/doc/man/man3/ldap_get_option.3
+++ b/doc/man/man3/ldap_get_option.3
@@ -1,6 +1,6 @@
 .TH LDAP_GET_OPTION 3 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
-.\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ldap_get_option, ldap_set_option \- LDAP option handling routines
@@ -56,15 +56,18 @@ must be a
 This is a read-only, handler-specific option.
 .TP
 .B LDAP_OPT_TIMEOUT
-Sets/gets a timeout value (\fIFIXME: currently unused\fP).
-.BR outvalue
+Sets/gets a timeout value for the synchronous API calls.
+.B outvalue
 must be a 
-.BR "struct timeval **" ,
-and the resulting pointer must be freed by the caller using
-.BR ldap_memfree (3).
-.BR invalue
-must be a
-.BR "struct timeval *" .
+.BR "struct timeval **"
+(the caller has to free
+.BR *outvalue ) ,
+and
+.B invalue
+must be a 
+.BR "struct timeval *" ,
+and they cannot be NULL. Using a struct with seconds set to -1 results
+in an infinite timeout, which is the default.
 .TP
 .B LDAP_OPT_NETWORK_TIMEOUT
 Sets/gets the network timeout value after which
@@ -72,17 +75,20 @@ Sets/gets the network timeout value after which
 following a 
 .BR connect (2) 
 returns in case of no activity.
-.BR outvalue
+.B outvalue
 must be a 
-.BR "struct timeval **" ,
-and the resulting pointer must be freed by the caller using
-.BR ldap_memfree (3).
-.BR invalue
-must be a
-.BR "struct timeval *" .
+.BR "struct timeval **"
+(the caller has to free
+.BR *outvalue ) ,
+and
+.B invalue
+must be a 
+.BR "struct timeval *" ,
+and they cannot be NULL. Using a struct with seconds set to -1 results
+in an infinite timeout, which is the default.
 .TP
 .B LDAP_OPT_DEREF
-Sets/gets the value that defines when alias deferencing must occur.
+Sets/gets the value that defines when alias dereferencing must occur.
 .BR outvalue 
 and 
 .BR invalue
@@ -189,7 +195,7 @@ the library duplicates the controls passed via
 .B LDAP_OPT_HOST_NAME
 Sets/gets a space-separated list of hosts to be contacted by the library 
 when trying to establish a connection.
-This is now deprecated in favour of
+This is now deprecated in favor of
 .BR LDAP_OPT_URI .
 .BR outvalue
 must be a 
@@ -328,7 +334,4 @@ by setting that option to
 .B RFC 4422
 (http://www.rfc-editor.org),
 .SH ACKNOWLEDGEMENTS
-.B OpenLDAP
-is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
-.B OpenLDAP
-is derived from University of Michigan LDAP 3.3 Release.  
+.so ../Project