X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Fman%2Fman1%2Fldapsearch.1;h=444bcc045be9a08b34c520807c9a2457af9ce6a5;hb=9ed5ca4f7a3e807fe3d105c34738095b0e891f5d;hp=66bd726ed7f3724d661bad588e889dcef9f71fc3;hpb=dac408369b0812762b3e85f7e024ea472ce79abc;p=openldap diff --git a/doc/man/man1/ldapsearch.1 b/doc/man/man1/ldapsearch.1 index 66bd726ed7..444bcc045b 100644 --- a/doc/man/man1/ldapsearch.1 +++ b/doc/man/man1/ldapsearch.1 @@ -1,20 +1,24 @@ .TH LDAPSEARCH 1 "RELEASEDATE" "OpenLDAP LDVERSION" .\" $OpenLDAP$ -.\" Copyright 1998-2011 The OpenLDAP Foundation All Rights Reserved. +.\" Copyright 1998-2012 The OpenLDAP Foundation All Rights Reserved. .\" Copying restrictions apply. See COPYRIGHT/LICENSE. .SH NAME ldapsearch \- LDAP search tool .SH SYNOPSIS .B ldapsearch [\c +.BR \-V [ V ]] +[\c +.BI \-d \ debuglevel\fR] +[\c .BR \-n ] [\c +.BR \-v ] +[\c .BR \-c ] [\c .BR \-u ] [\c -.BR \-v ] -[\c .BR \-t [ t ]] [\c .BI \-T \ path\fR] @@ -25,14 +29,22 @@ ldapsearch \- LDAP search tool [\c .BR \-L [ L [ L ]]] [\c -.BR \-M [ M ]] -[\c .BI \-S \ attribute\fR] [\c -.BI \-d \ debuglevel\fR] +.BI \-b \ searchbase\fR] +[\c +.BR \-s \ { base \||\| one \||\| sub \||\| children }] +[\c +.BR \-a \ { never \||\| always \||\| search \||\| find }] +[\c +.BI \-l \ timelimit\fR] +[\c +.BI \-z \ sizelimit\fR] [\c .BI \-f \ file\fR] [\c +.BR \-M [ M ]] +[\c .BR \-x ] [\c .BI \-D \ binddn\fR] @@ -49,21 +61,13 @@ ldapsearch \- LDAP search tool [\c .BI \-p \ ldapport\fR] [\c -.BI \-b \ searchbase\fR] -[\c -.BR \-s \ { base \||\| one \||\| sub \||\| children }] -[\c -.BR \-a \ { never \||\| always \||\| search \||\| find }] -[\c .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] +.BI \-o \ opt \fR[= optparam \fR]] [\c .BI \-O \ security-properties\fR] [\c @@ -71,6 +75,8 @@ ldapsearch \- LDAP search tool [\c .BR \-Q ] [\c +.BR \-N ] +[\c .BI \-U \ authcid\fR] [\c .BI \-R \ realm\fR] @@ -107,10 +113,22 @@ The search results are displayed using an extended version of LDIF. Option \fI\-L\fP controls the format of the output. .SH OPTIONS .TP +.BR \-V [ V ] +Print version info. +If \fB\-VV\fP is given, only the version information is printed. +.TP +.BI \-d \ debuglevel +Set the LDAP debugging level to \fIdebuglevel\fP. +.B ldapsearch +must be compiled with LDAP_DEBUG defined for this option to have any effect. +.TP .B \-n Show what would be done, but don't actually perform the search. Useful for debugging in conjunction with \fB\-v\fP. .TP +.B \-v +Run in verbose mode, with many diagnostics written to standard output. +.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 @@ -120,9 +138,6 @@ in conjunction with \fB\-f\fP. Include the User Friendly Name form of the Distinguished Name (DN) in the output. .TP -.B \-v -Run in verbose mode, with many diagnostics written to standard output. -.TP .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 @@ -150,11 +165,6 @@ A single \fB\-L\fP restricts the output to LDIFv1. A third \fB\-L\fP disables printing of the LDIF version. The default is to use an extended version of LDIF. .TP -.BR \-M [ M ] -Enable manage DSA IT control. -.B \-MM -makes control critical. -.TP .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 (""), @@ -166,10 +176,60 @@ 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 -.BI \-d \ debuglevel -Set the LDAP debugging level to \fIdebuglevel\fP. -.B ldapsearch -must be compiled with LDAP_DEBUG defined for this option to have any effect. +.BI \-b \ searchbase +Use \fIsearchbase\fP as the starting point for the search instead of +the default. +.TP +.BR \-s \ { base \||\| one \||\| sub \||\| children } +Specify the scope of the search to be one of +.BR base , +.BR one , +.BR sub , +or +.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 +.BR never , +.BR always , +.BR search , +or +.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 \-l \ timelimit +wait at most \fItimelimit\fP seconds for a search to complete. +A timelimit of +.I 0 +(zero) or +.I none +means no limit. +A timelimit of +.I max +means the maximum integer allowable by the protocol. +A server may impose a maximal timelimit which only +the root user may override. +.TP +.BI \-z \ sizelimit +retrieve at most \fIsizelimit\fP entries for a search. +A sizelimit of +.I 0 +(zero) or +.I none +means no limit. +A sizelimit of +.I max +means the maximum integer allowable by the protocol. +A server may impose a maximal sizelimit which only +the root user may override. .TP .BI \-f \ file Read a series of lines from \fIfile\fP, performing one LDAP search for @@ -185,6 +245,11 @@ If \fIfile\fP is a single will exit when the first non-successful search result is returned, unless \fB\-c\fP is used. .TP +.BR \-M [ M ] +Enable manage DSA IT control. +.B \-MM +makes control critical. +.TP .B \-x Use simple authentication instead of SASL. .TP @@ -221,35 +286,6 @@ Deprecated in favor of \fB\-H\fP. Specify an alternate TCP port where the ldap server is listening. 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 -.BR \-s \ { base \||\| one \||\| sub \||\| children } -Specify the scope of the search to be one of -.BR base , -.BR one , -.BR sub , -or -.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 -.BR never , -.BR always , -.BR search , -or -.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 .BR \-P \ { 2 \||\| 3 } Specify the LDAP protocol version to use. .TP @@ -293,31 +329,15 @@ Search extensions: [!][=] .fi .TP -.BI \-l \ timelimit -wait at most \fItimelimit\fP seconds for a search to complete. -A timelimit of -.I 0 -(zero) or -.I none -means no limit. -A timelimit of -.I max -means the maximum integer allowable by the protocol. -A server may impose a maximal timelimit which only -the root user may override. -.TP -.BI \-z \ sizelimit -retrieve at most \fIsizelimit\fP entries for a search. -A sizelimit of -.I 0 -(zero) or -.I none -means no limit. -A sizelimit of -.I max -means the maximum integer allowable by the protocol. -A server may impose a maximal sizelimit which only -the root user may override. +.BI \-o \ opt \fR[= optparam \fR] + +Specify general options. + +General options: +.nf + nettimeout= (in seconds, or "none" or "max") + ldif-wrap= (in columns, or "no" for no wrapping) +.fi .TP .BI \-O \ security-properties Specify SASL security properties. @@ -329,6 +349,9 @@ only as needed. .B \-Q Enable SASL Quiet mode. Never prompt. .TP +.B \-N +Do not use reverse DNS to canonicalize SASL host name. +.TP .BI \-U \ authcid Specify the authentication ID for SASL bind. The form of the ID depends on the actual SASL mechanism used.