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