docs/manpages/smbpasswd.8

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