From 19da58be2d9359a9641381feb559be0b918ef710 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Mon, 15 Apr 2024 22:46:53 +0200 Subject: Adding upstream version 1:4.13+dfsg1. Signed-off-by: Daniel Baumann --- man/usermod.8.xml | 647 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 647 insertions(+) create mode 100644 man/usermod.8.xml (limited to 'man/usermod.8.xml') diff --git a/man/usermod.8.xml b/man/usermod.8.xml new file mode 100644 index 0000000..7e1342c --- /dev/null +++ b/man/usermod.8.xml @@ -0,0 +1,647 @@ + + + + + + + + + + +]> + + + + + Julianne Frances + Haugh + Creation, 1991 + + + Thomas + Kłoczko + kloczek@pld.org.pl + shadow-utils maintainer, 2000 - 2007 + + + Nicolas + François + nicolas.francois@centraliens.net + shadow-utils maintainer, 2007 - now + + + + usermod + 8 + System Management Commands + shadow-utils + &SHADOW_UTILS_VERSION; + + + usermod + modify a user account + + + + + usermod + + options + + LOGIN + + + + + DESCRIPTION + + The usermod command modifies the system account + files. + + + + + OPTIONS + + The options which apply to the usermod command + are: + + + + + , + + + + Add the user to the supplementary group(s). Use only with the + option. + + + + + + , + + + + Allow names that do not conform to standards. + + + + + + ,  COMMENT + + + + update the comment field of the user in /etc/passwd + , which is normally modified using the + chfn1 + utility. + + + + + + ,  HOME_DIR + + + + The user's new login directory. + + + If the + option is given, the contents of the current home directory will + be moved to the new home directory, which is created if it does + not already exist. If the current home directory does not exist + the new home directory will not be created. + + + + + + ,  EXPIRE_DATE + + + + The date on which the user account will be disabled. The + date is specified in the format + YYYY-MM-DD. Integers as input are + interpreted as days after 1970-01-01. + + + An input of -1 or an empty string will blank the account + expiration field in the shadow password file. The account + will remain available with no date limit. + + + This option requires a /etc/shadow file. + A /etc/shadow entry will be created if + there were none. + + + + + + ,  INACTIVE + + + + defines the number of days after the password exceeded its maximum + age during which the user may still login by immediately replacing + the password. This grace period before the account becomes inactive + is stored in the shadow password file. An input of 0 will disable an + expired password with no delay. An input of -1 will blank the + respective field in the shadow password file. See + shadow5 + for more information. + + + This option requires a /etc/shadow file. + A /etc/shadow entry will be created if + there were none. + + + + + + ,  GROUP + + + + The name or numerical ID of the user's new primary group. + The group must exist. + + + Any file from the user's home directory owned by the previous + primary group of the user will be owned by this new group. + + + The group ownership of files outside of the user's home directory + must be fixed manually. + + + The change of the group ownership of files inside of the user's + home directory is also not done if the home dir owner uid is + different from the current or new user id. This is a safety measure + for special home directories such as /. + + + + + + ,  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 must exist. + + + If the user is currently a member of a group which is + not listed, the user will be removed from the group. This + behaviour can be changed via the option, which + appends the user to the current supplementary group list. + + + + + + ,  NEW_LOGIN + + + + The name of the user will be changed from + LOGIN to + NEW_LOGIN. Nothing else is changed. In + particular, the user's home directory or mail spool should + probably be renamed manually to reflect the new login name. + + + + + + , + + + + Lock a user's password. This puts a '!' in front of the + encrypted password, effectively disabling the password. You + can't use this option with or + . + + + Note: if you wish to lock the account (not only access with a + password), you should also set the + EXPIRE_DATE to + 1. + + + + + + , + + + + moves the content of the user's home directory to the new + location. If the current home directory does not exist + the new home directory will not be created. + + + This option is only valid in combination with the + (or ) option. + + + usermod will try to adapt the ownership of the + files and to copy the modes, ACL and extended attributes, but + manual changes might be needed afterwards. + + + + + + , + + + + allows to change the user ID to a non-unique value. + + + This option is only valid in combination with the + option. As a user identity + serves as + key to map between users on one hand and permissions, file + ownerships and other aspects that determine the system's + behavior on the other hand, more than one login name + will access the account of the given UID. + + + + + + ,  PASSWORD + + + + defines a new password for the user. PASSWORD is expected to + be encrypted, as returned by crypt + 3. + + + Note: Avoid this option on the + command line because the password (or encrypted password) will + be visible by users listing the processes. + + + The password will be written in the local + /etc/passwd or + /etc/shadow file. This might differ from the + password database configured in your PAM configuration. + + + You should make sure the password respects the system's + password policy. + + + + + + , + + + + Remove the user from named supplementary group(s). Use only with the + option. + + + + + + ,  CHROOT_DIR + + + + Apply changes in the CHROOT_DIR + directory and use the configuration files from the + CHROOT_DIR directory. + Only absolute paths are supported. + + + + + + ,  PREFIX_DIR + + + + Apply changes within the directory tree starting with + PREFIX_DIR and use as well the + configuration files located there. This option does not + chroot and is intended for preparing a cross-compilation + target. Some limitations: NIS and LDAP users/groups are + not verified. PAM authentication is using the host + files. No SELINUX support. + + + + + + ,  SHELL + + + + changes the user's login shell. An empty string for SHELL blanks the + field in /etc/passwd and logs the user into the + system's default shell. + + + + + + ,  UID + + + + The new value of the user's ID. + + + This value must be unique, + unless the option is used. The value must be + non-negative. + + + The user's mailbox, and any files which the user owns and which are + located in the user's home + directory will have the file user ID changed automatically. + + + The ownership of files outside of the user's home directory + must be fixed manually. + + + The change of the user ownership of files inside of the user's + home directory is also not done if the home dir owner uid is + different from the current or new user id. This is a safety measure + for special home directories such as /. + + + No checks will be performed with regard to the + , , + , or + from /etc/login.defs. + + + + + + , + + + + Unlock a user's password. This removes the '!' in front of the + encrypted password. You can't use this option with + or . + + + Note: if you wish to unlock the account (not only access with a + password), you should also set the + EXPIRE_DATE (for example to + 99999, or to the + value from + /etc/default/useradd). + + + + + + ,  FIRST-LAST + + + + Add a range of subordinate uids to the user's account. + + + This option may be specified multiple times to add multiple ranges to a user's account. + + + No checks will be performed with regard to + , , or + from /etc/login.defs. + + + + + + ,  FIRST-LAST + + + + Remove a range of subordinate uids from the user's account. + + + This option may be specified multiple times to remove multiple ranges to a user's account. + When both and are specified, + the removal of all subordinate uid ranges happens before any subordinate uid range is added. + + + No checks will be performed with regard to + , , or + from /etc/login.defs. + + + + + + ,  FIRST-LAST + + + + Add a range of subordinate gids to the user's account. + + + This option may be specified multiple times to add multiple ranges to a user's account. + + + No checks will be performed with regard to + , , or + from /etc/login.defs. + + + + + + ,  FIRST-LAST + + + + Remove a range of subordinate gids from the user's account. + + + This option may be specified multiple times to remove multiple ranges to a user's account. + When both and are specified, + the removal of all subordinate gid ranges happens before any subordinate gid range is added. + + + No checks will be performed with regard to + , , or + from /etc/login.defs. + + + + + + ,  SEUSER + + + + defines the SELinux user to be mapped with + LOGIN. An empty string ("") + will remove the respective entry (if any). Note that the + shadow system doesn't store the selinux-user, it uses + semanage(8) for that. + + + + + + + + CAVEATS + + You must make certain that the named user is + not executing any processes when this command is being executed if the + user's numerical user ID, the user's name, or the user's home + directory is being changed. usermod checks this + on Linux. On other operating systems it only uses utmp to check if + the user is logged in. + + + You must change the owner of any crontab files or + at jobs manually. + + + You must make any changes involving NIS on the NIS server. + + + + + CONFIGURATION + + The following configuration variables in + /etc/login.defs change the behavior of this + tool: + + + &LASTLOG_UID_MAX; + &MAIL_DIR; + &MAX_MEMBERS_PER_GROUP; + &SUB_GID_COUNT; + &SUB_UID_COUNT; + &TCB_SYMLINKS; + &USE_TCB; + + + + + FILES + + + /etc/group + + Group account information + + + + /etc/gshadow + + Secure group account informatio. + + + + /etc/login.defs + + Shadow password suite configuration + + + + /etc/passwd + + User account information + + + + /etc/shadow + + Secure user account information + + + + /etc/subgid + + Per user subordinate group IDs + + + + /etc/subuid + + Per user subordinate user IDs + + + + + + + SEE ALSO + + + chfn1 + , + + chsh1 + , + + passwd1 + , + + crypt3 + , + + gpasswd8 + , + + groupadd8 + , + + groupdel8 + , + + groupmod8 + , + + login.defs5 + , + + + subgid5 + , + + subuid5 + , + + + useradd8 + , + + userdel8 + . + + + -- cgit v1.2.3