|
version 1.40.2.8, 2011/01/04 23:49:43
|
version 1.41, 2006/06/06 23:45:58
|
|
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.40.2.7 2010/04/13 20:22:37 kurt Exp $ |
.\" $OpenLDAP: pkg/ldap/doc/man/man3/ldap.3,v 1.40 2006/01/03 22:12:04 kurt Exp $ |
| .\" Copyright 1998-2011 The OpenLDAP Foundation All Rights Reserved. |
.\" Copyright 1998-2006 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 4510) provides |
The Lightweight Directory Access Protocol (LDAP) (RFC 3377) 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 (RFC 4511), LDAP over TLS/SSL, and LDAP over IPC (UNIX |
LDAP over TCP (RFC2251), LDAP over TLS/SSL, and LDAP over IPC (UNIX |
| domain sockets). This API supports SASL (RFC 4513) and Start TLS |
domain sockets). This API supports SASL (RFC2829) and Start TLS |
| (RFC 4513) as well as a number of protocol extensions. This API is |
(RFC2830) 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 4510. It also supports a variant |
Protocol (LDAPv3) as defined in RFC 3377. 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) are considered obsolete. |
RFC 1777. Version 2 (all variants) should be viewed as 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 77 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 4514 UTF-8 |
be passed to the LDAP routines should conform to RFC 2253 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 4515 UTF-8 |
constructed by hand and should conform to RFC 2254 UTF\-8 |
| string representation. |
string representation. |
| .LP |
.LP |
| LDAP URLs to be passed to routines are expected to conform |
LDAP URL are to be passed to routines are expected to conform |
| to RFC 4516 format. The |
to RFC 2255 syntax. 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 118 routines are used to sort the entries an
|
Line 114 routines are used to sort the entries an
|
| the ldap search routines. |
the ldap search routines. |
| .SH DEPRECATED INTERFACES |
.SH DEPRECATED INTERFACES |
| A number of interfaces are now considered deprecated. For instance, |
A number of interfaces are now considered deprecated. For instance, |
| ldap_add(3) is deprecated in favor of ldap_add_ext(3). |
ldap_add(3) is deprecated in favor of ldap_add_ext(3). While deprecated, |
| .so 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 |
.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 188 list of LDAP errors and their meanings
|
Line 190 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 270 case insensitive string comparison
|
Line 266 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 |
| .so ../Project |
.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. |
| .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 |
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to ldap.3 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [OpenLDAP] / doc / man / man3