summaryrefslogtreecommitdiff
path: root/usr/src/man/man3ldap
diff options
context:
space:
mode:
Diffstat (limited to 'usr/src/man/man3ldap')
-rw-r--r--usr/src/man/man3ldap/ldap.3ldap21
-rw-r--r--usr/src/man/man3ldap/ldap_abandon.3ldap8
-rw-r--r--usr/src/man/man3ldap/ldap_memcache.3ldap9
3 files changed, 6 insertions, 32 deletions
diff --git a/usr/src/man/man3ldap/ldap.3ldap b/usr/src/man/man3ldap/ldap.3ldap
index 1b72738ee2..79e283fa62 100644
--- a/usr/src/man/man3ldap/ldap.3ldap
+++ b/usr/src/man/man3ldap/ldap.3ldap
@@ -4,7 +4,7 @@
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH LDAP 3LDAP "Jan 27, 2002"
+.TH LDAP 3LDAP "April 9, 2016"
.SH NAME
ldap \- Lightweight Directory Access Protocol package
.SH SYNOPSIS
@@ -16,7 +16,6 @@ cc[ \fIflag\fR... ] \fIfile\fR... -lldap[ \fIlibrary\fR... ]
.fi
.SH DESCRIPTION
-.sp
.LP
The Lightweight Directory Access Protocol ("LDAP") package (SUNWlldap) includes
various command line LDAP clients and a LDAP client library to provide
@@ -45,7 +44,6 @@ Asynchronous routines provide an invocation identifier which can be used to
obtain the result of a specific operation by passing it to
the\fBldap_result\fR(3LDAP) function.
.SS "Initializing a LDAP session"
-.sp
.LP
Initializing a LDAP session involves calling the \fBldap_init\fR(3LDAP)
function. However, the call does not actually open a connection to the LDAP
@@ -54,7 +52,6 @@ connection is opened when the first operation is attempted. Unlike
\fBldap_init()\fR, \fBldap_open\fR(3LDAP) attempts to open a connection with
the LDAP server. However, the use of \fBldap_open()\fR is deprecated.
.SS "Authenticating to a LDAP server"
-.sp
.LP
The \fBldap_sasl_bind\fR(3LDAP) and \fBldap_sasl_bind_s\fR(3LDAP) functions
provide general and extensible authenticaton for an LDAP client to a LDAP
@@ -63,7 +60,6 @@ routines \fBldap_simple_bind\fR(3LDAP) and \fBldap_simple_bind_s\fR(3LDAP) use
cleartext passwords to bind to the LDAP server. Use of \fBldap_bind\fR(3LDAP)
and \fBldap_bind_s\fR(3LDAP)(3LDAP) is deprecated.
.SS "Searching a LDAP directory"
-.sp
.LP
Search for an entry in a LDAP directory by calling the
\fBldap_search_ext\fR(3LDAP) or the \fBldap_search_ext_s\fR(3LDAP) functions.
@@ -72,7 +68,6 @@ size and time limits as arguments for each search operation.
\fBldap_search\fR(3LDAP) and \fBldap_search_s\fR(3LDAP) are identical functions
but do not support the controls and limits as arguments to the call.
.SS "Adding or Deleting an entry"
-.sp
.LP
Use \fBldap_add_ext\fR(3LDAP) and \fBldap_delete_ext\fR(3LDAP) to add or delete
entries in a LDAP directory server. The synchronous counterparts to these
@@ -81,7 +76,6 @@ The \fBldap_add\fR(3LDAP), \fBldap_add_s\fR(3LDAP), \fBldap_delete\fR(3LDAP),
and \fBldap_delete_s\fR(3LDAP) provide identical functionality to add and to
delete entries, but they do not support LDAP v3 server and client controls.
.SS "Modifying Entries"
-.sp
.LP
Use \fBldap_modify_ext\fR(3LDAP) and \fBldap_modify_ext_s\fR(3LDAP) to modify
an existing entry in a LDAP server that supports for LDAPv3 server and client
@@ -90,18 +84,16 @@ controls. Similarly, use \fBldap_rename\fR(3LDAP) and
\fBldap_modrdn\fR(3LDAP), \fBldap_modrdn_s\fR(3LDAP), \fBldap_modrdn2\fR(3LDAP)
and \fBldap_modrdn2_s\fR(3LDAP) interfaces are deprecated.
.SS "Obtaining Results"
-.sp
.LP
Use \fBldap_result\fR(3LDAP) to obtain the results of a previous asynchronous
operation. For all LDAP operations other than search, only one message is
returned. For the search operation, a list of result messages can be returned.
.SS "Handling Errors and Parsing Results"
-.sp
.LP
Use the \fBldap_parse_result\fR(3LDAP),
\fBldap_parse_sasl_bind_result\fR(3LDAP), and the
\fBldap_parse_extended_result\fR(3LDAP) functions to extract required
-information from results and and to handle the returned errors. To covert a
+information from results and to handle the returned errors. To convert a
numeric error code into a null-terminated character string message describing
the error, use \fBldap_err2string\fR(3LDAP). The \fBldap_result2error\fR(3LDAP)
and \fBldap_perror\fR(3LDAP) functions are deprecated. To step through the list
@@ -129,26 +121,22 @@ returns an array of an attribute's string values that matches a specified
language subtype. To retrieve the binary data from an attribute, call the
\fBldap_get_lang_values_len()\fR function instead.
.SS "Uniform Resource Locators (URLS)"
-.sp
.LP
You can use the \fBldap_url\fR(3LDAP)functions to test a URL to verify that it
is an LDAP URL, to parse LDAP URLs into their component pieces, to initiate
searches directly using an LDAP URL, and to retrieve the URL associated with a
DNS domain name or a distinguished name.
.SS "User Friendly Naming"
-.sp
.LP
The \fBldap_ufn\fR(3LDAP) functions implement a user friendly naming scheme by
means of LDAP. This scheme allows you to look up entries using fuzzy, untyped
names like "mark smith, umich, us".
.SS "Caching"
-.sp
.LP
The \fBldap_memcache\fR(3LDAP) functions provide an in-memory client side cache
to store search requests. Caching improves performance and reduces network
bandwidth when a client makes repeated requests.
.SS "Utility Functions"
-.sp
.LP
There are also various utility functions. You can use the
\fBldap_sort\fR(3LDAP) functions are used to sort the entries and values
@@ -158,7 +146,6 @@ longer "friendlier" names. Use the \fBldap_charset\fR(3LDAP) functions to
translate to and from the T.61 character set that is used for many character
strings in the LDAP protocol.
.SS "Generating Filters"
-.sp
.LP
Make calls to \fBldap_init_getfilter\fR(3LDAP) and \fBldap_search\fR(3LDAP) to
generate filters to be used in \fBldap_search\fR(3LDAP) and
@@ -168,7 +155,6 @@ generate filters to be used in \fBldap_search\fR(3LDAP) and
\fIbuf\fR of length \fIbuflen\fR. \fBldap_getfilter_free\fR(3LDAP) frees memory
that has been allocated by means of \fBldap_init_getfilter()\fR.
.SS "BER Library"
-.sp
.LP
The LDAP package includes a set of lightweight Basic Encoding Rules ("BER)"
functions. The LDAP library functions use the BER functions to encode and
@@ -177,7 +163,6 @@ LDAP. They are not normally used directly by an LDAP application program will
not normally use the BER functions directly. Instead, these functions provide a
\fBprintf()\fR and \fBscanf()\fR-like interface, as well as lower-level access.
.SH LIST OF INTERFACES
-.sp
.ne 2
.na
\fB\fBldap_open\fR(3LDAP)\fR
@@ -1589,7 +1574,6 @@ Free memory allocated by LDAP API functions.
.RE
.SH ATTRIBUTES
-.sp
.LP
See \fBattributes\fR(5) for a description of the following attributes:
.sp
@@ -1605,6 +1589,5 @@ Stability Level Evolving
.TE
.SH SEE ALSO
-.sp
.LP
\fBattributes\fR(5)
diff --git a/usr/src/man/man3ldap/ldap_abandon.3ldap b/usr/src/man/man3ldap/ldap_abandon.3ldap
index 18242ca6a1..2a5d87bd08 100644
--- a/usr/src/man/man3ldap/ldap_abandon.3ldap
+++ b/usr/src/man/man3ldap/ldap_abandon.3ldap
@@ -4,7 +4,7 @@
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH LDAP_ABANDON 3LDAP "Jan 27, 2002"
+.TH LDAP_ABANDON 3LDAP "April 9, 2016"
.SH NAME
ldap_abandon \- abandon an LDAP operation in progress
.SH SYNOPSIS
@@ -18,7 +18,6 @@ cc[ \fIflag\fR... ] \fIfile\fR... -lldap[ \fIlibrary\fR... ]
.fi
.SH DESCRIPTION
-.sp
.LP
The \fBldap_abandon()\fR function is used to abandon or cancel an LDAP
operation in progress. The \fImsgid\fR passed should be the message id of an
@@ -28,18 +27,16 @@ outstanding LDAP operation, as returned by \fBldap_search\fR(3LDAP),
.LP
\fBldap_abandon\fR(\|) checks to see if the result of the operation has already
come in. If it has, it deletes it from the queue of pending messages. If not,
-it sends an LDAP abandon operation to the the LDAP server.
+it sends an LDAP abandon operation to the LDAP server.
.sp
.LP
The caller can expect that the result of an abandoned operation will not be
returned from a future call to \fBldap_result\fR(3LDAP).
.SH ERRORS
-.sp
.LP
\fBldap_abandon()\fR returns \fB0\fR if successful or \fB\(mi1\fRotherwise and
setting \fIld_errno\fR appropriately. See \fBldap_error\fR(3LDAP) for details.
.SH ATTRIBUTES
-.sp
.LP
See \fBattributes\fR(5) for a description of the following attributes:
.sp
@@ -54,7 +51,6 @@ Interface Stability Evolving
.TE
.SH SEE ALSO
-.sp
.LP
\fBldap\fR(3LDAP), \fBldap_result\fR(3LDAP), \fBldap_error\fR(3LDAP),
\fBattributes\fR(5)
diff --git a/usr/src/man/man3ldap/ldap_memcache.3ldap b/usr/src/man/man3ldap/ldap_memcache.3ldap
index b493d30377..8a72c74c0e 100644
--- a/usr/src/man/man3ldap/ldap_memcache.3ldap
+++ b/usr/src/man/man3ldap/ldap_memcache.3ldap
@@ -4,7 +4,7 @@
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH LDAP_MEMCACHE 3LDAP "Jan 6, 2003"
+.TH LDAP_MEMCACHE 3LDAP "April 9, 2016"
.SH NAME
ldap_memcache, ldap_memcache_init, ldap_memcache_set, ldap_memcache_get,
ldap_memcache_flush, ldap_memcache_destroy, ldap_memcache_update \- LDAP client
@@ -46,7 +46,6 @@ caching functions
.fi
.SH DESCRIPTION
-.sp
.LP
Use the \fBldap_memcache\fR functions to maintain an in-memory client side
cache to store search requests. Caching improves performance and reduces
@@ -61,7 +60,7 @@ Make a call to \fBldap_memcache_init()\fR to create the in-memory client side
\fIcache\fR. The function passes back a pointer to an \fBLDAPMemCache\fR
structure, which represents the \fIcache\fR. Make a call to the
\fBldap_memcache_set()\fR function to associate this \fIcache\fR with an LDAP
-connection handle, an LDAP structure. \fIttl\fR is the the maximum amount of
+connection handle, an LDAP structure. \fIttl\fR is the maximum amount of
time (in seconds) that an item can be cached. If a \fIttl\fR value of 0 is
passed, there is no limit to the amount of time that an item can be cached.
\fIsize\fR is the maximum amount of memory (in bytes) that the cache will
@@ -132,7 +131,6 @@ update the \fIcache\fR at this point in time. This function is only useful in
a multithreaded application, since it will not return until the \fIcache\fR is
destroyed.
.SH PARAMETERS
-.sp
.ne 2
.na
\fB\fIttl\fR\fR
@@ -215,13 +213,11 @@ The search requests that you want flushed from the \fIcache\fR
.RE
.SH ERRORS
-.sp
.LP
The functions that have \fBint\fR return values return \fBLDAP_SUCCESS\fR if
the operation was successful. Otherwise, they return another LDAP error code.
See \fBldap_error\fR(3LDAP) for a list of the LDAP error codes.
.SH ATTRIBUTES
-.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
@@ -237,7 +233,6 @@ Interface Stability Evolving
.TE
.SH SEE ALSO
-.sp
.LP
\fBldap_error\fR(3LDAP), \fBldap_open\fR(3LDAP), \fBldap_search\fR(3LDAP),
\fBattributes\fR(5)