From: Kurt Zeilenga Date: Thu, 29 Aug 2002 03:33:52 +0000 (+0000) Subject: Add ldapwhoami(1) man page X-Git-Tag: OPENLDAP_REL_ENG_2_1_5~103 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=a4abbe223d6548a548e7484f84dd80af8d51930c;p=openldap Add ldapwhoami(1) man page Add passfile (-y) support --- diff --git a/doc/man/man1/ldapcompare.1 b/doc/man/man1/ldapcompare.1 index 620729c667..7693673ddf 100644 --- a/doc/man/man1/ldapcompare.1 +++ b/doc/man/man1/ldapcompare.1 @@ -25,7 +25,9 @@ ldapcompare \- LDAP compare tool [\c .BR \-W ] [\c -.BI \-w \ bindpasswd\fR] +.BI \-w \ passwd\fR] +[\c +.BI \-y \ passwdfile\fR] [\c .BI \-H \ ldapuri\fR] [\c @@ -111,8 +113,12 @@ Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory. Prompt for simple authentication. This is used instead of specifying the password on the command line. .TP -.BI \-w \ bindpasswd -Use \fIbindpasswd\fP as the password for simple authentication. +.BI \-w \ passwd +Use \fIpasswd\fP as the password for simple authentication. +.TP +.BI \-y \ passwdfile +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). diff --git a/doc/man/man1/ldapdelete.1 b/doc/man/man1/ldapdelete.1 index 88a6c683fe..f60628a0a1 100644 --- a/doc/man/man1/ldapdelete.1 +++ b/doc/man/man1/ldapdelete.1 @@ -31,6 +31,8 @@ ldapdelete \- LDAP delete entry tool [\c .BI \-w \ passwd\fR] [\c +.BI \-y \ passwdfile\fR] +[\c .BI \-H \ ldapuri\fR] [\c .BI \-h \ ldaphost\fR] @@ -127,6 +129,10 @@ This is used instead of specifying the password on the command line. .BI \-w \ passwd Use \fIpasswd\fP as the password for simple authentication. .TP +.BI \-y \ passwdfile +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). .TP diff --git a/doc/man/man1/ldapmodify.1 b/doc/man/man1/ldapmodify.1 index 485b675835..1328a1c536 100644 --- a/doc/man/man1/ldapmodify.1 +++ b/doc/man/man1/ldapmodify.1 @@ -33,6 +33,8 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools [\c .BI \-w \ passwd\fR] [\c +.BI \-y \ passwdfile\fR] +[\c .BI \-H \ ldapuri\fR] [\c .BI \-h \ ldaphost\fR] @@ -85,6 +87,8 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools [\c .BI \-w \ passwd\fR] [\c +.BI \-y \ passwdfile\fR] +[\c .BI \-h \ ldaphost\fR] [\c .BI \-p \ ldapport\fR] @@ -198,6 +202,10 @@ This is used instead of specifying the password on the command line. .BI \-w \ passwd Use \fIpasswd\fP as the password for simple authentication. .TP +.BI \-y \ passwdfile +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). .TP diff --git a/doc/man/man1/ldapmodrdn.1 b/doc/man/man1/ldapmodrdn.1 index 39dddcb26b..3f12b3168f 100644 --- a/doc/man/man1/ldapmodrdn.1 +++ b/doc/man/man1/ldapmodrdn.1 @@ -31,6 +31,8 @@ ldapmodrdn \- LDAP rename entry tool [\c .BI \-w \ passwd\fR] [\c +.BI \-y \ passwdfile\fR] +[\c .BI \-H \ ldapuri\fR] [\c .BI \-h \ ldaphost\fR] @@ -130,6 +132,10 @@ This is used instead of specifying the password on the command line. .B \-w passwd Use \fIpasswd\fP as the password for simple authentication. .TP +.BI \-y \ passwdfile +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). .TP diff --git a/doc/man/man1/ldapsearch.1 b/doc/man/man1/ldapsearch.1 index b998dc92a5..47e6233b41 100644 --- a/doc/man/man1/ldapsearch.1 +++ b/doc/man/man1/ldapsearch.1 @@ -35,7 +35,9 @@ ldapsearch \- LDAP search tool [\c .BR \-W ] [\c -.BI \-w \ bindpasswd\fR] +.BI \-w \ passwd\fR] +[\c +.BI \-y \ passwdfile\fR] [\c .BI \-H \ ldapuri\fR] [\c @@ -174,8 +176,12 @@ Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory. Prompt for simple authentication. This is used instead of specifying the password on the command line. .TP -.BI \-w \ bindpasswd -Use \fIbindpasswd\fP as the password for simple authentication. +.BI \-w \ passwd +Use \fIpasswd\fP as the password for simple authentication. +.TP +.BI \-y \ passwdfile +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). diff --git a/doc/man/man1/ldapwhoami.1 b/doc/man/man1/ldapwhoami.1 new file mode 100644 index 0000000000..b739f10e1f --- /dev/null +++ b/doc/man/man1/ldapwhoami.1 @@ -0,0 +1,146 @@ +.TH LDAPWHOAMI 1 "RELEASEDATE" "OpenLDAP LDVERSION" +.\" $OpenLDAP$ +.\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved. +.\" Copying restrictions apply. See COPYRIGHT/LICENSE. +.SH NAME +ldapwhoami \- LDAP who am i? tool +.SH SYNOPSIS +.B ldapwhoami +[\c +.BR \-n ] +[\c +.BR \-v ] +[\c +.BR \-z ] +[\c +.BI \-d \ debuglevel\fR] +[\c +.BI \-D \ binddn\fR] +[\c +.BR \-W ] +[\c +.BI \-w \ passwd\fR] +[\c +.BI \-y \ passwdfile\fR] +[\c +.BI \-H \ ldapuri\fR] +[\c +.BI \-h \ ldaphost\fR] +[\c +.BI \-p \ ldapport\fR] +[\c +.BR \-O \ security-properties ] +[\c +.BR \-I ] +[\c +.BR \-Q ] +[\c +.BI \-U \ authcid\fR] +[\c +.BR \-x ] +[\c +.BI \-X \ authzid\fR] +[\c +.BI \-Y \ mech\fR] +[\c +.BR \-Z[Z] ] +.SH DESCRIPTION +.I ldapwhoami +implements the LDAP "Who Am I?" extended operation. +.LP +.B ldapwhoami +opens a connection to an LDAP server, binds, and performs a whoami +operation. +.SH OPTIONS +.TP +.B \-n +Show what would be done, but don't actually perform the whoami operation. +Useful for +debugging in conjunction with -v. +.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 +must be compiled with LDAP_DEBUG defined for this option to have any effect. +.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. +.TP +.B \-W +Prompt for simple authentication. +This is used instead of specifying the password on the command line. +.TP +.BI \-w \ passwd +Use \fIpasswd\fP as the password for simple authentication. +.TP +.BI \-y \ passwdfile +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). +.TP +.BI \-h \ ldaphost +Specify an alternate host on which the ldap server is running. +Deprecated in favor of -H. +.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. +.TP +.BI \-O \ security-properties +Specify SASL security properties. +.TP +.B \-I +Enable SASL Interactive mode. Always prompt. Default is to prompt +only as needed. +.TP +.B \-Q +Enable SASL Quiet mode. Never prompt. +.TP +.BI \-U \ authcid +Specify the authentication ID for SASL bind. The form of the ID +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: +.B dn:\c +.I +or +.B u:\c +.I +.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] +Issue StartTLS (Transport Layer Security) extended operation. If you use +.B \-ZZ\c +, the command will require the operation to be successful. +.SH EXAMPLE +.nf + ldapwhoami -x -D "cn=Manager,dc=example,dc=com" -W +.fi +.SH "SEE ALSO" +.BR ldap.conf (5), +.BR ldap (3), +.BR ldap_extended_s (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.