useradd8System Management Commandsuseraddcreate a new user or update default new user informationuseraddoptionsLOGINuseradd-D useradd-D optionsDESCRIPTION
When invoked without the option, the
useradd command creates a new user account using
the values specified on the command line plus the default values from
the system. Depending on command line options, the
useradd command
will update system files and may also create the new user's home
directory and copy initial files.
OPTIONSThe options which apply to the useradd command are:
,
COMMENT
Any text string. It is generally a short description of the
login, and is currently used as the field for the user's full
name.
,
BASE_DIR
The default base directory for the system if
dir is not specified. BASE_DIR is
concatenated with the account name to define the home directory.
If the option is not used,
BASE_DIR must exist.
See below, the subsection "Changing the default values".
,
HOME_DIR
The new user will be created using
HOME_DIR as the value for the user's
login directory. The default is to append the
LOGIN name to
BASE_DIR and use that as the login
directory name. The directory HOME_DIR
does not have to exist but will not be created if it is missing.
,
EXPIRE_DATE
The date on which the user account will be disabled. The date is
specified in the format YYYY-MM-DD.
,
INACTIVE
The number of days after a password expires until the account is
permanently disabled. A value of 0 disables the account as soon
as the password has expired, and a value of -1 disables the
feature. The default value is -1.
,
GROUP
The group name or number of the user's initial login group. The
group name must exist. A group number must refer to an already
existing group. The default group number is 1 or whatever is
specified in /etc/default/useradd.
,
GROUP1[,GROUP2,...[,GROUPN]]]
A list of supplementary groups which the user is also a member
of. Each group is separated from the next by a comma, with no
intervening whitespace. The groups are subject to the same
restrictions as the group given with the
option. The default is for the user to belong only to the
initial group.
, Display help message and exit.
,
The user's home directory will be created if it does not exist.
The files contained in SKEL_DIR will
be copied to the home directory if the
option is used, otherwise the files contained in
/etc/skel will be used instead. Any
directories contained in SKEL_DIR or
/etc/skel will be created in the user's
home directory as well. The option is only
valid in conjunction with the option. The
default is to not create the directory and to not copy any
files.
,
KEY=VALUE
Overrides /etc/login.defs defaults (UID_MIN, UID_MAX, UMASK,
PASS_MAX_DAYS and others).
Example: PASS_MAX_DAYS=-1
can be used when creating system account to turn off password
ageing, even though system account has no password at all.
Multiple options can be specified, e.g.:
UID_MIN=100UID_MAX=499
Note:
UID_MIN=10,UID_MAX=499
doesn't work yet.
,
Allow the creation of a user account with a duplicate (non-unique) UID.
,
PASSWORD
The encrypted password, as returned by crypt3. The default is to disable the account.
,
SHELL
The name of the user's login shell. The default is to leave this
field blank, which causes the system to select the default login
shell.
,
UID
The numerical value of the user's ID. This value must be unique,
unless the option is used. The value must be
non-negative. The default is to use the smallest ID value
greater than 999 and greater than every other user. Values
between 0 and 999 are typically reserved for system accounts.
Changing the default values
When invoked with only the option,
useradd will display the current default values.
When invoked with plus other options,
useradd will update the default values for the
specified options. Valid default-changing options are:
,
BASE_DIR
The path prefix for a new user's home directory. The
user's name will be affixed to the end of
BASE_DIR to form the new user's
home directory name, if the option is not used
when creating a new account.
,
EXPIRE_DATEThe date on which the user account is disabled.
,
INACTIVE
The number of days after a password has expired before the
account will be disabled.
,
GROUP
The group name or ID for a new user's initial group. The named
group must exist, and a numerical group ID must have an
existing entry.
,
SHELL
The name of a new user's login shell.
NOTESThe system administrator is responsible for placing the default
user files in the /etc/skel/ directory.
CAVEATS
You may not add a user to a NIS group. This must be performed on the
NIS server.
Similarly, if the username already exists in an external user
database such as NIS, useradd will deny
the user account creation request.
Usernames must begin with a lower case letter or an underscore, and
only lower case letters, underscores, dashes, and dollar signs may
follow. In regular expression terms: [a-z_][a-z0-9_-]*[$]
FILES/etc/passwdUser account information./etc/shadowSecure user account information./etc/groupGroup account information./etc/default/useraddDefault values for account creation./etc/skel/Directory containing default files./etc/login.defsShadow password suite configuration.EXIT VALUES
The useradd command exits with the following values:
0success1can't update password file2invalid command syntax3invalid argument to option4UID already in use (and no )6specified group doesn't exist9username already in use10can't update group file12can't create home directory13can't create mail spoolSEE ALSOchfn1,
chsh1,
passwd1,
crypt3,
groupadd8,
groupdel8,
groupmod8,
login.defs5,
newusers8,
userdel8,
usermod8.