diff options
Diffstat (limited to 'upstream/opensuse-tumbleweed/man1/homectl.1')
| -rw-r--r-- | upstream/opensuse-tumbleweed/man1/homectl.1 | 156 |
1 files changed, 155 insertions, 1 deletions
diff --git a/upstream/opensuse-tumbleweed/man1/homectl.1 b/upstream/opensuse-tumbleweed/man1/homectl.1 index 8fef25a2..399258ac 100644 --- a/upstream/opensuse-tumbleweed/man1/homectl.1 +++ b/upstream/opensuse-tumbleweed/man1/homectl.1 @@ -1,5 +1,5 @@ '\" t -.TH "HOMECTL" "1" "" "systemd 254" "homectl" +.TH "HOMECTL" "1" "" "systemd 255" "homectl" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -161,6 +161,8 @@ read the user record from standard input\&. The supplied JSON object must follow and \fBupdate\fR commands (see below), where it allows configuring the user record in JSON as\-is, instead of setting the individual user record properties (see below)\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-json=\fR\fIFORMAT\fR, \fB\-j\fR @@ -184,6 +186,8 @@ option picks when run interactively and "short" otherwise\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-export\-format=\fR\fIFORMAT\fR, \fB\-E\fR, \fB\-EE\fR @@ -209,6 +213,8 @@ to mode will retain the original cryptographic signatures and thus may only be modified when the private key to update them is available on the destination machine\&. When replicating users in "minimal" mode, the signature is removed during the replication and thus the record will be implicitly signed with the key of the destination machine and may be updated there without any private key replication\&. +.sp +Added in version 245\&. .RE .PP \fB\-H\fR, \fB\-\-host=\fR @@ -273,11 +279,15 @@ commands for configuring various aspects of the home directory and the user acco \fB\-\-real\-name=\fR\fINAME\fR, \fB\-c\fR \fINAME\fR .RS 4 The real name for the user\&. This corresponds with the GECOS field on classic UNIX NSS records\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-realm=\fR\fIREALM\fR .RS 4 The realm for the user\&. The realm associates a user with a specific organization or installation, and allows distinguishing users of the same name defined in different contexts\&. The realm can be any string that also qualifies as valid DNS domain name, and it is recommended to use the organization\*(Aqs or installation\*(Aqs domain name for this purpose, but this is not enforced nor required\&. On each system only a single user of the same name may exist, and if a user with the same name and realm is seen it is assumed to refer to the same user while a user with the same name but different realm is considered a different user\&. Note that this means that two users sharing the same name but with distinct realms are not allowed on the same system\&. Assigning a realm to a user is optional\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-email\-address=\fR\fIEMAIL\fR @@ -285,6 +295,8 @@ The realm for the user\&. The realm associates a user with a specific organizati Takes an electronic mail address to associate with the user\&. On log\-in the \fI$EMAIL\fR environment variable is initialized from this value\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-location=\fR\fITEXT\fR @@ -293,12 +305,16 @@ Takes location specification for this user\&. This is free\-form text, which mig \fB\-\-location="Berlin, Germany"\fR or \fB\-\-location="Basement, Room 3a"\fR +.sp +Added in version 245\&. .RE .PP \fB\-\-icon\-name=\fR\fIICON\fR .RS 4 Takes an icon name to associate with the user, following the scheme defined by the \m[blue]\fBIcon Naming Specification\fR\m[]\&\s-2\u[2]\d\s+2\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-home\-dir=\fR\fIPATH\fR, \fB\-d\fR\fIPATH\fR @@ -307,6 +323,8 @@ Takes a path to use as home directory for the user\&. Note that this is the dire \fB\-\-image\-path=\fR for that\&. If not specified defaults to /home/$USER\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-uid=\fR\fIUID\fR @@ -321,6 +339,8 @@ Note that changing this option for existing home directories generally has no ef Note that users managed by \fBsystemd\-homed\fR always have a matching group associated with the same name as well as a GID matching the UID of the user\&. Thus, configuring the GID separately is not permitted\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-member\-of=\fR\fIGROUP\fR, \fB\-G\fR \fIGROUP\fR @@ -331,6 +351,8 @@ to provide the user with administrator privileges\&. Note that \fBsystemd\-homed\fR does not manage any groups besides a group matching the user in name and numeric UID/GID\&. Thus any groups listed here must be registered independently, for example with \fBgroupadd\fR(8)\&. Any non\-existent groups are ignored\&. This option may be used more than once, in which case all specified group lists are combined\&. If the user is currently a member of a group which is not listed, the user will be removed from the group\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-capability\-bounding\-set=\fR\fICAPABILITIES\fR, \fB\-\-capability\-ambient\-set=\fR\fICAPABILITIES\fR @@ -342,18 +364,24 @@ These options take a space separated list of process capabilities (e\&.g\&. for details on the capabilities concept\&. These options may be used more than once, in which case the specified lists are combined\&. If the parameter begins with a "~" character the effect is inverted: the specified capability is dropped from the specific set\&. +.sp +Added in version 254\&. .RE .PP \fB\-\-skel=\fR\fIPATH\fR .RS 4 Takes a file system path to a directory\&. Specifies the skeleton directory to initialize the home directory with\&. All files and directories in the specified path are copied into any newly create home directory\&. If not specified defaults to /etc/skel/\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-shell=\fR\fISHELL\fR .RS 4 Takes a file system path\&. Specifies the shell binary to execute on terminal logins\&. If not specified defaults to /bin/bash\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-setenv=\fR\fIVARIABLE\fR[=\fIVALUE\fR] @@ -369,6 +397,8 @@ Note that a number of other settings also result in environment variables to be \fB\-\-timezone=\fR and \fB\-\-language=\fR\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-timezone=\fR\fITIMEZONE\fR @@ -381,6 +411,8 @@ will result in the environment variable "TZ=:Europe/Amsterdam"\&. (":" is used intentionally as part of the timezone specification, see \fBtzset\fR(3)\&.) +.sp +Added in version 245\&. .RE .PP \fB\-\-language=\fR\fILANG\fR @@ -389,6 +421,8 @@ Takes a specifier indicating the preferred language of the user\&. The \fI$LANG\fR environment variable is initialized from this value on login, and thus a value suitable for this environment variable is accepted here, for example \fB\-\-language=de_DE\&.UTF8\fR\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-ssh\-authorized\-keys=\fR\fIKEYS\fR @@ -396,6 +430,8 @@ environment variable is initialized from this value on login, and thus a value s Either takes a SSH authorized key line to associate with the user record or a "@" character followed by a path to a file to read one or more such lines from\&. SSH keys configured this way are made available to SSH to permit access to this home directory and user record\&. This option may be used more than once to configure multiple SSH keys\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-pkcs11\-token\-uri=\fR\fIURI\fR @@ -417,6 +453,8 @@ Note that many hardware security tokens implement both PKCS#11/PIV and FIDO2 wit extension (for example: the YubiKey 5 series), as supported with the \fB\-\-fido2\-device=\fR option below\&. Both mechanisms are similarly powerful, though FIDO2 is the more modern technology\&. PKCS#11/PIV tokens have the benefit of being recognizable before authentication and hence can be used for implying the user identity to use for logging in, which FIDO2 does not allow\&. PKCS#11/PIV devices generally require initialization (i\&.e\&. storing a private/public key pair on them, see example below) before they can be used; FIDO2 security tokens generally do not required that, and work out of the box\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-fido2\-credential\-algorithm=\fR\fISTRING\fR @@ -436,6 +474,8 @@ denotes 2048\-bit RSA with PKCS#1\&.5 padding and SHA\-256\&. denotes EDDSA over Curve25519 with SHA\-512\&. .sp Note that your authenticator may not support some algorithms\&. +.sp +Added in version 251\&. .RE .PP \fB\-\-fido2\-device=\fR\fIPATH\fR @@ -470,6 +510,8 @@ Note that many hardware security tokens implement both FIDO2 and PKCS#11/PIV (an \fB\-\-fido2\-device=\fR or \fB\-\-pkcs11\-token\-uri=\fR), for a discussion see above\&. +.sp +Added in version 246\&. .RE .PP \fB\-\-fido2\-with\-client\-pin=\fR\fIBOOL\fR @@ -480,6 +522,8 @@ feature)\&. Defaults to "yes"\&. (Note: this setting is without effect if the security token does not support the "clientPin" feature at all, or does not allow enabling or disabling it\&.) +.sp +Added in version 249\&. .RE .PP \fB\-\-fido2\-with\-user\-presence=\fR\fIBOOL\fR @@ -490,6 +534,8 @@ feature) when unlocking the account\&. Defaults to "yes"\&. (Note: this setting is without effect if the security token does not support the "up" feature at all, or does not allow enabling or disabling it\&.) +.sp +Added in version 249\&. .RE .PP \fB\-\-fido2\-with\-user\-verification=\fR\fIBOOL\fR @@ -500,16 +546,22 @@ feature)\&. Defaults to "no"\&. (Note: this setting is without effect if the security token does not support the "uv" feature at all, or does not allow enabling or disabling it\&.) +.sp +Added in version 249\&. .RE .PP \fB\-\-recovery\-key=\fR\fIBOOL\fR .RS 4 Accepts a boolean argument\&. If enabled a recovery key is configured for the account\&. A recovery key is a computer generated access key that may be used to regain access to an account if the password has been forgotten or the authentication token lost\&. The key is generated and shown on screen, and should be printed or otherwise transferred to a secure location\&. A recovery key may be entered instead of a regular password to unlock the account\&. +.sp +Added in version 247\&. .RE .PP \fB\-\-locked=\fR\fIBOOLEAN\fR .RS 4 Takes a boolean argument\&. Specifies whether this user account shall be locked\&. If true logins into this account are prohibited, if false (the default) they are permitted (of course, only if authorization otherwise succeeds)\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-not\-before=\fR\fITIMESTAMP\fR, \fB\-\-not\-after=\fR\fITIMESTAMP\fR @@ -517,17 +569,23 @@ Takes a boolean argument\&. Specifies whether this user account shall be locked\ These options take a timestamp string, in the format documented in \fBsystemd.time\fR(7) and configures points in time before and after logins into this account are not permitted\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-rate\-limit\-interval=\fR\fISECS\fR, \fB\-\-rate\-limit\-burst=\fR\fINUMBER\fR .RS 4 Configures a rate limit on authentication attempts for this user\&. If the user attempts to authenticate more often than the specified number, on a specific system, within the specified time interval authentication is refused until the time interval passes\&. Defaults to 10 times per 1min\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-password\-hint=\fR\fITEXT\fR .RS 4 Takes a password hint to store alongside the user record\&. This string is stored accessible only to privileged users and the user itself and may not be queried by other users\&. Example: \fB\-\-password\-hint="My first pet\*(Aqs name"\fR\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-enforce\-password\-policy=\fR\fIBOOL\fR, \fB\-P\fR @@ -536,11 +594,15 @@ Takes a boolean argument\&. Configures whether to enforce the system\*(Aqs passw \fB\-P\fR is short for \fB\-\-\-enforce\-password\-policy=no\fR\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-password\-change\-now=\fR\fIBOOL\fR .RS 4 Takes a boolean argument\&. If true the user is asked to change their password on next login\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-password\-change\-min=\fR\fITIME\fR, \fB\-\-password\-change\-max=\fR\fITIME\fR, \fB\-\-password\-change\-warn=\fR\fITIME\fR, \fB\-\-password\-change\-inactive=\fR\fITIME\fR @@ -557,6 +619,8 @@ specifies how much earlier than then the time configured with the user is warned at login to change their password as it will expire soon\&. Finally \fB\-\-password\-change\-inactive=\fR configures the time which has to pass after the password as expired until the user is not permitted to log in or change the password anymore\&. Note that these options only apply to password authentication, and do not apply to other forms of authentication, for example PKCS#11\-based security token authentication\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-disk\-size=\fR\fIBYTES\fR @@ -570,22 +634,30 @@ or assigns the minimal disk space permitted by the constraints of the backing file system and other limits, when specified as "max" assigns the maximum disk space available\&. If the LUKS2 backend is used this configures the size of the loopback file and file system contained therein\&. For the other storage backends configures disk quota using the filesystem\*(Aqs native quota logic, if available\&. If not specified, defaults to 85% of the available disk space for the LUKS2 backend and to no quota for the others\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-access\-mode=\fR\fIMODE\fR .RS 4 Takes a UNIX file access mode written in octal\&. Configures the access mode of the home directory itself\&. Note that this is only used when the directory is first created, and the user may change this any time afterwards\&. Example: \fB\-\-access\-mode=0700\fR +.sp +Added in version 245\&. .RE .PP \fB\-\-umask=\fR\fIMASK\fR .RS 4 Takes the access mode mask (in octal syntax) to apply to newly created files and directories of the user ("umask")\&. If set this controls the initial umask set for all login sessions of the user, possibly overriding the system\*(Aqs defaults\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-nice=\fR\fINICE\fR .RS 4 Takes the numeric scheduling priority ("nice level") to apply to the processes of the user at login time\&. Takes a numeric value in the range \-20 (highest priority) to 19 (lowest priority)\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-rlimit=\fR\fILIMIT\fR=\fIVALUE\fR[:\fIVALUE\fR] @@ -594,6 +666,8 @@ Allows configuration of resource limits for processes of this user, see \fBgetrlimit\fR(2) for details\&. Takes a resource limit name (e\&.g\&. "LIMIT_NOFILE") followed by an equal sign, followed by a numeric limit\&. Optionally, separated by colon a second numeric limit may be specified\&. If two are specified this refers to the soft and hard limits, respectively\&. If only one limit is specified the setting sets both limits in one\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-tasks\-max=\fR\fITASKS\fR @@ -608,6 +682,8 @@ setting of the per\-user systemd slice unit user\-$UID\&.slice\&. See \fBsystemd.resource-control\fR(5) for further details\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-memory\-high=\fR\fIBYTES\fR, \fB\-\-memory\-max=\fR\fIBYTES\fR @@ -620,6 +696,8 @@ settings of the per\-user systemd slice unit user\-$UID\&.slice\&. See \fBsystemd.resource-control\fR(5) for further details\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-cpu\-weight=\fR\fIWEIGHT\fR, \fB\-\-io\-weight=\fR\fIWEIGHT\fR @@ -632,6 +710,8 @@ settings of the per\-user systemd slice unit user\-$UID\&.slice\&. See \fBsystemd.resource-control\fR(5) for further details\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-storage=\fR\fISTORAGE\fR @@ -644,6 +724,8 @@ Selects the storage mechanism to use for this home directory\&. Takes one of "cifs"\&. For details about these mechanisms, see above\&. If a new home directory is created and the storage type is not specifically specified, \fBhomed.conf\fR(5) defines which default storage to use\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-image\-path=\fR\fIPATH\fR @@ -657,11 +739,15 @@ when LUKS storage is used and for the other storage mechanisms\&. Not defined for the "cifs" storage mechanism\&. To use LUKS2 storage on a regular block device (for example a USB stick) pass the path to the block device here\&. Specifying the path to a directory here when using LUKS2 storage is not allowed\&. Similar, specifying the path to a regular file or device node is not allowed if any of the other storage backends are used\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-drop\-caches=\fR\fIBOOL\fR .RS 4 Automatically flush OS file system caches on logout\&. This is useful in combination with the fscrypt storage backend to ensure the OS does not keep decrypted versions of the files and directories in memory (and accessible) after logout\&. This option is also supported on other backends, but should not bring any benefit there\&. Defaults to off, except if the selected storage backend is fscrypt, where it defaults to on\&. Note that flushing OS caches will negatively influence performance of the OS shortly after logout\&. +.sp +Added in version 250\&. .RE .PP \fB\-\-fs\-type=\fR\fITYPE\fR @@ -674,6 +760,8 @@ When LUKS2 storage is used configures the file system type to use inside the hom defines which default file system type to use\&. Note that "xfs" is not recommended as its support for file system resizing is too limited\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-luks\-discard=\fR\fIBOOL\fR @@ -681,6 +769,8 @@ is not recommended as its support for file system resizing is too limited\&. When LUKS2 storage is used configures whether to enable the "discard" feature of the file system\&. If enabled the file system on top of the LUKS2 volume will report empty block information to LUKS2 and the loopback file below, ensuring that empty space in the home directory is returned to the backing file system below the LUKS2 volume, resulting in a "sparse" loopback file\&. This option mostly defaults to off, since this permits over\-committing home directories which results in I/O errors if the underlying file system runs full while the upper file system wants to allocate a block\&. Such I/O errors are generally not handled well by file systems nor applications\&. When LUKS2 storage is used on top of regular block devices (instead of on top a loopback file) the discard logic defaults to on\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-luks\-offline\-discard=\fR\fIBOOL\fR @@ -691,11 +781,15 @@ Similar to controls what happens when the home directory is active, \fB\-\-luks\-offline\-discard=\fR controls what happens when it becomes inactive, i\&.e\&. whether to trim/allocate the storage when deactivating the home directory\&. This option defaults to on, to ensure disk space is minimized while a user is not logged in\&. +.sp +Added in version 246\&. .RE .PP \fB\-\-luks\-extra\-mount\-options=\fR\fIOPTIONS\fR .RS 4 Takes a string containing additional mount options to use when mounting the LUKS volume\&. If specified, this string will be appended to the default, built\-in mount options\&. +.sp +Added in version 250\&. .RE .PP \fB\-\-luks\-cipher=\fR\fICIPHER\fR, \fB\-\-luks\-cipher\-mode=\fR\fIMODE\fR, \fB\-\-luks\-volume\-key\-size=\fR\fIBYTES\fR, \fB\-\-luks\-pbkdf\-type=\fR\fITYPE\fR, \fB\-\-luks\-pbkdf\-hash\-algorithm=\fR\fIALGORITHM\fR, \fB\-\-luks\-pbkdf\-force\-iterations=\fR\fIITERATIONS\fR, \fB\-\-luks\-pbkdf\-time\-cost=\fR\fISECONDS\fR, \fB\-\-luks\-pbkdf\-memory\-cost=\fR\fIBYTES\fR, \fB\-\-luks\-pbkdf\-parallel\-threads=\fR\fITHREADS\fR, \fB\-\-luks\-sector\-size=\fR\fIBYTES\fR @@ -710,6 +804,8 @@ uses bytes for key size, like /proc/crypto, but \fBcryptsetup\fR(8) uses bits\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-auto\-resize\-mode=\fR @@ -727,6 +823,8 @@ the home area is grown to the size configured via should it currently be smaller\&. If it already matches the configured size or is larger no operation is executed\&. If set to "shrink\-and\-grow" the home area is also resized during logout to the minimal size the used disk space and file system constraints permit\&. This mode thus ensures that while a home area is activated it is sized to the configured size, but while deactivated it is compacted taking up only the minimal space possible\&. Note that if the system is powered off abnormally or if the user otherwise not logged out cleanly the shrinking operation will not take place, and the user has to re\-login/logout again before it is executed again\&. +.sp +Added in version 250\&. .RE .PP \fB\-\-rebalance\-weight=\fR @@ -739,6 +837,8 @@ no automatic free space distribution is done for this home area\&. Note that res see below) will implicitly turn off the automatic rebalancing\&. To reenable the automatic rebalancing use \fB\-\-rebalance\-weight=\fR with an empty parameter\&. +.sp +Added in version 250\&. .RE .PP \fB\-\-nosuid=\fR\fIBOOL\fR, \fB\-\-nodev=\fR\fIBOOL\fR, \fB\-\-noexec=\fR\fIBOOL\fR @@ -756,6 +856,8 @@ are on, while "noexec" is off\&. For details about these mount options see \fBmount\fR(8)\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-cifs\-domain=\fR\fIDOMAIN\fR, \fB\-\-cifs\-user\-name=\fR\fIUSER\fR, \fB\-\-cifs\-service=\fR\fISERVICE\fR, \fB\-\-cifs\-extra\-mount\-options=\fR\fIOPTIONS\fR @@ -768,6 +870,8 @@ storage is selected\&. The file share should be specified in format setting allows specifying additional mount options when mounting the share, see \fBmount.cifs\fR(8) for details\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-stop\-delay=\fR\fISECS\fR @@ -775,17 +879,23 @@ for details\&. Configures the time the per\-user service manager shall continue to run after the all sessions of the user ended\&. The default is configured in \fBlogind.conf\fR(5) (for home directories of LUKS2 storage located on removable media this defaults to 0 though)\&. A longer time makes sure quick, repetitive logins are more efficient as the user\*(Aqs service manager doesn\*(Aqt have to be started every time\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-kill\-processes=\fR\fIBOOL\fR .RS 4 Configures whether to kill all processes of the user on logout\&. The default is configured in \fBlogind.conf\fR(5)\&. +.sp +Added in version 245\&. .RE .PP \fB\-\-auto\-login=\fR\fIBOOL\fR .RS 4 Takes a boolean argument\&. Configures whether the graphical UI of the system should automatically log this user in if possible\&. Defaults to off\&. If less or more than one user is marked this way automatic login is disabled\&. +.sp +Added in version 245\&. .RE .SH "COMMANDS" .PP @@ -796,6 +906,8 @@ The following commands are understood: List all home directories (along with brief details) currently managed by systemd\-homed\&.service\&. This command is also executed if none is specified on the command line\&. (Note that the list of users shown by this command does not include users managed by other subsystems, such as system users or any traditional users listed in /etc/passwd\&.) +.sp +Added in version 245\&. .RE .PP \fBactivate\fR \fIUSER\fR [\fIUSER\&...\fR] @@ -805,12 +917,16 @@ Activate one or more home directories\&. The home directories of each listed use \fBdeactivate\fR, see below), or the user logs in and out again and it thus is deactivated due to the automatic deactivation\-on\-logout logic\&. .sp Activation of a home directory involves various operations that depend on the selected storage mechanism\&. If the LUKS2 mechanism is used, this generally involves: inquiring the user for a password, setting up a loopback device, validating and activating the LUKS2 volume, checking the file system, mounting the file system, and potentially changing the ownership of all included files to the correct UID/GID\&. +.sp +Added in version 245\&. .RE .PP \fBdeactivate\fR \fIUSER\fR [\fIUSER\&...\fR] .RS 4 Deactivate one or more home directories\&. This undoes the effect of \fBactivate\fR\&. +.sp +Added in version 245\&. .RE .PP \fBinspect\fR \fIUSER\fR [\fIUSER\&...\fR] @@ -820,11 +936,15 @@ Show various details about the specified home directories\&. This shows various to show the detailed JSON user record instead, possibly combined with \fB\-\-export\-format=\fR to suppress certain aspects of the output\&. +.sp +Added in version 245\&. .RE .PP \fBauthenticate\fR \fIUSER\fR [\fIUSER\&...\fR] .RS 4 Validate authentication credentials of a home directory\&. This queries the caller for a password (or similar) and checks that it correctly unlocks the home directory\&. This leaves the home directory in the state it is in, i\&.e\&. it leaves the home directory in inactive state if it was inactive before, and in active state if it was active before\&. +.sp +Added in version 245\&. .RE .PP \fBcreate\fR \fIUSER\fR, \fBcreate\fR \fB\-\-identity=\fR\fIPATH\fR [\fIUSER\fR] @@ -833,11 +953,15 @@ Create a new home directory/user account of the specified name\&. Use the variou .sp The specified user name should follow the strict syntax described on \m[blue]\fBUser/Group Name Syntax\fR\m[]\&\s-2\u[3]\d\s+2\&. +.sp +Added in version 245\&. .RE .PP \fBremove\fR \fIUSER\fR .RS 4 Remove a home directory/user account\&. This will remove both the home directory\*(Aqs user record and the home directory itself, and thus delete all files and directories owned by the user\&. +.sp +Added in version 245\&. .RE .PP \fBupdate\fR \fIUSER\fR, \fBupdate\fR \fB\-\-identity=\fR\fIPATH\fR [\fIUSER\fR] @@ -849,11 +973,15 @@ option\&. Note that changes to user records not signed by a cryptographic private key available locally are not permitted, unless \fB\-\-identity=\fR is used with a user record that is already correctly signed by a recognized private key\&. +.sp +Added in version 245\&. .RE .PP \fBpasswd\fR \fIUSER\fR .RS 4 Change the password of the specified home directory/user account\&. +.sp +Added in version 245\&. .RE .PP \fBresize\fR \fIUSER\fR \fIBYTES\fR @@ -876,11 +1004,15 @@ storage mechanisms are used, resizing will change file system quota\&. The size and "max" may be specified in place of a numeric size value, for minimizing or maximizing disk space assigned to the home area, taking constraints of the file system, disk usage inside the home area and on the backing storage into account\&. +.sp +Added in version 245\&. .RE .PP \fBlock\fR \fIUSER\fR .RS 4 Temporarily suspend access to the user\*(Aqs home directory and remove any associated cryptographic keys from memory\&. Any attempts to access the user\*(Aqs home directory will stall until the home directory is unlocked again (i\&.e\&. re\-authenticated)\&. This functionality is primarily intended to be used during system suspend to make sure the user\*(Aqs data cannot be accessed until the user re\-authenticates on resume\&. This operation is only defined for home directories that use the LUKS2 storage mechanism\&. +.sp +Added in version 245\&. .RE .PP \fBunlock\fR \fIUSER\fR @@ -888,6 +1020,8 @@ Temporarily suspend access to the user\*(Aqs home directory and remove any assoc Resume access to the user\*(Aqs home directory again, undoing the effect of \fBlock\fR above\&. This requires authentication of the user, as the cryptographic keys required for access to the home directory need to be reacquired\&. +.sp +Added in version 245\&. .RE .PP \fBlock\-all\fR @@ -897,6 +1031,8 @@ Execute the command on all suitable home directories at once\&. This operation is generally executed on system suspend (i\&.e\&. by \fBsystemctl suspend\fR and related commands), to ensure all active user\*(Aqs cryptographic keys for accessing their home directories are removed from memory\&. +.sp +Added in version 245\&. .RE .PP \fBdeactivate\-all\fR @@ -908,11 +1044,15 @@ command on all active home directories at once\&. This operation is generally ex and related commands), to ensure all active user\*(Aqs home directories are fully deactivated before /home/ and related file systems are unmounted\&. +.sp +Added in version 247\&. .RE .PP \fBwith\fR \fIUSER\fR \fICOMMAND\&...\fR .RS 4 Activate the specified user\*(Aqs home directory, run the specified command (under the caller\*(Aqs identity, not the specified user\*(Aqs) and deactivate the home directory afterwards again (unless the user is logged in otherwise)\&. This command is useful for running privileged backup scripts and such, but requires authentication with the user\*(Aqs credentials in order to be able to unlock the user\*(Aqs home directory\&. +.sp +Added in version 245\&. .RE .PP \fBrebalance\fR @@ -920,6 +1060,8 @@ Activate the specified user\*(Aqs home directory, run the specified command (und Rebalance free disk space between active home areas and the backing storage\&. See \fB\-\-rebalance\-weight=\fR above\&. This executes no operation unless there\*(Aqs at least one active LUKS2 home area that has disk space rebalancing enabled\&. This operation is synchronous: it will only complete once disk space is rebalanced according to the rebalancing weights\&. Note that rebalancing also takes place automatically in the background in regular intervals\&. Use this command to synchronously ensure disk space is properly redistributed before initiating an operation requiring large amounts of disk space\&. +.sp +Added in version 250\&. .RE .SH "EXIT STATUS" .PP @@ -1064,6 +1206,12 @@ will be ignored by the executable, and needs to be handled by the pager\&. This option instructs the pager to not send termcap initialization and deinitialization strings to the terminal\&. It is set by default to allow command output to remain visible in the terminal even after the pager exits\&. Nevertheless, this prevents some pager functionality from working, in particular paged output cannot be scrolled with the mouse\&. .RE .sp +Note that setting the regular +\fI$LESS\fR +environment variable has no effect for +\fBless\fR +invocations by systemd tools\&. +.sp See \fBless\fR(1) for more discussion\&. @@ -1075,6 +1223,12 @@ Override the charset passed to \fBless\fR (by default "utf\-8", if the invoking terminal is determined to be UTF\-8 compatible)\&. +.sp +Note that setting the regular +\fI$LESSCHARSET\fR +environment variable has no effect for +\fBless\fR +invocations by systemd tools\&. .RE .PP \fI$SYSTEMD_PAGERSECURE\fR |