Merge remote branch 'origin/mdb.master'

[openldap] / doc / man / man3 / ldap_search.3

diff --git a/doc/man/man3/ldap_search.3 b/doc/man/man3/ldap_search.3
index abbdc6e6a68f684dd0f1873a76c6ab473298a32b..a346a07a2f2e607ff5172c94c516c4b796db4eb2 100644 (file)
--- a/doc/man/man3/ldap_search.3
+++ b/doc/man/man3/ldap_search.3
@@ -1,11 +1,11 @@
 .TH LDAP_SEARCH 3 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
-.\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2012 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ldap_search, ldap_search_s, ldap_search_st, ldap_search_ext, ldap_search_ext_s \- Perform an LDAP search operation
 .SH LIBRARY
-OpenLDAP LDAP (libldap, -lldap)
+OpenLDAP LDAP (libldap, \-lldap)
 .SH SYNOPSIS
 .nf
 .ft B
@@ -24,7 +24,8 @@ int \fIattrsonly\fB,
 LDAPControl **\fIserverctrls\fB,
 LDAPControl **\fIclientctrls\fB,
 struct timeval *\fItimeout\fB,
-int sizelimit, *\fImsgidp\fB );
+int \fIsizelimit\fB,
+int *\fImsgidp\fB );
 .RE
 .LP
 .ft B
@@ -39,6 +40,7 @@ int \fIattrsonly\fB,
 LDAPControl **\fIserverctrls\fB,
 LDAPControl **\fIclientctrls\fB,
 struct timeval *\fItimeout\fB,
+int \fIsizelimit\fB,
 LDAPMessage **\fIres\fB );
 .RE
 .SH DESCRIPTION
@@ -81,7 +83,7 @@ The description "*" (LDAP_ALL_USER_ATTRIBUTES) may be used to request
 all user attributes to be returned.
 The description "+"(LDAP_ALL_OPERATIONAL_ATTRIBUTES) may be used to
 request all operational attributes to be returned.  Note that this
-requires the server to suppor the LDAP All Operational Attribute
+requires the server to support the LDAP All Operational Attribute
 extension.
 To request no attributes, the description "1.1" (LDAP_NO_ATTRS)
 should be listed by itself.
@@ -112,6 +114,14 @@ emulate read) or LDAP_SCOPE_ONELEVEL (to emulate list).
 These routines may dynamically allocate memory. The caller is
 responsible for freeing such memory using supplied deallocation
 routines. Return values are contained in <ldap.h>.
+.LP
+Note that \fIres\fR parameter of
+.B ldap_search_ext_s()
+and
+.B ldap_search_s()
+should be freed with
+.B ldap_msgfree()
+regardless of return value of these functions.
 .SH DEPRECATED INTERFACES
 The 
 .B ldap_search()