UserAdd

comment

Comment (GECOS field)

The new user's password file comment field.

Default value:

home_dir

Home directory

The new user will be created using home_dir as the value for the user's login directory.

Default value:

expire_date

Expire date

The date on which the user account will be disabled. The date is specified in the format YYYY-MM-DD.

Default value:

inactive_days

Inactive days

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.

Default value: -1

initial_group

Initial 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.

Default value: 1

extra_groups

Supplementary groups

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 initial_group option. The default is for the user to belong only to the initial group.

Default value:

create_home_dir

Home directories creation

The user's home directory will be created if it does not exist. The files contained in skeleton_dir will be copied to the home directory if the skeleton_dir option is used, otherwise the files contained in /etc/skel will be used instead. Any directories contained in skeleton_dir or /etc/skel will be created in the user's home directory as well. The default is to not create the directory and to not copy any files.

Default value: no

home_dir_mode

Numeric access mode to use when creating the directory

User's home directory will be created with a given permissions. (TODO: Elaborate more on that.)

Default value: 0751

skeleton_dir

Skeleton directory

Files contained is directory pointed by this option will be copied to the user's home directory. This option is only valid in conjunction with the create_home_dir option.

Default value: /etc/skel

allow_duplicate_uid

Duplicate uid

Allow create user with duplicate (non-unique) UID.

Default value: no

password

Password

The encrypted password, as returned by crypt(3). The default is to disable the account.

Default value: !

shell

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.

Default value:

uid

User ID

The numerical value of the user's ID. This value must be unique, unless the allow_duplicate_uid option is used. The value must be non-negative. The default is to use the smallest ID value greater than 99 and greater than every other user. Values between 0 and 99 are typically reserved for system accounts.

Default value: