docs/manpages/pdbedit.8

   1 .\" This manpage has been automatically generated by docbook2man-spec
   2 .\" from a DocBook document.  docbook2man-spec can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "PDBEDIT" "8" "28 January 2002" "" ""
   7 .SH NAME
   8 pdbedit \- manage the SAM database
   9 .SH SYNOPSIS
  10 .sp
  11 \fBpdbedit\fR [ \fB-l\fR ]  [ \fB-v\fR ]  [ \fB-w\fR ]  [ \fB-u username\fR ]  [ \fB-f fullname\fR ]  [ \fB-h homedir\fR ]  [ \fB-d drive\fR ]  [ \fB-s script\fR ]  [ \fB-p profile\fR ]  [ \fB-a\fR ]  [ \fB-m\fR ]  [ \fB-x\fR ]  [ \fB-i file\fR ]
  12 .SH "DESCRIPTION"
  13 .PP
  14 This tool is part of the  Sambasuite.
  15 .PP
  16 The pdbedit program is used to manage the users accounts
  17 stored in the sam database and can be run only by root.
  18 .PP
  19 The pdbedit tool use the passdb modular interface and is
  20 independent from the kind of users database used (currently there
  21 are smbpasswd, ldap, nis+ and tdb based and more can be addedd
  22 without changing the tool).
  23 .PP
  24 There are five main ways to use pdbedit: adding a user account,
  25 removing a user account, modifing a user account, listing user
  26 accounts, importing users accounts.
  27 .SH "OPTIONS"
  28 .TP
  29 \fB-l\fR
  30 This option list all the user accounts
  31 present in the users database.
  32 This option prints a list of user/uid pairs separated by
  33 the ':' character.
  34
  35 Example: \fBpdbedit -l\fR
  36
  37 .sp
  38 .nf
  39                 sorce:500:Simo Sorce
  40                 samba:45:Test User
  41
  42 .sp
  43 .fi
  44 .TP
  45 \fB-v\fR
  46 This option sets the verbose listing format.
  47 It will make pdbedit list the users in the database printing
  48 out the account fields in a descriptive format.
  49
  50 Example: \fBpdbedit -l -v\fR
  51
  52 .sp
  53 .nf
  54                 ---------------
  55                 username:       sorce
  56                 user ID/Group:  500/500
  57                 user RID/GRID:  2000/2001
  58                 Full Name:      Simo Sorce
  59                 Home Directory: \\\\BERSERKER\\sorce
  60                 HomeDir Drive:  H:
  61                 Logon Script:   \\\\BERSERKER\\netlogon\\sorce.bat
  62                 Profile Path:   \\\\BERSERKER\\profile
  63                 ---------------
  64                 username:       samba
  65                 user ID/Group:  45/45
  66                 user RID/GRID:  1090/1091
  67                 Full Name:      Test User
  68                 Home Directory: \\\\BERSERKER\\samba
  69                 HomeDir Drive:
  70                 Logon Script:
  71                 Profile Path:   \\\\BERSERKER\\profile
  72
  73 .sp
  74 .fi
  75 .TP
  76 \fB-w\fR
  77 This option sets the "smbpasswd" listing format.
  78 It will make pdbedit list the users in the database printing
  79 out the account fields in a format compatible with the
  80 \fIsmbpasswd\fR file format. (see the \fIsmbpasswd(5)\fRfor details)
  81
  82 Example: \fBpdbedit -l -w\fR
  83
  84 .sp
  85 .nf
  86                 sorce:500:508818B733CE64BEAAD3B435B51404EE:D2A2418EFC466A8A0F6B1DBB5C3DB80C:[UX         ]:LCT-00000000:
  87                 samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:BC281CE3F53B6A5146629CD4751D3490:[UX         ]:LCT-3BFA1E8D:
  88
  89 .sp
  90 .fi
  91 .TP
  92 \fB-u username\fR
  93 This option specifies that the username to be
  94 used for the operation requested (listing, adding, removing)
  95 It is \fBrequired\fR in add, remove and modify
  96 operations and \fBoptional\fR in list
  97 operations.
  98 .TP
  99 \fB-f fullname\fR
 100 This option can be used while adding or
 101 modifing a user account. It will specify the user's full
 102 name.
 103
 104 Example: \fB-f "Simo Sorce"\fR
 105 .TP
 106 \fB-h homedir\fR
 107 This option can be used while adding or
 108 modifing a user account. It will specify the user's home
 109 directory network path.
 110
 111 Example: \fB-h "\\\\\\\\BERSERKER\\\\sorce"\fR
 112 .TP
 113 \fB-d drive\fR
 114 This option can be used while adding or
 115 modifing a user account. It will specify the windows drive
 116 letter to be used to map the home directory.
 117
 118 Example: \fB-d "H:"\fR
 119 .TP
 120 \fB-s script\fR
 121 This option can be used while adding or
 122 modifing a user account. It will specify the user's logon
 123 script path.
 124
 125 Example: \fB-s "\\\\\\\\BERSERKER\\\\netlogon\\\\sorce.bat"\fR
 126 .TP
 127 \fB-p profile\fR
 128 This option can be used while adding or
 129 modifing a user account. It will specify the user's profile
 130 directory.
 131
 132 Example: \fB-p "\\\\\\\\BERSERKER\\\\netlogon"\fR
 133 .TP
 134 \fB-a\fR
 135 This option is used to add a user into the
 136 database. This command need the user name be specified with
 137 the -u switch. When adding a new user pdbedit will also
 138 ask for the password to be used
 139
 140 Example: \fBpdbedit -a -u sorce\fR
 141 .sp
 142 .nf
 143 new password:
 144                 retype new password
 145 .sp
 146 .fi
 147 .TP
 148 \fB-m\fR
 149 This option may only be used in conjunction
 150 with the \fI-a\fR option. It will make
 151 pdbedit to add a machine trust account instead of a user
 152 account (-u username will provide the machine name).
 153
 154 Example: \fBpdbedit -a -m -u w2k-wks\fR
 155 .TP
 156 \fB-x\fR
 157 This option causes pdbedit to delete an account
 158 from the database. It need the username be specified with the
 159 -u switch.
 160
 161 Example: \fBpdbedit -x -u bob\fR
 162 .TP
 163 \fB-i file\fR
 164 This command is used to import a smbpasswd
 165 file into the database.
 166
 167 This option will ease migration from the plain smbpasswd
 168 file database to more powerful backend databases like tdb and
 169 ldap.
 170
 171 Example: \fBpdbedit -i /etc/smbpasswd.old\fR
 172 .SH "NOTES"
 173 .PP
 174 This command may be used only by root.
 175 .SH "VERSION"
 176 .PP
 177 This man page is correct for version 2.2 of
 178 the Samba suite.
 179 .SH "SEE ALSO"
 180 .PP
 181 smbpasswd(8),
 182 samba(7)
 183 .SH "AUTHOR"
 184 .PP
 185 The original Samba software and related utilities
 186 were created by Andrew Tridgell. Samba is now developed
 187 by the Samba Team as an Open Source project similar
 188 to the way the Linux kernel is developed.
 189 .PP
 190 The original Samba man pages were written by Karl Auer.
 191 The man page sources were converted to YODL format (another
 192 excellent piece of Open Source software, available at
 193 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
 194 release by Jeremy Allison. The conversion to DocBook for
 195 Samba 2.2 was done by Gerald Carter