]> git.sur5r.net Git - openldap/blobdiff - doc/man/man3/ldap_search.3
Update copyright statements
[openldap] / doc / man / man3 / ldap_search.3
index 55bd5dba9aa916ff8aa80060633157c4ff508f6a..94a098c58d7a61cba117646a1df7550d3426d618 100644 (file)
@@ -1,11 +1,13 @@
-.TH LDAP_SEARCH 3 "22 September 1998" "OpenLDAP LDVERSION"
+.TH LDAP_SEARCH 3 "25 July 1999" "OpenLDAP LDVERSION"
+.\" $OpenLDAP$
+.\" Copyright 1998-2002 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 SYNOPSIS
 .nf
 .ft B
 #include <sys/time.h> /* for struct timeval definition */
-#include <lber.h>
 #include <ldap.h>
 .LP
 .ft B
@@ -73,7 +75,7 @@ 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
@@ -81,14 +83,22 @@ 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
+character.  See RFC 2254 for a more complete description of allowable
 filters.  See
 .BR ldap_getfilter (3)
 for routines to help in constructing search filters automatically.
 .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.  \fIAttrsonly\fP should be set to 1 if
+from entries that match \fIfilter\fP.
+If NULL is specified, all attributes will be returned.
+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
+all operational attributes to be returned.
+To request no attributes, the type "1.1" (LDAP_NO_ATTRS)
+should be listed by itself.
+.LP
+\fIAttrsonly\fP should be set to 1 if
 only attribute types are wanted.  It should be set to 0 if both
 attributes types and attribute values are wanted.
 .SH ERRORS