Adding the same changes to HEAD as were added to BRANCH_1_9_18.
[samba.git] / docs / manpages / smbpasswd.8
1 .TH SMBPASSWD 8 "19 Feb 1998" "smbpasswd 1.9.18p3"
2 .SH NAME
3 smbpasswd \- change a users smb password in the smbpasswd file.
4 .SH SYNOPSIS
5 .B smbpasswd
6 [
7 .B \-a
8 ] [
9 .B \-r
10 remote_machine
11 ] [
12 .B username
13 ]
14 .SH DESCRIPTION
15
16 This program is part of the Samba suite.
17
18 .B smbpasswd 
19 allows a user to change their encrypted smb password which
20 is stored in the smbpasswd file (usually kept in the
21 .I private
22 directory under the
23 .I Samba 
24 directory hierarchy. Ordinary users can only run the command 
25 with no options. It will prompt them for their old smb password
26 and then ask them for their new password twice, to ensure that
27 the new password was typed correctly. No passwords will
28 be echoed on the screen whilst being typed. If you have a blank
29 smb password (specified by the string "NO PASSWORD" in the
30 smbpasswd file) then just press the <Enter> key when asked
31 for your old password.
32
33 .B New for 1.9.18p4.
34 smbpasswd will now allow a user to change their password
35 on a Windows NT server. To use this add the 
36 .I \-r
37 .I \<remote_machine\>
38 paramter to the smbpasswd command. The machine name is looked
39 up using the "name resolve order" parameter defined in the
40 smb.conf [global] section. Note that when changing a Windows
41 NT password for a domain user,
42 .I \<remote machine\>
43 must be the name of the Primary domain controller.
44
45 To allow users to change their passwords from "NO PASSWORD"
46 in the smbpasswd file to a valid password the administrator
47 must set the following parameter in the [global] section of
48 the smb.conf :
49
50 null passwords = true
51
52 This is 
53 .B NOT
54 recommended as a general policy, it is recommended that
55 new users be assigned a default password instead.
56
57 The 
58 .I \-a
59 and 
60 .I username
61 options can only be used by a user running as root.
62
63 .SH OPTIONS
64 .I \-a
65
66 .RS 3
67 Specifies that the username following should be added to
68 the
69 .I smbpasswd
70 file, with the new password typed (type <Enter> for the
71 old password). This option is ignored if the username 
72 following already exists in the
73 .I smbpasswd
74 file and it is treated like a regular change password 
75 command. Note that the user to be added
76 .B must
77 already exist in the system password file (usually /etc/passwd)
78 else the request to add the user will fail.
79
80 .RE
81 .I username
82
83 .RS 3
84 You may only specify a username to the smbpasswd command
85 if you are running as root. Only root should have the
86 permission to modify other users smb passwords.
87
88 .RE
89 .RE
90 .SH INSTALLATION
91
92 The location of the server and its support files is a matter for individual
93 system administrators. The following are thus suggestions only.
94
95 It is recommended that the
96 .B smbpasswd
97 program be installed in the /usr/local/samba/bin directory. This should be
98 a directory readable by all, writeable only by root. The program should be
99 executable by all. The program 
100 .B must not 
101 be setuid root.
102
103 .SH VERSION
104
105 This man page is correct for version 1.9.18p4 of the Samba suite.
106 These notes will necessarily lag behind 
107 development of the software, so it is possible that your version of 
108 the program has extensions or parameter semantics that differ from or are not 
109 covered by this man page. Please notify these to the address below for 
110 rectification.
111 .SH SEE ALSO
112 .BR smbd (8), 
113 .BR smb.conf (5) 
114 .SH
115 .B BUGS
116
117 .RE
118 The
119 .B smbpasswd
120 command is only useful if
121 .I Samba
122 has been set up to use encrypted passwords. See the file
123 .I ENCRYPTION.txt
124 in the docs directory for details on how to do this.
125
126 .SH CREDITS
127 .RE
128 The original Samba software and related utilities were created by 
129 Andrew Tridgell (samba-bugs@samba.anu.edu.au). Andrew is also the Keeper
130 of the Source for this project. smbpasswd and the encrypted password
131 file code was written by Jeremy Allison (samba-bugs@samba.anu.edu.au).
132
133 This man page was written by Jeremy Allison. Bug reports to samba-bugs@samba.anu.edu.au.
134
135 See
136 .BR smb.conf (5)
137 for a full list of contributors and details of how to 
138 submit bug reports, comments etc.