]> git.sur5r.net Git - openldap/blob - doc/man/man1/ldappasswd.1
e79f560c14e9c480c0a890d7bf12e65d8a5c426a
[openldap] / doc / man / man1 / ldappasswd.1
1 .TH LDAPPASSWD 1 "12 July 2000" "LDAPPasswd"
2 .\" $OpenLDAP$
3 .\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
5 .SH NAME
6 ldappasswd \- change the password of an LDAP entry
7 .SH SYNOPSIS
8 .B ldappasswd
9 [\c
10 .BR \-A ]
11 [\c
12 .BI \-a \ oldPasswd\fR]
13 [\c
14 .BR \-C ]
15 [\c
16 .BI \-D \ binddn\fR
17 [\c
18 .BI \-d \ debuglevel\fR]
19 [\c
20 .BI \-h \ ldaphost\fR]
21 [\c
22 .BR \-n ]
23 [\c
24 .BI \-p \ ldapport\fR]
25 [\c
26 .BR \-S ]
27 [\c
28 .BI \-s \ newPasswd\fR]
29 [\c
30 .BR \-v ]
31 [\c
32 .BR \-W ]
33 [\c
34 .BI \-w \ passwd\fR]
35 [\c
36 .BR \-O \ security-properties ]
37 [\c
38 .BI \-U \ username\fR]
39 [\c
40 .BR \-x ]
41 [\c
42 .BI \-X \ authzid\fR]
43 [\c
44 .BI \-Y \ mech\fR]
45 [\c
46 .BR \-Z[Z] ]
47 .SH DESCRIPTION
48 .B ldappasswd
49 is a tool to set the password of an LDAP user.
50 It is neither designed nor intended to be a replacement for
51 .BR passwd (1)
52 and should not be installed as such.
53 .LP
54 .B ldappasswd
55 sets the password of associated with the user.  If the new
56 password is not specified on the command line or the user
57 doesn't enable prompting, the server will be asked to generate
58 a password for the user.
59 .SH OPTIONS
60 .TP
61 .BI \-A
62 Prompt for old password.
63 This is used instead of specifying the password on the command line.
64 .TP
65 .BI \-a \ oldPasswd
66 Set the old password to \fIoldPasswd\fP.
67 .TP
68 .B \-C
69 Automatically chase referrals.
70 .TP
71 .B \-x 
72 Use simple authentication instead of SASL.
73 .TP
74 .BI \-D \ binddn
75 Use \fIbinddn\fP to bind to the LDAP directory. \fIbinddn\fP should
76 be a string-represented DN as defined in RFC 2253.
77 This flag is not optional.  The user DN will be used if the
78 bind DN is not provided.
79 .TP
80 .BI \-d \ debuglevel
81 Set the LDAP debugging level to \fIdebuglevel\fP.
82 .B ldappasswd
83 must be compiled with LDAP_DEBUG defined for this option to have any effect.
84 .TP
85 .BI \-h \ ldaphost
86 Specify an alternate host on which the ldap server is running.
87 .TP
88 .B \-n
89 Do not set password. (Can be useful when used in conjunction with
90 .BR \-v \ or
91 .BR \-d )
92 .TP
93 .BI \-S
94 Prompt for new password.
95 This is used instead of specifying the password on the command line.
96 .TP
97 .BI \-s \ newPasswd
98 Set the new password to \fInewPasswd\fP.
99 .TP
100 .BI \-p \ ldapport
101 Specify an alternate port on which the ldap server is running.
102 .TP
103 .B \-v
104 Increase the verbosity of output.  Can be specified multiple times.
105 .TP
106 .BI \-W
107 Prompt for bind password.
108 This is used instead of specifying the password on the command line.
109 .TP
110 .BI \-w \ passwd
111 Use \fIpasswd\fP as the password to bind with.
112 .TP
113 .BI \-O \ security-properties
114 Specify SASL security properties.
115 .TP
116 .BI \-U \ username
117 Specify the username for SASL bind. The syntax of the username depends on the
118 actual SASL mechanism used.
119 .TP
120 .BI \-X \ authzid
121 Specify the requested authorization ID for SASL bind.
122 .I authzid
123 must be one of the following formats:
124 .B dn:\c
125 .I <distinguished name>
126 or
127 .B u:\c
128 .I <username>
129 .TP
130 .BI \-Y \ mech
131 Specify the SASL mechanism to be used for authentication. If it's not
132 specified, the program will choose the best mechanism the server knows.
133 .TP
134 .B \-Z[Z]
135 Issue StartTLS (Transport Layer Security) extended operation. If you use
136 .B \-ZZ\c
137 , the command will require the operation to be successful.
138 .SH SEE ALSO
139 .BR ldap_bind (3)
140 .SH AUTHOR
141 The OpenLDAP Project <http://www.openldap.org/>
142 .SH ACKNOWLEDGEMENTS
143 .B      OpenLDAP
144 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
145 .B      OpenLDAP
146 is derived from University of Michigan LDAP 3.3 Release.