--- doc/man/man3/ldap.3 2005/11/03 18:02:55 1.34.2.4 +++ doc/man/man3/ldap.3 2006/06/06 23:45:58 1.41 @@ -1,6 +1,6 @@ .TH LDAP 3 "RELEASEDATE" "OpenLDAP LDVERSION" -.\" $OpenLDAP: pkg/ldap/doc/man/man3/ldap.3,v 1.34.2.3 2005/08/29 18:26:09 kurt Exp $ -.\" Copyright 1998-2005 The OpenLDAP Foundation All Rights Reserved. +.\" $OpenLDAP: pkg/ldap/doc/man/man3/ldap.3,v 1.40 2006/01/03 22:12:04 kurt Exp $ +.\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved. .\" Copying restrictions apply. See COPYRIGHT/LICENSE. .SH NAME ldap - OpenLDAP Lightweight Directory Access Protocol API @@ -39,16 +39,21 @@ created using and set the protocol version to 3 by calling .BR ldap_set_option (3). The underlying session is established first operation is -issued. This would generally be a Start TLS or Bind operation. +issued. This would generally be a Start TLS or Bind operation, +or a Search operation to read attributes of the Root DSE. A Start TLS operation is performed by calling .BR ldap_start_tls_s (3). A LDAP bind operation is performed by calling .BR ldap_sasl_bind (3) -or one of its friends. Subsequently, other operations are performed +or one of its friends. +A Search operation is performed by calling ldap_search_ext_s(3) +or one of its friends. + +Subsequently, additional operations are performed by calling one of the synchronous or asynchronous routines (e.g., -.BR ldap_search_ext_s (3) +.BR ldap_compare_ext_s (3) or -.BR ldap_search_ext (3) +.BR ldap_compare_ext (3) followed by .BR ldap_result (3)). Results returned from these routines are interpreted by calling the @@ -107,6 +112,16 @@ Also provided are various utility routin .BR ldap_sort (3) routines are used to sort the entries and values returned via the ldap search routines. +.SH DEPRECATED INTERFACES +A number of interfaces are now considered deprecated. For instance, +ldap_add(3) is deprecated in favor of ldap_add_ext(3). While deprecated, +these interfaces generally remain in the library. The macro +LDAP_DEPRECATED can be defined to a non-zero value +(e.g., -DLDAP_DEPRECATED=1) when compiling program designed to use +deprecated interaces. It is recommended that developers writing new +programs, or updating old programs, avoid use of deprecated interfaces. +Over time, it is expected that documentation (and, eventually, support) for +deprecated interfaces to be eliminated. .SH BER LIBRARY Also included in the distribution is a set of lightweight Basic Encoding Rules routines. These routines are used by the LDAP library