Merge branch 'mdb.master' of ssh://git-master.openldap.org/~git/git/openldap

[openldap] / doc / man / man1 / ldapwhoami.1

diff --git a/doc/man/man1/ldapwhoami.1 b/doc/man/man1/ldapwhoami.1
index b739f10e1f54a6aa086bdc9fcac9ebfb5f9ab6f1..9d2462863d9638aeace6b8f941cda2789a4103d4 100644 (file)
--- a/doc/man/man1/ldapwhoami.1
+++ b/doc/man/man1/ldapwhoami.1
@@ -1,6 +1,6 @@
 .TH LDAPWHOAMI 1 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$
 .TH LDAPWHOAMI 1 "RELEASEDATE" "OpenLDAP LDVERSION"
 .\" $OpenLDAP$

-.\" Copyright 1998-2002 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
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 ldapwhoami \- LDAP who am i? tool


@@ -29,7 +29,11 @@ ldapwhoami \- LDAP who am i? tool
 [\c
 .BI \-p \ ldapport\fR]
 [\c
 [\c
 .BI \-p \ ldapport\fR]
 [\c

-.BR \-O \ security-properties ]
+.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
+[\c
+.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
+[\c
+.BI \-O \ security-properties\fR]

 [\c
 .BR \-I ]
 [\c
 [\c
 .BR \-I ]
 [\c


@@ -37,13 +41,15 @@ ldapwhoami \- LDAP who am i? tool
 [\c
 .BI \-U \ authcid\fR]
 [\c
 [\c
 .BI \-U \ authcid\fR]
 [\c

+.BI \-R \ realm\fR]
+[\c

 .BR \-x ]
 [\c
 .BI \-X \ authzid\fR]
 [\c
 .BI \-Y \ mech\fR]
 [\c
 .BR \-x ]
 [\c
 .BI \-X \ authzid\fR]
 [\c
 .BI \-Y \ mech\fR]
 [\c

-.BR \-Z[Z] ]
+.BR \-Z [ Z ]]

 .SH DESCRIPTION
 .I ldapwhoami
 implements the LDAP "Who Am I?" extended operation.
 .SH DESCRIPTION
 .I ldapwhoami
 implements the LDAP "Who Am I?" extended operation.


@@ -56,14 +62,14 @@ operation.
 .B \-n
 Show what would be done, but don't actually perform the whoami operation.
 Useful for
 .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.
 .TP
 .BI \-d \ debuglevel
 Set the LDAP debugging level to \fIdebuglevel\fP.
 .TP
 .B \-v
 Run in verbose mode, with many diagnostics written to standard output.
 .TP
 .BI \-d \ debuglevel
 Set the LDAP debugging level to \fIdebuglevel\fP.

-.B ldapcompare
+.B ldapwhoami

 must be compiled with LDAP_DEBUG defined for this option to have any effect.
 .TP
 .B \-x 
 must be compiled with LDAP_DEBUG defined for this option to have any effect.
 .TP
 .B \-x 


@@ -71,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.
 .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.
 .TP
 .B \-W
 Prompt for simple authentication.


@@ -84,22 +91,51 @@ Use complete contents of \fIpasswdfile\fP as the password for
 simple authentication.
 .TP
 .BI \-H \ ldapuri
 simple authentication.
 .TP
 .BI \-H \ ldapuri

-Specify URI(s) referring to the ldap server(s).
+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.

 .TP
 .BI \-h \ ldaphost
 Specify an alternate host on which the ldap server is running.
 .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.
 .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
 .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=<filter>    (an RFC 4515 Filter)
+  !authzid=<authzid>    ("dn:<dn>" or "u:<user>")
+  [!]bauthzid           (RFC 3829 authzid control)
+  [!]chaining[=<resolve>[/<cont>]]
+  [!]manageDSAit
+  [!]noop
+  ppolicy
+  [!]postread[=<attrs>] (a comma-separated attribute list)
+  [!]preread[=<attrs>]  (a comma-separated attribute list)
+  [!]relax
+  sessiontracking[=<username>]
+  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.
 .B \-I
 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 only as needed.


@@ -111,36 +147,34 @@ Enable SASL Quiet mode.  Never prompt.
 Specify the authentication ID for SASL bind. The form of the ID
 depends on the actual SASL mechanism used.
 .TP
 Specify the authentication ID for SASL bind. The form of the ID
 depends on the actual SASL mechanism used.
 .TP

+.BI \-R \ realm
+Specify the realm of authentication ID for SASL bind. The form of the realm
+depends on the actual SASL mechanism used.
+.TP

 .BI \-X \ authzid
 Specify the requested authorization ID for SASL bind.
 .I authzid
 must be one of the following formats:
 .BI \-X \ authzid
 Specify the requested authorization ID for SASL bind.
 .I authzid
 must be one of the following formats:

-.B dn:\c
-.I <distinguished name>
+.BI dn: "<distinguished name>"

 or
 or

-.B u:\c
-.I <username>
+.BI u: <username>

 .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
 .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
 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
 .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),
 .BR ldap (3),
 .fi
 .SH "SEE ALSO"
 .BR ldap.conf (5),
 .BR ldap (3),

-.BR ldap_extended_s (3)
+.BR ldap_extended_operation (3)

 .SH AUTHOR
 The OpenLDAP Project <http://www.openldap.org/>
 .SH ACKNOWLEDGEMENTS
 .SH AUTHOR
 The OpenLDAP Project <http://www.openldap.org/>
 .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