X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Fman%2Fman1%2Fldapwhoami.1;h=9d2462863d9638aeace6b8f941cda2789a4103d4;hb=619cebee126b6f3cdee3a336504989566cffa02e;hp=f12a0b462fe334b879b3da236e44d83d7cce2174;hpb=acbb5cf689a4336af05c9f259d909d8141055bac;p=openldap diff --git a/doc/man/man1/ldapwhoami.1 b/doc/man/man1/ldapwhoami.1 index f12a0b462f..9d2462863d 100644 --- a/doc/man/man1/ldapwhoami.1 +++ b/doc/man/man1/ldapwhoami.1 @@ -1,6 +1,6 @@ .TH LDAPWHOAMI 1 "RELEASEDATE" "OpenLDAP LDVERSION" .\" $OpenLDAP$ -.\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved. +.\" Copyright 1998-2011 The OpenLDAP Foundation All Rights Reserved. .\" Copying restrictions apply. See COPYRIGHT/LICENSE. .SH NAME ldapwhoami \- LDAP who am i? tool @@ -29,6 +29,10 @@ ldapwhoami \- LDAP who am i? tool [\c .BI \-p \ ldapport\fR] [\c +.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]] +[\c +.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]] +[\c .BI \-O \ security-properties\fR] [\c .BR \-I ] @@ -45,7 +49,7 @@ ldapwhoami \- LDAP who am i? tool [\c .BI \-Y \ mech\fR] [\c -.BR \-Z[Z] ] +.BR \-Z [ Z ]] .SH DESCRIPTION .I ldapwhoami implements the LDAP "Who Am I?" extended operation. @@ -58,7 +62,7 @@ operation. .B \-n Show what would be done, but don't actually perform the whoami operation. Useful for -debugging in conjunction with -v. +debugging in conjunction with \fB\-v\fP. .TP .B \-v Run in verbose mode, with many diagnostics written to standard output. @@ -73,6 +77,7 @@ 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. @@ -92,18 +97,45 @@ is expected. .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. -.TP -.BI \-P \ 2\fR\||\|\fI3 -Specify the LDAP protocol version to use. +Deprecated in favor of \fB\-H\fP. .TP .BI \-O \ security-properties Specify SASL security properties. .TP +.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ] +.TP +.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ] + +Specify general extensions with \fB\-e\fP and whoami 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 + +WhoAmI extensions: +.nf + (none) +.fi +.TP .B \-I Enable SASL Interactive mode. Always prompt. Default is to prompt only as needed. @@ -123,23 +155,20 @@ 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 EXAMPLE .nf - ldapwhoami -x -D "cn=Manager,dc=example,dc=com" -W + ldapwhoami \-x \-D "cn=Manager,dc=example,dc=com" \-W .fi .SH "SEE ALSO" .BR ldap.conf (5), @@ -148,7 +177,4 @@ Issue StartTLS (Transport Layer Security) extended operation. If you use .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