Diff for /doc/man/man3/ldap.3 between versions 1.37 and 1.40.2.8

version 1.37, 2005/08/27 16:38:02 version 1.40.2.8, 2011/01/04 23:49:43
Line 1 Line 1
 .TH LDAP 3 "RELEASEDATE" "OpenLDAP LDVERSION"  .TH LDAP 3 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP: pkg/ldap/doc/man/man3/ldap.3,v 1.36 2005/07/04 04:57:10 hallvard Exp $  .\" $OpenLDAP: pkg/ldap/doc/man/man3/ldap.3,v 1.40.2.7 2010/04/13 20:22:37 kurt Exp $
 .\" Copyright 1998-2005 The OpenLDAP Foundation All Rights Reserved.  .\" Copyright 1998-2011 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.  .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME  .SH NAME
 ldap - OpenLDAP Lightweight Directory Access Protocol API  ldap \- OpenLDAP Lightweight Directory Access Protocol API
 .SH LIBRARY  .SH LIBRARY
 OpenLDAP LDAP (libldap, -lldap)  OpenLDAP LDAP (libldap, \-lldap)
 .SH SYNOPSIS  .SH SYNOPSIS
 .nf  .nf
 .ft B  .ft B
Line 14  OpenLDAP LDAP (libldap, -lldap) Line 14  OpenLDAP LDAP (libldap, -lldap)
 .fi  .fi
 .SH DESCRIPTION  .SH DESCRIPTION
 .LP  .LP
 The Lightweight Directory Access Protocol (LDAP) (RFC 3377) provides  The Lightweight Directory Access Protocol (LDAP) (RFC 4510) provides
 access to X.500 directory services.  These services may be stand\-alone  access to X.500 directory services.  These services may be stand\-alone
 or part of a distributed directory service.  This client API supports  or part of a distributed directory service.  This client API supports
 LDAP over TCP (RFC2251), LDAP over TLS/SSL, and LDAP over IPC (UNIX  LDAP over TCP (RFC 4511), LDAP over TLS/SSL, and LDAP over IPC (UNIX
 domain sockets).  This API supports SASL (RFC2829) and Start TLS  domain sockets).  This API supports SASL (RFC 4513) and Start TLS
 (RFC2830) as well as a number of protocol extensions.  This API is  (RFC 4513) as well as a number of protocol extensions.  This API is
 loosely based upon IETF/LDAPEXT C LDAP API draft specification, a (orphaned)  loosely based upon IETF/LDAPEXT C LDAP API draft specification, a (orphaned)
 work in progress.  work in progress.
 .LP  .LP
Line 39  created using Line 39  created using
 and set the protocol version to 3 by calling  and set the protocol version to 3 by calling
 .BR ldap_set_option (3).  .BR ldap_set_option (3).
 The underlying session is established first operation is  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  A Start TLS operation is performed by calling
 .BR ldap_start_tls_s (3).  .BR ldap_start_tls_s (3).
 A LDAP bind operation is performed by calling  A LDAP bind operation is performed by calling
 .BR ldap_sasl_bind (3)  .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.,  by calling one of the synchronous or asynchronous routines (e.g.,
 .BR ldap_search_ext_s (3)  .BR ldap_compare_ext_s (3)
 or  or
 .BR ldap_search_ext (3)  .BR ldap_compare_ext (3)
 followed by  followed by
 .BR ldap_result (3)).  .BR ldap_result (3)).
 Results returned from these routines are interpreted by calling the  Results returned from these routines are interpreted by calling the
Line 60  Errors can be interpreted by calling Line 65  Errors can be interpreted by calling
 .BR ldap_err2string (3).  .BR ldap_err2string (3).
 .SH LDAP versions  .SH LDAP versions
 This library supports version 3 of the Lightweight Directory Access  This library supports version 3 of the Lightweight Directory Access
 Protocol (LDAPv3) as defined in RFC 3377.  It also supports a variant  Protocol (LDAPv3) as defined in RFC 4510.  It also supports a variant
 of version 2 of LDAP as defined by U-Mich LDAP and, to some degree,  of version 2 of LDAP as defined by U-Mich LDAP and, to some degree,
 RFC 1777.  Version 2 (all variants) should be viewed as obsolete.  RFC 1777.  Version 2 (all variants) are considered obsolete.
 Version 3 should be used instead.  Version 3 should be used instead.
 .LP  .LP
 For backwards compatibility reasons, the library defaults to version 2.  For backwards compatibility reasons, the library defaults to version 2.
