summaryrefslogtreecommitdiff
path: root/usr/src/man/man1/ldapsearch.1
diff options
context:
space:
mode:
Diffstat (limited to 'usr/src/man/man1/ldapsearch.1')
-rw-r--r--usr/src/man/man1/ldapsearch.198
1 files changed, 14 insertions, 84 deletions
diff --git a/usr/src/man/man1/ldapsearch.1 b/usr/src/man/man1/ldapsearch.1
index 2029dd14be..b7856ceb3b 100644
--- a/usr/src/man/man1/ldapsearch.1
+++ b/usr/src/man/man1/ldapsearch.1
@@ -4,20 +4,20 @@
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH ldapsearch 1 "6 Jan 2006" "SunOS 5.11" "User Commands"
+.TH LDAPSEARCH 1 "Jan 6, 2006"
.SH NAME
ldapsearch \- ldap search tool
.SH SYNOPSIS
.LP
.nf
-\fBldapsearch\fR [\fB-n\fR] [\fB-u\fR] [\fB-v\fR] [\fB-t\fR] [\fB-A\fR] [\fB-B\fR] [\fB-L\fR] [\fB-R\fR] [\fB-H\fR]
- [\fB-?\fR] [\fB-t\fR] [\fB-T\fR] [\fB-B\fR] [\fB-E\fR] [\fB-J\fR] [\fB-e\fR] [\fB-l\fR] [\fB-Z\fR] [\fB-r\fR]
- [\fB-M\fR] [\fB-d\fR \fIdebuglevel\fR] [\fB-F\fR \fIsep\fR] [\fB-f\fR \fIfile\fR] [\fB-D\fR \fIbindDN\fR]
- [\fB-j\fR \fIfilename\fR] [\fB-V\fR \fIversion\fR] [\fB-Y\fR \fIproxyDN\fR] [\fB-O\fR \fIhopLimit\fR]
- [\fB-i\fR \fIlocale\fR] [\fB-k\fR \fIpath\fR] [\fB-S\fR [\fB-\fR] \fIattribute\fR] [\fB-C\fR \fIpattern\fR]
- [\fB-c\fR \fIauthzid\fR] [\fB-P\fR \fIpath\fR] [\fB-N\fR \fIcertificate\fR] [\fB-w\fR \fIpasswd\fR]
- [\fB-h\fR \fIldaphost\fR] [\fB-p\fR \fIldapport\fR] [\fB-o\fR \fIattributename\fR=\fIvalue\fR]
- [\fB-b\fR \fIsearchbase\fR] [\fB-s\fR \fIscope\fR] [\fB-a\fR \fIderef\fR] [\fB-l\fR \fItimelimit\fR]
+\fBldapsearch\fR [\fB-n\fR] [\fB-u\fR] [\fB-v\fR] [\fB-t\fR] [\fB-A\fR] [\fB-B\fR] [\fB-L\fR] [\fB-R\fR] [\fB-H\fR]
+ [\fB-?\fR] [\fB-t\fR] [\fB-T\fR] [\fB-B\fR] [\fB-E\fR] [\fB-J\fR] [\fB-e\fR] [\fB-l\fR] [\fB-Z\fR] [\fB-r\fR]
+ [\fB-M\fR] [\fB-d\fR \fIdebuglevel\fR] [\fB-F\fR \fIsep\fR] [\fB-f\fR \fIfile\fR] [\fB-D\fR \fIbindDN\fR]
+ [\fB-j\fR \fIfilename\fR] [\fB-V\fR \fIversion\fR] [\fB-Y\fR \fIproxyDN\fR] [\fB-O\fR \fIhopLimit\fR]
+ [\fB-i\fR \fIlocale\fR] [\fB-k\fR \fIpath\fR] [\fB-S\fR [\fB-\fR] \fIattribute\fR] [\fB-C\fR \fIpattern\fR]
+ [\fB-c\fR \fIauthzid\fR] [\fB-P\fR \fIpath\fR] [\fB-N\fR \fIcertificate\fR] [\fB-w\fR \fIpasswd\fR]
+ [\fB-h\fR \fIldaphost\fR] [\fB-p\fR \fIldapport\fR] [\fB-o\fR \fIattributename\fR=\fIvalue\fR]
+ [\fB-b\fR \fIsearchbase\fR] [\fB-s\fR \fIscope\fR] [\fB-a\fR \fIderef\fR] [\fB-l\fR \fItimelimit\fR]
[\fB-z\fR \fIsizelimit\fR] \fIfilter\fR [\fIattrs\fR]...
.fi
@@ -61,7 +61,6 @@ is given, only the "attributename" is returned and not the attribute value.
The following options are supported:
.sp
.ne 2
-.mk
.na
\fB\fB-A\fR\fR
.ad
@@ -74,7 +73,6 @@ specific value.
.sp
.ne 2
-.mk
.na
\fB\fB-a\fR \fIderef\fR\fR
.ad
@@ -89,7 +87,6 @@ for the search. The default is to never dereference aliases.
.sp
.ne 2
-.mk
.na
\fB\fB-B\fR\fR
.ad
@@ -101,7 +98,6 @@ the default \fB-L\fR option.
.sp
.ne 2
-.mk
.na
\fB\fB-b\fR \fIsearchbase\fR\fR
.ad
@@ -113,7 +109,6 @@ default.
.sp
.ne 2
-.mk
.na
\fB\fB-C\fR \fIpattern\fR\fR
.ad
@@ -136,7 +131,6 @@ ps:changeType[:changesOnly[:entryChangeControls]]
.sp
.ne 2
-.mk
.na
\fB\fB-c\fR \fIauthzid\fR\fR
.ad
@@ -155,7 +149,6 @@ dn:uid=bjensen,dc=example,dc=com
.sp
.ne 2
-.mk
.na
\fB\fB-D\fR \fIbindDN\fR\fR
.ad
@@ -166,7 +159,6 @@ Use the distinguished name \fIbindDN\fR to bind to the directory.
.sp
.ne 2
-.mk
.na
\fB\fB-d\fR \fIdebuglevel\fR\fR
.ad
@@ -176,56 +168,46 @@ Set the \fBLDAP\fR debugging level. Useful levels of debugging for
\fBldapsearch\fR are:
.sp
.ne 2
-.mk
.na
\fB\fB1\fR\fR
.ad
.RS 7n
-.rt
Trace
.RE
.sp
.ne 2
-.mk
.na
\fB\fB2\fR\fR
.ad
.RS 7n
-.rt
Packets
.RE
.sp
.ne 2
-.mk
.na
\fB\fB4\fR\fR
.ad
.RS 7n
-.rt
Arguments
.RE
.sp
.ne 2
-.mk
.na
\fB\fB32\fR\fR
.ad
.RS 7n
-.rt
Filters
.RE
.sp
.ne 2
-.mk
.na
\fB\fB128\fR\fR
.ad
.RS 7n
-.rt
Access control
.RE
@@ -235,7 +217,6 @@ example, to request trace and filter information, specify a debuglevel of 33.
.sp
.ne 2
-.mk
.na
\fB\fB-E\fR\fR
.ad
@@ -247,7 +228,6 @@ control.
.sp
.ne 2
-.mk
.na
\fB\fB-e\fR\fR
.ad
@@ -258,7 +238,6 @@ Minimize base-64 encoding of values.
.sp
.ne 2
-.mk
.na
\fB\fB-F\fR \fIsep\fR\fR
.ad
@@ -270,7 +249,6 @@ this option has been specified, the \fB-L\fR option is ignored.
.sp
.ne 2
-.mk
.na
\fB\fB-f\fR \fIfile\fR\fR
.ad
@@ -285,7 +263,6 @@ are read from standard input.
.sp
.ne 2
-.mk
.na
\fB\fB-G\fR \fIpattern\fR\fR
.ad
@@ -299,7 +276,6 @@ before and after the target. This option always requires the \fB-S\fR and
.sp
.ne 2
-.mk
.na
\fB\fB-?\fR\fR
.ad
@@ -310,7 +286,6 @@ Display the usage help text that briefly describes all options.
.sp
.ne 2
-.mk
.na
\fB\fB-H\fR\fR
.ad
@@ -321,7 +296,6 @@ Display the usage help text that briefly describes all options.
.sp
.ne 2
-.mk
.na
\fB\fB-h\fR \fIldaphost\fR\fR
.ad
@@ -332,7 +306,6 @@ Specify an alternate host on which the secure LDAP server is running.
.sp
.ne 2
-.mk
.na
\fB\fB-i\fR \fIlocale\fR\fR
.ad
@@ -353,7 +326,6 @@ does not convert the data in the file.
.sp
.ne 2
-.mk
.na
\fB\fB-j\fR \fIfilename\fR\fR
.ad
@@ -367,7 +339,6 @@ the \fB-w\fR and \fB-W\fR options.
.sp
.ne 2
-.mk
.na
\fB\fB-J\fR [:\fIcriticality\fR[:\fIvalue\fR|::\fIb64value\fR|\fIb64value\fR|:\
fIfileurl\fR]]\fR
@@ -379,7 +350,6 @@ Criticality is a boolean value (default is \fBfalse\fR).
.sp
.ne 2
-.mk
.na
\fB\fB-k\fR \fIpath\fR\fR
.ad
@@ -392,7 +362,6 @@ your directory server. This is for NLS support.
.sp
.ne 2
-.mk
.na
\fB\fB-L\fR\fR
.ad
@@ -404,7 +373,6 @@ option. This behavior is the default.
.sp
.ne 2
-.mk
.na
\fB\fB-l\fR \fItimelimit\fR\fR
.ad
@@ -415,7 +383,6 @@ Wait at most \fItimelimit\fR seconds for a search to complete.
.sp
.ne 2
-.mk
.na
\fB\fB-M\fR\fR
.ad
@@ -428,7 +395,6 @@ referral.
.sp
.ne 2
-.mk
.na
\fB\fB-N\fR \fIcertificate\fR\fR
.ad
@@ -440,7 +406,6 @@ authentication. For example: \fB-N\fR \fB"Directory-Cert"\fR\&.
.sp
.ne 2
-.mk
.na
\fB\fB-n\fR\fR
.ad
@@ -452,7 +417,6 @@ conjunction with \fB-v\fR and \fB-d\fR for debugging.
.sp
.ne 2
-.mk
.na
\fB\fB-O\fR \fIhopLimit\fR\fR
.ad
@@ -464,7 +428,6 @@ modify. By default, there is no limit.
.sp
.ne 2
-.mk
.na
\fB\fB-o\fR \fIattributename\fR=\fIvalue\fR\fR
.ad
@@ -476,56 +439,46 @@ operation, authorization ID, authentication ID, and so forth.
The different attribute names and their values are as follows:
.sp
.ne 2
-.mk
.na
\fB\fBsecProp\fR=\fI"number"\fR\fR
.ad
.RS 20n
-.rt
For defining SASL security properties.
.RE
.sp
.ne 2
-.mk
.na
\fB\fBrealm\fR=\fI"value"\fR\fR
.ad
.RS 20n
-.rt
Specifies SASL realm (default is \fBrealm=none\fR).
.RE
.sp
.ne 2
-.mk
.na
\fB\fBauthzid\fR=\fI"value"\fR\fR
.ad
.RS 20n
-.rt
Specify the authorization ID name for SASL bind.
.RE
.sp
.ne 2
-.mk
.na
\fB\fBauthid\fR=\fI"value"\fR\fR
.ad
.RS 20n
-.rt
Specify the authentication ID for SASL bind.
.RE
.sp
.ne 2
-.mk
.na
\fB\fBmech\fR=\fI"value"\fR\fR
.ad
.RS 20n
-.rt
Specifies the various SASL mechanisms.
.RE
@@ -533,7 +486,6 @@ Specifies the various SASL mechanisms.
.sp
.ne 2
-.mk
.na
\fB\fB-P\fR \fIpath\fR\fR
.ad
@@ -564,7 +516,6 @@ Use the \fB-P\fR option alone to specify server authentication only.
.sp
.ne 2
-.mk
.na
\fB\fB-p\fR \fIldapport\fR\fR
.ad
@@ -575,7 +526,6 @@ Specify an alternate TCP port where the secure LAPD server is listening.
.sp
.ne 2
-.mk
.na
\fB\fB-R\fR\fR
.ad
@@ -586,7 +536,6 @@ Do not automatically follow referrals returned while searching.
.sp
.ne 2
-.mk
.na
\fB\fB-r\fR\fR
.ad
@@ -597,7 +546,6 @@ Display the output of the \fBldapsearch\fR command in the old format.
.sp
.ne 2
-.mk
.na
\fB\fB-S\fR [-]\fIattribute\fR\fR
.ad
@@ -621,7 +569,6 @@ server-side sorting.
.sp
.ne 2
-.mk
.na
\fB\fB-s\fR \fIscope\fR\fR
.ad
@@ -634,7 +581,6 @@ one-level, or subtree search. The default is \fBsub\fR.
.sp
.ne 2
-.mk
.na
\fB\fB-T\fR\fR
.ad
@@ -646,7 +592,6 @@ individual attribute values.
.sp
.ne 2
-.mk
.na
\fB\fB-t\fR\fR
.ad
@@ -658,7 +603,6 @@ with non-ASCII values such as jpegPhoto or audio.
.sp
.ne 2
-.mk
.na
\fB\fB-U\fR\fR
.ad
@@ -679,7 +623,6 @@ jpegPhoto:< file:/tmp/ldapsearch-jpegPhoto-YzaOMh
.sp
.ne 2
-.mk
.na
\fB\fB-u\fR\fR
.ad
@@ -690,7 +633,6 @@ Include the user-friendly form of the Distinguished Name (DN) in the output.
.sp
.ne 2
-.mk
.na
\fB\fB-V\fR \fIversion\fR\fR
.ad
@@ -703,7 +645,6 @@ servers that do not support v3.
.sp
.ne 2
-.mk
.na
\fB\fB-v\fR\fR
.ad
@@ -714,7 +655,6 @@ Run in verbose mode, with diagnostics written to standard output.
.sp
.ne 2
-.mk
.na
\fB\fB-W\fR \fIpassword\fR\fR
.ad
@@ -730,7 +670,6 @@ mutually exclusive of \fB-j\fR.
.sp
.ne 2
-.mk
.na
\fB\fB-w\fR \fIpasswd\fR\fR
.ad
@@ -747,7 +686,6 @@ the password is not visible to other users.
.sp
.ne 2
-.mk
.na
\fB\fB-x\fR\fR
.ad
@@ -762,7 +700,6 @@ supported, rather than on the client.
.sp
.ne 2
-.mk
.na
\fB\fB-Y\fR \fIproxyDN\fR\fR
.ad
@@ -774,7 +711,6 @@ operation, usually in double quotes (" ") for the shell.
.sp
.ne 2
-.mk
.na
\fB\fB-Z\fR\fR
.ad
@@ -787,7 +723,6 @@ options needed to identify the certificate and the key database.
.sp
.ne 2
-.mk
.na
\fB\fB-z\fR \fIsizelimit\fR\fR
.ad
@@ -932,23 +867,19 @@ example% ldapsearch -u -h '['fec0::111:a00:20ff:fea3:edcf']' \e
The following exit values are returned:
.sp
.ne 2
-.mk
.na
\fB\fB0\fR\fR
.ad
.RS 6n
-.rt
Successful completion.
.RE
.sp
.ne 2
-.mk
.na
\fB>\fB0\fR\fR
.ad
.RS 6n
-.rt
An error occurred. A diagnostic message is written to standard error.
.RE
@@ -960,12 +891,11 @@ See \fBattributes\fR(5) for a description of the following attributes:
.sp
.TS
-tab() box;
-cw(2.75i) |cw(2.75i)
-lw(2.75i) |lw(2.75i)
-.
-ATTRIBUTE TYPEATTRIBUTE VALUE
-Stability LevelEvolving
+box;
+c | c
+l | l .
+ATTRIBUTE TYPE ATTRIBUTE VALUE
+Stability Level Evolving
.TE
.SH SEE ALSO
generated by cgit v1.2.3 (git 2.39.1) at 2025-06-04 23:22:59 +0000