version 1.40, 2006/01/03 22:12:04
|
version 1.40.2.2, 2007/02/13 20:22:06
|
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.39 2005/12/19 23:45:39 kurt Exp $ |
.\" $OpenLDAP: pkg/ldap/doc/man/man3/ldap.3,v 1.40.2.1 2006/08/17 23:50:24 kurt Exp $ |
.\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved. |
.\" Copyright 1998-2007 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 |
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 65 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 81 All character string input/output is exp
|
Line 81 All character string input/output is exp
|
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 UTF\-8 |
be passed to the LDAP routines should conform to RFC 4514 UTF\-8 |
string representation. |
string representation. |
.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 UTF\-8 |
constructed by hand and should conform to RFC 4515 UTF\-8 |
string representation. |
string representation. |
.LP |
.LP |
LDAP URL are to be passed to routines are expected to conform |
LDAP URL are to be passed to routines are expected to conform |
to RFC 2255 syntax. The |
to RFC 4516 format. 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. |
.SH DISPLAYING RESULTS |
.SH DISPLAYING RESULTS |
Line 112 Also provided are various utility routin
|
Line 112 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 256 case insensitive string comparison
|
Line 260 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 |