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.15 1996/12/23 00:57:46 mpp Exp $
  26 .Dd Jan, 9, 1995
  27 .Dt ADDUSER 8
  28 .Os FreeBSD 2.1
  29 .Sh NAME
  30 .Nm adduser
  31 .Nd command for adding new users
  32 .Sh SYNOPSIS
  33 .Nm adduser
  34 .Oo
  35 .Fl batch Ar username
  36 .Op Ar group Ns , Ns Op Ar group,...
  37 .Op Ar fullname
  38 .Op Ar password
  39 .Oc
  40 .Op Fl check_only
  41 .Op Fl config_create
  42 .Op Fl dotdir Ar dotdir
  43 .Op Fl group Ar login_group
  44 .Op Fl h | help
  45 .Op Fl home Ar home
  46 .Op Fl message Ar message_file
  47 .Op Fl noconfig
  48 .Op Fl shell Ar shell
  49 .Op Fl s | silent | q | quiet
  50 .Op Fl uid Ar uid_start
  51 .Op Fl v | verbose
  52 .Sh DESCRIPTION
  53 .Nm Adduser
  54 is a simple program for adding new users. Adduser checks
  55 the passwd, group and shell databases. It creates passwd/group entries,
  56 HOME-directory, dotfiles and sends the new user a welcome message.
  57 .Sh RESTRICTIONS
  58 .Bl -tag -width Ds -compact
  59 .It Sy username
  60 Login name. May contain only  lowercase characters or digits. Maximum length
  61 is 16 characters (see
  62 .Xr setlogin 2
  63 BUGS section).
  64 The reasons for this limit are "Historical".
  65 Given that people have traditionally wanted to break this
  66 limit for aesthetic reasons, it's never been of great importance to break
  67 such a basic fundamental parameter in UNIX.
  68 You can change
  69 .Dv UT_NAMESIZE
  70 in
  71 .Pa /usr/include/utmp.h
  72 and recompile the
  73 world; people have done this and it works, but you will have problems
  74 with any precompiled programs, or source that assumes the 8-character
  75 name limit and NIS. The NIS protocol mandates an 8-character username.
  76 If you need a longer login name for e-mail addresses,
  77 you can define an alias in
  78 .Pa /etc/aliases .
  79 .It Sy fullname
  80 Firstname and surname.
  81 The
  82 .Ql Pa \:
  83 character is not allowed.
  84 .It Sy shell
  85 Only valid shells from the shell database or sliplogin and pppd
  86 .It Sy uid
  87 Automatically generated or your choice, must be less than 32000.
  88 .It Sy gid/login group
  89 Your choice or automatically generated.
  90 .It Sy password
  91 If not empty, password is encoded with
  92 .Xr crypt 3 .
  93 .El
  94 .Sh UNIQUE GROUPS
  95 Perhaps you're missing what
  96 .Em can
  97 be done with this scheme that falls apart
  98 with most other schemes.  With each user in his/her own group the user can
  99 safely run with a umask of 002 and have files created in their home directory
 100 and not worry about others being able to read them.
 101 .Pp
 102 For a shared area you create a separate uid/gid (like cvs or ncvs on freefall),
 103 you place each person that should be able to access this area into that new
 104 group.
 105 .Pp
 106 This model of uid/gid administration allows far greater flexibility than lumping
 107 users into groups and having to muck with the umask when working in a shared
 108 area.
 109 .Pp
 110 I have been using this model for almost 10 years and found that it works
 111 for most situations, and has never gotten in the way.  (Rod Grimes)
 112 .Sh CONFIGURATION
 113 .Bl -tag -width Ds -compact
 114 .It Sy 1.
 115 Read intern variables.
 116 .It Sy 2.
 117 Read config file (/etc/adduser.conf)
 118 .It Sy 3.
 119 Parse command line options
 120 .El
 121 .Sh OPTIONS
 122 .Bl -tag -width Ds
 123 .It Sy -batch username [group[,group]...] [fullname] [password]
 124 Batch mode.
 125 .It Sy -check_only
 126 Check /etc/passwd, /etc/group, /etc/shells and exit.
 127 .It Sy -create_config
 128 Create new config and message file and exit.
 129 .It Sy -dotdir Ar directory
 130 Copy files from
 131 .Ar directory
 132 into the HOME-directory of new users,
 133 .Ql Pa dot.foo
 134 files renamed to
 135 .Ql Pa .foo .
 136 Don't copy files if
 137 .Ar directory
 138 specified is equal to
 139 .Ar no .
 140 For security make all files writable and readable for owner,
 141 don't allow group or world to write files and allow only owner
 142 to read/execute/write
 143 .Pa .rhost ,
 144 .Pa .Xauthority ,
 145 .Pa .kermrc ,
 146 .Pa .netrc ,
 147 .Pa Mail ,
 148 .Pa prv ,
 149 .Pa iscreen ,
 150 .Pa term .
 151 .It Sy -group Ar login_group
 152 Login group.
 153 .Ar USER
 154 means use username as login group.
 155 .It Sy -help,-h,-?
 156 Print options and exit.
 157 .It Sy -home Ar partition
 158 Default home partition where all users located.
 159 .It Sy -message Ar file
 160 Send new users a welcome message.
 161 Don't send message if
 162 .Ar file
 163 equal with
 164 .Ar no .
 165 .It Sy -noconfig
 166 Do not read config file.
 167 .It Sy -shell Ar shell
 168 Default shell for new users.
 169 .It Sy -silent,-s,-quiet,-q
 170 Few warnings, questions, bug reports.
 171 .It Sy -uid Ar uid
 172 Use uid's from
 173 .Ar uid
 174 on up.
 175 .It Sy -verbose,-v
 176 Many warnings, questions. Recommended for novice users.
 177 .Sh FORMATS
 178 .Bl -tag -width Ds -compact
 179 .Ql Pa #
 180 is a comment.
 181 .It Sy config file
 182 .Nm Adduser
 183 reads and writes this file.
 184 See
 185 .Pa /etc/adduser.conf
 186 for more details.
 187 .It Sy message file
 188 Eval variables in this file. See
 189 .Pa /etc/adduser.message
 190 for more
 191 details.
 192 .El
 193 .Sh EXAMPLES
 194 .Pp
 195 $ adduser
 196 .Pp
 197 Start adduser in interactive mode.
 198 .Pp
 199 $ adduser -batch baerenklau guest,staff,baer 'Teddy II' qwerty7
 200 .Pp
 201 Create user 'baerenklau' and  login group 'baerenklau'. Invite user
 202 baerenklau into groups guest, staff and baer. Realname (fullname)
 203 is 'Teddy II'. Password is 'qwerty7' (don't use such passwords!). Create
 204 HOME directory
 205 .Pa /home/baerenklau
 206 and copy all files and directories
 207 from
 208 .Pa /usr/share/skel
 209 to
 210 .Pa /home/baerenklau .
 211 Send user baerenklau
 212 a welcome message.
 213 .Pp
 214 $ adduser -uid 5000 -group guest -message no -batch vehlefanz
 215 .Pp
 216 Create user 'vehlefanz'. Login group is guest. Uid next available uid
 217 after 5000, for instance 5007. No other groups, no realname, no password.
 218 Do not send a welcome message.
 219 .Sh FILES
 220 .Bl -tag -width /etc/master.passwdxx -compact
 221 .It Pa /etc/master.passwd
 222 user database
 223 .It Pa /etc/group
 224 group database
 225 .It Pa /etc/shells
 226 shell database
 227 .It Pa /etc/adduser.conf
 228 config file for adduser
 229 .It Pa /etc/adduser.message
 230 message file for adduser
 231 .It Pa /usr/share/skel
 232 skeletal login directory
 233 .It Pa /var/log/adduser
 234 logfile for adduser
 235 .El
 236 .Sh SEE ALSO
 237 .Xr chpass 1 ,
 238 .Xr finger 1 ,
 239 .Xr passwd 1 ,
 240 .Xr setlogin 2 ,
 241 .Xr yp 4 ,
 242 .Xr aliases 5 ,
 243 .Xr passwd 5 ,
 244 .Xr group 5 ,
 245 .Xr shells 5 ,
 246 .Xr addgroup 8 ,
 247 .Xr pwd_mkdb 8 ,
 248 .Xr rmgroup 8 ,
 249 .Xr rmuser 8 ,
 250 .Xr vipw 8
 251 .\" .Sh BUGS
 252 .Sh HISTORY
 253 The
 254 .Nm
 255 command appeared in
 256 .Fx 2.1 .