Happy New Year!

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

diff --git a/doc/man/man3/ldap_search.3 b/doc/man/man3/ldap_search.3
index a008db650fad6d76fe83930584f19a43045a49a9..dcdd07ad84fb8ca78b230b1669ac084e119711fd 100644 (file)
--- a/doc/man/man3/ldap_search.3
+++ b/doc/man/man3/ldap_search.3
@@ -1,9 +1,11 @@
-.TH LDAP_SEARCH 3 "25 July 1999" "OpenLDAP LDVERSION"
+.TH LDAP_SEARCH 3 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
-.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2005 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ldap_search, ldap_search_s, ldap_search_st \- Perform an LDAP search operation
+.SH LIBRARY
+OpenLDAP LDAP (libldap, -lldap)
 .SH SYNOPSIS
 .nf
 .ft B
@@ -58,7 +60,7 @@ or LDAP_SCOPE_SUBTREE, to search the object and all its descendents.
 .LP
 \fIFilter\fP is a string
 representation of the filter to apply in the search.  Simple filters
-can be specified as \fIattributetype=attributevalue\fP.  More complex
+can be specified as \fI(attributetype=attributevalue)\fP.  More complex
 filters are specified using a prefix notation according to the following
 BNF:
 .LP
@@ -75,22 +77,20 @@ BNF:
 .LP
 The '~=' construct is used to specify approximate matching.  The
 representation for <attributetype> and <attributevalue> are as
-described in RFC 1778.  In addition, <attributevalue> can be a single *
+described in RFC 2254.  In addition, <attributevalue> can be a single *
 to achieve an attribute existence test, or can contain text and *'s
 interspersed to achieve substring matching.
 .LP
-For example, the filter "mail=*" will find any entries that have a mail
-attribute.  The filter "mail=*@terminator.rs.itd.umich.edu" will find
+For example, the filter "(mail=*)" will find any entries that have a mail
+attribute.  The filter "(mail=*@terminator.rs.itd.umich.edu)" will find
 any entries that have a mail attribute ending in the specified string.
 To put parentheses in a filter, escape them with a backslash '\\'
-character.  See RFC 1588 for a more complete description of allowable
-filters.  See
-.BR ldap_getfilter (3)
-for routines to help in constructing search filters automatically.
+character.  See RFC 2254 for a more complete description of allowable
+filters. 
 .LP
 \fIAttrs\fP is a null-terminated array of attribute types to return
 from entries that match \fIfilter\fP.
-If NULL is specified, all attributes will be returned.
+If NULL is specified, the return of all user attributes is requested.
 The type "*" (LDAP_ALL_USER_ATTRIBUTES) may be used to request
 all user attributes to be returned.
 The type "+"(LDAP_ALL_OPERATIONAL_ATTRIBUTES) may be used to request
@@ -114,20 +114,19 @@ returns -1 in case of trouble.
 .SH NOTES
 Note that both read
 and list functionality are subsumed by these routines,
-by using a filter like "objectclass=*" and a scope of LDAP_SCOPE_BASE (to
+by using a filter like "(objectclass=*)" and a scope of LDAP_SCOPE_BASE (to
 emulate read) or LDAP_SCOPE_ONELEVEL (to emulate list).
 .LP
 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>.
+routines.  Return values are contained in <ldap.h>.
 .SH SEE ALSO
 .BR ldap (3),
 .BR ldap_result (3),
 .BR ldap_getfilter (3),
 .BR ldap_error (3)
 .SH ACKNOWLEDGEMENTS
-.B     OpenLDAP
+.B OpenLDAP
 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
-.B     OpenLDAP
+.B OpenLDAP
 is derived from University of Michigan LDAP 3.3 Release.