adduser/adduser.8

   1 .\" Copyright (c) 1995-1996 Wolfram Schneider <wosch@FreeBSD.org>. Berlin.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $Id: adduser.8,v 1.21 1997/06/23 04:52:07 steve Exp $
  26 .\"
  27 .Dd January 9, 1995
  28 .Dt ADDUSER 8
  29 .Os FreeBSD 2.1
  30 .Sh NAME
  31 .Nm adduser
  32 .Nd command for adding new users
  33 .Sh SYNOPSIS
  34 .Nm adduser
  35 .Oo
  36 .Fl batch Ar username
  37 .Op Ar group Ns , Ns Op Ar group,...
  38 .Op Ar class
  39 .Op Ar fullname
  40 .Op Ar password
  41 .Oc
  42 .br
  43 .Op Fl check_only
  44 .br
  45 .Op Fl class Ar login_class
  46 .br
  47 .Op Fl config_create
  48 .br
  49 .Op Fl dotdir Ar dotdir
  50 .br
  51 .Op Fl group Ar login_group
  52 .br
  53 .Op Fl h | help
  54 .br
  55 .Op Fl home Ar home
  56 .br
  57 .Op Fl message Ar message_file
  58 .br
  59 .Op Fl noconfig
  60 .br
  61 .Op Fl shell Ar shell
  62 .br
  63 .Op Fl s | silent | q | quiet
  64 .br
  65 .Op Fl uid Ar uid_start
  66 .br
  67 .Op Fl v | verbose
  68 .Sh DESCRIPTION
  69 .Nm Adduser
  70 is a simple program for adding new users. Adduser checks
  71 the passwd, group and shell databases. It creates passwd/group entries,
  72 .Ev HOME
  73 directory, dotfiles and sends the new user a welcome message.
  74 .Sh RESTRICTIONS
  75 .Bl -tag -width Ds -compact
  76 .It Sy username
  77 Login name. May contain only  lowercase characters or digits. Maximum length
  78 is 16 characters (see
  79 .Xr setlogin 2
  80 BUGS section).
  81 The reasons for this limit are "Historical".
  82 Given that people have traditionally wanted to break this
  83 limit for aesthetic reasons, it's never been of great importance to break
  84 such a basic fundamental parameter in UNIX.
  85 You can change
  86 .Dv UT_NAMESIZE
  87 in
  88 .Pa /usr/include/utmp.h
  89 and recompile the
  90 world; people have done this and it works, but you will have problems
  91 with any precompiled programs, or source that assumes the 8-character
  92 name limit and NIS. The NIS protocol mandates an 8-character username.
  93 If you need a longer login name for e-mail addresses,
  94 you can define an alias in
  95 .Pa /etc/aliases .
  96 .It Sy fullname
  97 Firstname and surname.
  98 The
  99 .Ql Pa \:
 100 character is not allowed.
 101 .It Sy shell
 102 Only valid shells from the shell database or sliplogin and pppd
 103 .It Sy uid
 104 Automatically generated or your choice, must be less than 32000.
 105 .It Sy gid/login group
 106 Your choice or automatically generated.
 107 .It Sy password
 108 If not empty, password is encoded with
 109 .Xr crypt 3 .
 110 .El
 111 .Sh UNIQUE GROUPS
 112 Perhaps you're missing what
 113 .Em can
 114 be done with this scheme that falls apart
 115 with most other schemes.  With each user in his/her own group the user can
 116 safely run with a umask of 002 and have files created in their home directory
 117 and not worry about others being able to read them.
 118 .Pp
 119 For a shared area you create a separate uid/gid (like cvs or ncvs on freefall),
 120 you place each person that should be able to access this area into that new
 121 group.
 122 .Pp
 123 This model of uid/gid administration allows far greater flexibility than lumping
 124 users into groups and having to muck with the umask when working in a shared
 125 area.
 126 .Pp
 127 I have been using this model for almost 10 years and found that it works
 128 for most situations, and has never gotten in the way.  (Rod Grimes)
 129 .Sh CONFIGURATION
 130 .Bl -enum
 131 .It
 132 Read internal variables.
 133 .It
 134 Read configuration file (/etc/adduser.conf).
 135 .It
 136 Parse command line options.
 137 .El
 138 .Sh OPTIONS
 139 .Bl -tag -width Ds
 140 .It Sy -batch username [group[,group]...] [class] [fullname] [password]
 141 Batch mode.
 142 .It Sy -check_only
 143 Check /etc/passwd, /etc/group, /etc/shells and exit.
 144 .It Sy -class Ar login_class
 145 Set default login class.
 146 .It Sy -create_config
 147 Create new configuration and message file and exit.
 148 .It Sy -dotdir Ar directory
 149 Copy files from
 150 .Ar directory
 151 into the
 152 .Ev HOME
 153 directory of new users,
 154 .Ql Pa dot.foo
 155 will be renamed to
 156 .Ql Pa .foo .
 157 Don't copy files if
 158 .Ar directory
 159 specified is equal to
 160 .Ar no .
 161 For security make all files writable and readable for owner,
 162 don't allow group or world to write files and allow only owner
 163 to read/execute/write
 164 .Pa .rhost ,
 165 .Pa .Xauthority ,
 166 .Pa .kermrc ,
 167 .Pa .netrc ,
 168 .Pa Mail ,
 169 .Pa prv ,
 170 .Pa iscreen ,
 171 .Pa term .
 172 .It Sy -group Ar login_group
 173 Login group.
 174 .Ar USER
 175 means that the username is to be used as login group.
 176 .It Sy -help,-h,-?
 177 Print a summary of options and exit.
 178 .It Sy -home Ar partition
 179 Default home partition where all users located.
 180 .It Sy -message Ar file
 181 Send new users a welcome message from
 182 .Ar file .
 183 Specifying a value of
 184 .Ar no
 185 for
 186 .Ar file
 187 causes no message to be sent to new users.
 188 .It Sy -noconfig
 189 Do not read the default configuration file.
 190 .It Sy -shell Ar shell
 191 Default shell for new users.
 192 .It Sy -silent,-s,-quiet,-q
 193 Few warnings, questions, bug reports.
 194 .It Sy -uid Ar uid
 195 Use uid's from
 196 .Ar uid
 197 on up.
 198 .It Sy -verbose,-v
 199 Many warnings, questions. Recommended for novice users.
 200 .Sh FORMATS
 201 .Bl -tag -width Ds -compact
 202 .Ql Pa #
 203 is a comment.
 204 .It Sy configuration file
 205 .Nm Adduser
 206 reads and writes this file.
 207 See
 208 .Pa /etc/adduser.conf
 209 for more details.
 210 .It Sy message file
 211 Eval variables in this file. See
 212 .Pa /etc/adduser.message
 213 for more
 214 details.
 215 .El
 216 .Sh EXAMPLES
 217 .Pp
 218 $ adduser
 219 .Pp
 220 Start adduser in interactive mode.
 221 .Pp
 222 $ adduser -batch baerenklau guest,staff,baer '' 'Teddy II' qwerty7
 223 .Pp
 224 Create user 'baerenklau' and  login group 'baerenklau'. Invite user
 225 baerenklau into groups guest, staff and baer. Use default login class.
 226 Realname (fullname)
 227 is 'Teddy II'. Password is 'qwerty7' (don't use such passwords!). Create
 228 .Ev HOME
 229 directory
 230 .Pa /home/baerenklau
 231 and copy all files and directories
 232 from
 233 .Pa /usr/share/skel
 234 to
 235 .Pa /home/baerenklau .
 236 Send user baerenklau
 237 a welcome message.
 238 .Pp
 239 $ adduser -uid 5000 -group guest -message no -batch vehlefanz
 240 .Pp
 241 Create user 'vehlefanz'. Login group is guest. Uid next available uid
 242 after 5000, for instance 5007. No other groups, no realname, no password.
 243 Do not send a welcome message.
 244 .Sh FILES
 245 .Bl -tag -width /etc/master.passwdxx -compact
 246 .It Pa /etc/master.passwd
 247 user database
 248 .It Pa /etc/group
 249 group database
 250 .It Pa /etc/shells
 251 shell database
 252 .It Pa /etc/login.conf
 253 login classes database
 254 .It Pa /etc/adduser.conf
 255 configuration file for adduser
 256 .It Pa /etc/adduser.message
 257 message file for adduser
 258 .It Pa /usr/share/skel
 259 skeletal login directory
 260 .It Pa /var/log/adduser
 261 logfile for adduser
 262 .El
 263 .Sh SEE ALSO
 264 .Xr chpass 1 ,
 265 .Xr finger 1 ,
 266 .Xr passwd 1 ,
 267 .Xr setlogin 2 ,
 268 .Xr yp 4 ,
 269 .Xr aliases 5 ,
 270 .Xr group 5 ,
 271 .Xr login.conf 5 ,
 272 .Xr passwd 5 ,
 273 .Xr shells 5 ,
 274 .Xr addgroup 8 ,
 275 .Xr pwd_mkdb 8 ,
 276 .Xr rmgroup 8 ,
 277 .Xr rmuser 8 ,
 278 .Xr vipw 8
 279 .\" .Sh BUGS
 280 .Sh HISTORY
 281 The
 282 .Nm
 283 command appeared in
 284 .Fx 2.1 .