X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Fman%2Fman1%2Fldapsearch.1;h=66bd726ed7f3724d661bad588e889dcef9f71fc3;hb=dac408369b0812762b3e85f7e024ea472ce79abc;hp=df4cf7227d83015b04be3f5337de4ba515d7ce55;hpb=2e39dd74b87ba597848d21f0c251bfc2f3f87141;p=openldap diff --git a/doc/man/man1/ldapsearch.1 b/doc/man/man1/ldapsearch.1 index df4cf7227d..66bd726ed7 100644 --- a/doc/man/man1/ldapsearch.1 +++ b/doc/man/man1/ldapsearch.1 @@ -1,6 +1,6 @@ .TH LDAPSEARCH 1 "RELEASEDATE" "OpenLDAP LDVERSION" .\" $OpenLDAP$ -.\" Copyright 1998-2005 The OpenLDAP Foundation All Rights Reserved. +.\" Copyright 1998-2011 The OpenLDAP Foundation All Rights Reserved. .\" Copying restrictions apply. See COPYRIGHT/LICENSE. .SH NAME ldapsearch \- LDAP search tool @@ -9,22 +9,32 @@ ldapsearch \- LDAP search tool [\c .BR \-n ] [\c +.BR \-c ] +[\c .BR \-u ] [\c .BR \-v ] [\c -.BR \-t ] +.BR \-t [ t ]] +[\c +.BI \-T \ path\fR] +[\c +.BI \-F \ prefix\fR] [\c .BR \-A ] [\c -.BR \-L[L[L]] ] +.BR \-L [ L [ L ]]] +[\c +.BR \-M [ M ]] [\c -.BR \-M[M] ] +.BI \-S \ attribute\fR] [\c .BI \-d \ debuglevel\fR] [\c .BI \-f \ file\fR] [\c +.BR \-x ] +[\c .BI \-D \ binddn\fR] [\c .BR \-W ] @@ -39,19 +49,23 @@ ldapsearch \- LDAP search tool [\c .BI \-p \ ldapport\fR] [\c -.BI \-P \ 2\fR\||\|\fI3\fR] -[\c .BI \-b \ searchbase\fR] [\c -.BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR] +.BR \-s \ { base \||\| one \||\| sub \||\| children }] +[\c +.BR \-a \ { never \||\| always \||\| search \||\| find }] [\c -.BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind\fR] +.BR \-P \ { 2 \||\| 3 }] +[\c +.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]] +[\c +.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]] [\c .BI \-l \ timelimit\fR] [\c .BI \-z \ sizelimit\fR] [\c -.BR \-O \ security-properties ] +.BI \-O \ security-properties\fR] [\c .BR \-I ] [\c @@ -61,39 +75,46 @@ ldapsearch \- LDAP search tool [\c .BI \-R \ realm\fR] [\c -.BR \-x ] -[\c .BI \-X \ authzid\fR] [\c .BI \-Y \ mech\fR] [\c -.BR \-Z[Z] ] +.BR \-Z [ Z ]] .I filter [\c .IR attrs... ] .SH DESCRIPTION .I ldapsearch is a shell-accessible interface to the -.BR ldap_search (3) +.BR ldap_search_ext (3) library call. .LP .B ldapsearch opens a connection to an LDAP server, binds, and performs a search using specified parameters. The \fIfilter\fP should conform to -the string representation for search filters as defined in RFC 2254. -If not provided, the default filter, (objectClass=*), is used. +the string representation for search filters as defined in RFC 4515. +If not provided, the default filter, \fB(objectClass=*)\fP, is used. .LP If -.B ldapsearch finds one or more entries, the attributes specified by -\fIattrs\fP are returned. If * is listed, all user attributes are -returned. If + is listed, all operational attributes are returned. +.B ldapsearch +finds one or more entries, the attributes specified by +\fIattrs\fP are returned. If \fB*\fP is listed, all user attributes are +returned. If \fB+\fP is listed, all operational attributes are returned. If no \fIattrs\fP are listed, all user attributes are returned. If only 1.1 is listed, no attributes will be returned. +.LP +The search results are displayed using an extended version of LDIF. +Option \fI\-L\fP controls the format of the output. .SH OPTIONS .TP .B \-n Show what would be done, but don't actually perform the search. Useful for -debugging in conjunction with -v. +debugging in conjunction with \fB\-v\fP. +.TP +.B \-c +Continuous operation mode. Errors are reported, but ldapsearch will continue +with searches. The default is to exit after reporting an error. Only useful +in conjunction with \fB\-f\fP. .TP .B \-u Include the User Friendly Name form of the Distinguished Name (DN) @@ -102,10 +123,19 @@ in the output. .B \-v Run in verbose mode, with many diagnostics written to standard output. .TP -.B \-t -Write retrieved non-printable values to a set of temporary files. This -is useful for dealing with values containing non-character data such as -jpegPhoto or audio. +.BR \-t [ t ] +A single \fB\-t\fP writes retrieved non-printable values to a set of temporary +files. This is useful for dealing with values containing non-character +data such as jpegPhoto or audio. A second \fB\-t\fP writes all retrieved values to +files. +.TP +.BI \-T \ path +Write temporary files to directory specified by \fIpath\fP (default: +\fB/var/tmp/\fP) +.TP +.BI \-F \ prefix +URL prefix for temporary files. Default is \fBfile://\fIpath\fP where +\fIpath\fP is \fB/var/tmp/\fP or specified with \fB\-T\fP. .TP .B \-A Retrieve attributes only (no values). This is useful when you just want to @@ -115,12 +145,12 @@ specific values. .B \-L Search results are display in LDAP Data Interchange Format detailed in .BR ldif (5). -A single -L restricts the output to LDIFv1. -A second -L disables comments. -A third -L disables printing of the LDIF version. +A single \fB\-L\fP restricts the output to LDIFv1. + A second \fB\-L\fP disables comments. +A third \fB\-L\fP disables printing of the LDIF version. The default is to use an extended version of LDIF. .TP -.B \-M[M] +.BR \-M [ M ] Enable manage DSA IT control. .B \-MM makes control critical. @@ -128,12 +158,11 @@ makes control critical. .BI \-S \ attribute Sort the entries returned based on \fIattribute\fP. The default is not to sort entries returned. If \fIattribute\fP is a zero-length string (""), -the entries are sorted by the components of their Distingished Name. See +the entries are sorted by the components of their Distinguished Name. See .BR ldap_sort (3) for more details. Note that .B ldapsearch -normally prints out entries as it receives them. The use of the -.B \-S +normally prints out entries as it receives them. The use of the \fB\-S\fP option defeats this behavior, causing all entries to be retrieved, then sorted, then printed. .TP @@ -145,15 +174,23 @@ must be compiled with LDAP_DEBUG defined for this option to have any effect. .BI \-f \ file Read a series of lines from \fIfile\fP, performing one LDAP search for each line. In this case, the \fIfilter\fP given on the command line -is treated as a pattern where the first occurrence of \fB%s\fP is -replaced with a line from \fIfile\fP. If \fIfile\fP is a single \fI-\fP -character, then the lines are read from standard input. +is treated as a pattern where the first and only occurrence of \fB%s\fP +is replaced with a line from \fIfile\fP. Any other occurrence of the +the \fB%\fP character in the pattern will be regarded as an error. +Where it is desired that the search filter include a \fB%\fP character, +the character should be encoded as \fB\\25\fP (see RFC 4515). +If \fIfile\fP is a single +\fB\-\fP character, then the lines are read from standard input. +.B ldapsearch +will exit when the first non-successful search result is returned, +unless \fB\-c\fP is used. .TP .B \-x Use simple authentication instead of SASL. .TP .BI \-D \ binddn Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory. +For SASL binds, the server is expected to ignore this value. .TP .B \-W Prompt for simple authentication. @@ -167,46 +204,95 @@ Use complete contents of \fIpasswdfile\fP as the password for simple authentication. .TP .BI \-H \ ldapuri -Specify URI(s) referring to the ldap server(s); only the protocol/host/port -fields are allowed; a list of URI, separated by whitespace or commas -is expected. +Specify URI(s) referring to the ldap server(s); +a list of URI, separated by whitespace or commas is expected; +only the protocol/host/port fields are allowed. +As an exception, if no host/port is specified, but a DN is, +the DN is used to look up the corresponding host(s) using the +DNS SRV records, according to RFC 2782. The DN must be a non-empty +sequence of AVAs whose attribute type is "dc" (domain component), +and must be escaped according to RFC 2396. .TP .BI \-h \ ldaphost Specify an alternate host on which the ldap server is running. -Deprecated in favor of -H. +Deprecated in favor of \fB\-H\fP. .TP .BI \-p \ ldapport Specify an alternate TCP port where the ldap server is listening. -Deprecated in favor of -H. +Deprecated in favor of \fB\-H\fP. .TP .BI \-b \ searchbase Use \fIsearchbase\fP as the starting point for the search instead of the default. .TP -.BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub +.BR \-s \ { base \||\| one \||\| sub \||\| children } Specify the scope of the search to be one of -.IR base , -.IR one , +.BR base , +.BR one , +.BR sub , or -.I sub -to specify a base object, one-level, or subtree search. The default -is -.IR sub . -.TP -.BI \-a \ never\fR\||\|\fIalways\fR\||\|\fIsearch\fR\||\|\fIfind +.B children +to specify a base object, one-level, subtree, or children search. +The default is +.BR sub . +Note: +.I children +scope requires LDAPv3 subordinate feature extension. +.TP +.BR \-a \ { never \||\| always \||\| search \||\| find } Specify how aliases dereferencing is done. Should be one of -.IR never , -.IR always , -.IR search , +.BR never , +.BR always , +.BR search , or -.I find +.B find to specify that aliases are never dereferenced, always dereferenced, dereferenced when searching, or dereferenced only when locating the base object for the search. The default is to never dereference aliases. .TP -.BI \-P \ 2\fR\||\|\fI3 +.BR \-P \ { 2 \||\| 3 } Specify the LDAP protocol version to use. .TP +.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ] +.TP +.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ] + +Specify general extensions with \fB\-e\fP and search extensions with \fB\-E\fP. +\'\fB!\fP\' indicates criticality. + +General extensions: +.nf + [!]assert= (an RFC 4515 Filter) + !authzid= ("dn:" or "u:") + [!]bauthzid (RFC 3829 authzid control) + [!]chaining[=[/]] + [!]manageDSAit + [!]noop + ppolicy + [!]postread[=] (a comma-separated attribute list) + [!]preread[=] (a comma-separated attribute list) + [!]relax + sessiontracking[=] + abandon,cancel,ignore (SIGINT sends abandon/cancel, + or ignores response; if critical, doesn't wait for SIGINT. + not really controls) +.fi + +Search extensions: +.nf + !dontUseCopy + [!]domainScope (domain scope) + [!]mv= (matched values filter) + [!]pr=[/prompt|noprompt] (paged results/prompt) + [!]sss=[\-][/[\-]...] (server side sorting) + [!]subentries[=true|false] (subentries) + [!]sync=ro[/] (LDAP Sync refreshOnly) + rp[/][/] (LDAP Sync refreshAndPersist) + [!]vlv=/(//|:) (virtual list view) + [!]deref=derefAttr:attr[,attr[...]][;derefAttr:attr[,attr[...]]] + [!][=] +.fi +.TP .BI \-l \ timelimit wait at most \fItimelimit\fP seconds for a search to complete. A timelimit of @@ -255,20 +341,17 @@ depends on the actual SASL mechanism used. Specify the requested authorization ID for SASL bind. .I authzid must be one of the following formats: -.B dn:\c -.I +.BI dn: "" or -.B u:\c -.I +.BI u: .TP .BI \-Y \ mech Specify the SASL mechanism to be used for authentication. If it's not specified, the program will choose the best mechanism the server knows. .TP -.B \-Z[Z] +.BR \-Z [ Z ] Issue StartTLS (Transport Layer Security) extended operation. If you use -.B \-ZZ\c -, the command will require the operation to be successful. +\fB\-ZZ\fP, the command will require the operation to be successful. .SH OUTPUT FORMAT If one or more entries are found, each entry is written to standard output in LDAP Data Interchange Format or @@ -287,14 +370,14 @@ output in LDAP Data Interchange Format or ... .fi .LP -If the -t option is used, the URI of a temporary file -is used in place of the actual value. If the -A option +If the \fB\-t\fP option is used, the URI of a temporary file +is used in place of the actual value. If the \fB\-A\fP option is given, only the "attributename" part is written. .SH EXAMPLE The following command: .LP .nf - ldapsearch -LLL "(sn=smith)" cn sn telephoneNumber + ldapsearch \-LLL "(sn=smith)" cn sn telephoneNumber .fi .LP will perform a subtree search (using the default search base and @@ -310,23 +393,23 @@ The output might look something like this if two entries are found: cn: John Smith cn: John T. Smith sn: Smith - sn;lang-en: Smith - sn;lang-de: Schmidt - telephoneNumber: 1 555 123-4567 + sn;lang\-en: Smith + sn;lang\-de: Schmidt + telephoneNumber: 1 555 123\-4567 dn: uid=sss,dc=example,dc=com cn: Steve Smith cn: Steve S. Smith sn: Smith - sn;lang-en: Smith - sn;lang-de: Schmidt - telephoneNumber: 1 555 765-4321 + sn;lang\-en: Smith + sn;lang\-de: Schmidt + telephoneNumber: 1 555 765\-4321 .fi .LP The command: .LP .nf - ldapsearch -LLL -u -t "(uid=xyz)" jpegPhoto audio + ldapsearch \-LLL \-u \-t "(uid=xyz)" jpegPhoto audio .fi .LP will perform a subtree search using the default search base for entries @@ -339,14 +422,14 @@ requested attributes is found: .nf dn: uid=xyz,dc=example,dc=com ufn: xyz, example, com - audio:< file:///tmp/ldapsearch-audio-a19924 - jpegPhoto:< file:///tmp/ldapsearch-jpegPhoto-a19924 + audio:< file:///tmp/ldapsearch\-audio\-a19924 + jpegPhoto:< file:///tmp/ldapsearch\-jpegPhoto\-a19924 .fi .LP This command: .LP .nf - ldapsearch -LLL -s one -b "c=US" "(o=University*)" o description + ldapsearch \-LLL \-s one \-b "c=US" "(o=University*)" o description .fi .LP will perform a one-level search at the c=US level for all entries @@ -369,7 +452,7 @@ and printed to standard output, resulting in output similar to this: o: University of Colorado at Denver o: UCD o: CU/Denver - o: CU-Denver + o: CU\-Denver description: Institute for Higher Learning and Research dn: o=University of Florida,c=US @@ -391,11 +474,9 @@ a diagnostic message being written to standard error. .BR ldap.conf (5), .BR ldif (5), .BR ldap (3), -.BR ldap_search (3) +.BR ldap_search_ext (3), +.BR ldap_sort (3) .SH AUTHOR The OpenLDAP Project .SH ACKNOWLEDGEMENTS -.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. +.so ../Project