Line 72  should use Line 77  should use
 to select version 3.  The library manual pages assume version 3  to select version 3.  The library manual pages assume version 3
 has been selected.  has been selected.
 .SH INPUT and OUTPUT PARAMETERS  .SH INPUT and OUTPUT PARAMETERS
 All character string input/output is expected to be/is UTF\-8  All character string input/output is expected to be/is UTF-8
 encoded Unicode (version 3.2).   encoded Unicode (version 3.2). 
 .LP  .LP
 Distinguished names (DN) (and relative distinguished names (RDN) to  Distinguished names (DN) (and relative distinguished names (RDN) to
 be passed to the LDAP routines should conform to RFC 2253.  The  be passed to the LDAP routines should conform to RFC 4514 UTF-8
 .BR ldap_explode_dn (3)  string representation. 
 routines can be used to work with DNs.  
 .LP  .LP
 Search filters to be passed to the search routines are to be  Search filters to be passed to the search routines are to be
 constructed by hand and should conform to RFC 2254.  constructed by hand and should conform to RFC 4515 UTF-8
   string representation.
 .LP  .LP
 LDAP URL are to be passed to routines are expected to conform  LDAP URLs to be passed to routines are expected to conform
 to RFC 2255.  to RFC 4516 format.  The
 The  
 .BR ldap_url (3)  .BR ldap_url (3)
 routines can be used to work with LDAP URLs.  routines can be used to work with LDAP URLs.
   .LP
   LDAP controls to be passed to routines can be manipulated using the
   .BR ldap_controls (3)
   routines.
 .SH DISPLAYING RESULTS  .SH DISPLAYING RESULTS
 Results obtained from the search routines can be output by hand,  Results obtained from the search routines can be output by hand,
 by calling  by calling
Line 108  Also provided are various utility routin Line 116  Also provided are various utility routin
 .BR ldap_sort (3)  .BR ldap_sort (3)
 routines are used to sort the entries and values returned via  routines are used to sort the entries and values returned via
 the ldap search routines.   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).
   .so Deprecated
 .SH BER LIBRARY  .SH BER LIBRARY
 Also included in the distribution is a set of lightweight Basic  Also included in the distribution is a set of lightweight Basic
 Encoding Rules routines.  These routines are used by the LDAP library  Encoding Rules routines.  These routines are used by the LDAP library
Line 176  list of LDAP errors and their meanings Line 188  list of LDAP errors and their meanings
 .SM ldap_err2string(3)  .SM ldap_err2string(3)
 convert LDAP error indication to a string  convert LDAP error indication to a string
 .TP  .TP
   .SM ldap_extended_operation(3)
   asynchronously perform an arbitrary extended operation
   .TP
   .SM ldap_extended_operation_s(3)
   synchronously perform an arbitrary extended operation
   .TP
 .SM ldap_first_attribute(3)  .SM ldap_first_attribute(3)
 return first attribute name in an entry  return first attribute name in an entry
 .TP  .TP
Line 194  return number of entries in a search res Line 212  return number of entries in a search res
 .SM ldap_get_dn(3)  .SM ldap_get_dn(3)
 extract the DN from an entry  extract the DN from an entry
 .TP  .TP
 .SM ldap_explode_dn(3)  
 convert a DN into its component parts (deprecated)  
 .TP  
 .SM ldap_explode_rdn(3)  
 convert an RDN into its component parts (deprecated)  
 .TP  
 .SM ldap_get_values_len(3)  .SM ldap_get_values_len(3)
 return an attribute's values with lengths  return an attribute's values with lengths
 .TP  .TP
Line 258  case insensitive string comparison Line 270  case insensitive string comparison
 .BR slapd (8),  .BR slapd (8),
 .BR draft-ietf-ldapext-ldap-c-api-xx.txt \ <http://www.ietf.org>  .BR draft-ietf-ldapext-ldap-c-api-xx.txt \ <http://www.ietf.org>
 .SH ACKNOWLEDGEMENTS  .SH ACKNOWLEDGEMENTS
 .B OpenLDAP  .so ../Project
 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).  
 .B OpenLDAP  
 is derived from University of Michigan LDAP 3.3 Release.    
 .LP  .LP
 These API manual pages are loosely based upon descriptions provided  These API manual pages are loosely based upon descriptions provided
 in the IETF/LDAPEXT C LDAP API Internet Draft, a (orphaned) work  in the IETF/LDAPEXT C LDAP API Internet Draft, a (orphaned) work

Removed from v.1.37  
changed lines
  Added in v.1.40.2.8


______________
© Copyright 1998-2020, OpenLDAP Foundation, info@OpenLDAP.org