diff options
Diffstat (limited to 'upstream/fedora-rawhide/man1/homectl.1')
| -rw-r--r-- | upstream/fedora-rawhide/man1/homectl.1 | 253 |
1 files changed, 183 insertions, 70 deletions
diff --git a/upstream/fedora-rawhide/man1/homectl.1 b/upstream/fedora-rawhide/man1/homectl.1 index db58c946..6cbbbac1 100644 --- a/upstream/fedora-rawhide/man1/homectl.1 +++ b/upstream/fedora-rawhide/man1/homectl.1 @@ -1,5 +1,5 @@ '\" t -.TH "HOMECTL" "1" "" "systemd 255" "homectl" +.TH "HOMECTL" "1" "" "systemd 256~rc3" "homectl" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -20,7 +20,7 @@ .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" -homectl \- Create, remove, change or inspect home directories +homectl, systemd-homed-firstboot.service \- Create, remove, change or inspect home directories .SH "SYNOPSIS" .HP \w'\fBhomectl\fR\ 'u \fBhomectl\fR [OPTIONS...] {COMMAND} [NAME...] @@ -151,7 +151,7 @@ The following general options are understood (further options that control the v systemd\-homed\&.service are documented further down): .PP -\fB\-\-identity=\fR\fIFILE\fR +\fB\-\-identity=\fR\fB\fIFILE\fR\fR .RS 4 Read the user\*(Aqs JSON record from the specified file\&. If passed as "\-" @@ -165,7 +165,7 @@ commands (see below), where it allows configuring the user record in JSON as\-is Added in version 245\&. .RE .PP -\fB\-\-json=\fR\fIFORMAT\fR, \fB\-j\fR +\fB\-\-json=\fR\fB\fIFORMAT\fR\fR, \fB\-j\fR .RS 4 Controls whether to output the user record in JSON format, if the \fBinspect\fR @@ -190,7 +190,7 @@ otherwise\&. Added in version 245\&. .RE .PP -\fB\-\-export\-format=\fR\fIFORMAT\fR, \fB\-E\fR, \fB\-EE\fR +\fB\-\-export\-format=\fR\fB\fIFORMAT\fR\fR, \fB\-E\fR, \fB\-EE\fR .RS 4 When used with the \fBinspect\fR @@ -217,6 +217,13 @@ mode, the signature is removed during the replication and thus the record will b Added in version 245\&. .RE .PP +\fB\-\-offline\fR +.RS 4 +Do not attempt to update the copy of the user record and blob directory that is embedded inside of the home area\&. This allows for operation on home areas that are absent, or without needing to authenticate as the user being modified\&. +.sp +Added in version 256\&. +.RE +.PP \fB\-H\fR, \fB\-\-host=\fR .RS 4 Execute the operation remotely\&. Specify a hostname, or a username and hostname separated by @@ -276,21 +283,21 @@ and \fBupdate\fR commands for configuring various aspects of the home directory and the user account: .PP -\fB\-\-real\-name=\fR\fINAME\fR, \fB\-c\fR \fINAME\fR +\fB\-\-real\-name=\fR\fB\fINAME\fR\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 +\fB\-\-realm=\fR\fB\fIREALM\fR\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 +\fB\-\-email\-address=\fR\fB\fIEMAIL\fR\fR .RS 4 Takes an electronic mail address to associate with the user\&. On log\-in the \fI$EMAIL\fR @@ -299,7 +306,7 @@ environment variable is initialized from this value\&. Added in version 245\&. .RE .PP -\fB\-\-location=\fR\fITEXT\fR +\fB\-\-location=\fR\fB\fITEXT\fR\fR .RS 4 Takes location specification for this user\&. This is free\-form text, which might or might not be usable by geo\-location applications\&. Example: \fB\-\-location="Berlin, Germany"\fR @@ -309,7 +316,7 @@ or Added in version 245\&. .RE .PP -\fB\-\-icon\-name=\fR\fIICON\fR +\fB\-\-icon\-name=\fR\fB\fIICON\fR\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\&. @@ -317,7 +324,7 @@ Takes an icon name to associate with the user, following the scheme defined by t Added in version 245\&. .RE .PP -\fB\-\-home\-dir=\fR\fIPATH\fR, \fB\-d\fR\fIPATH\fR +\fB\-\-home\-dir=\fR\fB\fIPATH\fR\fR, \fB\-d\fR\fB\fIPATH\fR\fR .RS 4 Takes a path to use as home directory for the user\&. Note that this is the directory the user\*(Aqs home directory is mounted to while the user is logged in\&. This is not where the user\*(Aqs data is actually stored, see \fB\-\-image\-path=\fR @@ -327,7 +334,7 @@ for that\&. If not specified defaults to Added in version 245\&. .RE .PP -\fB\-\-uid=\fR\fIUID\fR +\fB\-\-uid=\fR\fB\fIUID\fR\fR .RS 4 Takes a preferred numeric UNIX UID to assign this user\&. If a user is to be created with the specified UID and it is already taken by a different user on the local system then creation of the home directory is refused\&. Note though, if after creating the home directory it is used on a different system and the configured UID is taken by another user there, then \fBsystemd\-homed\fR @@ -343,7 +350,7 @@ always have a matching group associated with the same name as well as a GID matc Added in version 245\&. .RE .PP -\fB\-\-member\-of=\fR\fIGROUP\fR, \fB\-G\fR \fIGROUP\fR +\fB\-\-member\-of=\fR\fB\fIGROUP\fR\fR, \fB\-G\fR \fIGROUP\fR .RS 4 Takes a comma\-separated list of auxiliary UNIX groups this user shall belong to\&. Example: \fB\-\-member\-of=wheel\fR @@ -355,7 +362,7 @@ does not manage any groups besides a group matching the user in name and numeric Added in version 245\&. .RE .PP -\fB\-\-capability\-bounding\-set=\fR\fICAPABILITIES\fR, \fB\-\-capability\-ambient\-set=\fR\fICAPABILITIES\fR +\fB\-\-capability\-bounding\-set=\fR\fB\fICAPABILITIES\fR\fR, \fB\-\-capability\-ambient\-set=\fR\fB\fICAPABILITIES\fR\fR .RS 4 These options take a space separated list of process capabilities (e\&.g\&. \fBCAP_WAKE_ALARM\fR, @@ -368,7 +375,7 @@ character the effect is inverted: the specified capability is dropped from the s Added in version 254\&. .RE .PP -\fB\-\-skel=\fR\fIPATH\fR +\fB\-\-skel=\fR\fB\fIPATH\fR\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/\&. @@ -376,7 +383,7 @@ Takes a file system path to a directory\&. Specifies the skeleton directory to i Added in version 245\&. .RE .PP -\fB\-\-shell=\fR\fISHELL\fR +\fB\-\-shell=\fR\fB\fISHELL\fR\fR .RS 4 Takes a file system path\&. Specifies the shell binary to execute on terminal logins\&. If not specified defaults to /bin/bash\&. @@ -384,7 +391,7 @@ Takes a file system path\&. Specifies the shell binary to execute on terminal lo Added in version 245\&. .RE .PP -\fB\-\-setenv=\fR\fIVARIABLE\fR[=\fIVALUE\fR] +\fB\-\-setenv=\fR\fB\fIVARIABLE\fR\fR\fB[=\fR\fB\fIVALUE\fR\fR\fB]\fR .RS 4 Takes an environment variable assignment to set for all user processes\&. May be used multiple times to set multiple environment variables\&. When "=" @@ -401,7 +408,7 @@ and Added in version 245\&. .RE .PP -\fB\-\-timezone=\fR\fITIMEZONE\fR +\fB\-\-timezone=\fR\fB\fITIMEZONE\fR\fR .RS 4 Takes a time zone location name that sets the timezone for the specified user\&. When the user logs in the \fI$TZ\fR @@ -415,17 +422,19 @@ is used intentionally as part of the timezone specification, see Added in version 245\&. .RE .PP -\fB\-\-language=\fR\fILANG\fR +\fB\-\-language=\fR\fB\fILANG\fR\fR .RS 4 -Takes a specifier indicating the preferred language of the user\&. The +Takes a comma\- or colon\-separated list of languages preferred by the user, ordered by descending priority\&. 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\&. +and +\fI$LANGUAGE\fR +environment variables are initialized from this value on login, and thus values suitible for these environment variables are accepted here, for example +\fB\-\-language=de_DE\&.UTF\-8\fR\&. This option may be used more than once, in which case the language lists are concatenated\&. .sp Added in version 245\&. .RE .PP -\fB\-\-ssh\-authorized\-keys=\fR\fIKEYS\fR +\fB\-\-ssh\-authorized\-keys=\fR\fB\fIKEYS\fR\fR .RS 4 Either takes a SSH authorized key line to associate with the user record or a "@" @@ -434,7 +443,7 @@ character followed by a path to a file to read one or more such lines from\&. SS Added in version 245\&. .RE .PP -\fB\-\-pkcs11\-token\-uri=\fR\fIURI\fR +\fB\-\-pkcs11\-token\-uri=\fR\fB\fIURI\fR\fR .RS 4 Takes an RFC 7512 PKCS#11 URI referencing a security token (e\&.g\&. YubiKey or PIV smartcard) that shall be able to unlock the user account\&. The security token URI should reference a security token with exactly one pair of X\&.509 certificate and private key\&. A random secret key is then generated, encrypted with the public key of the X\&.509 certificate, and stored as part of the user record\&. At login time it is decrypted with the PKCS#11 module and then used to unlock the account and associated resources\&. See below for an example how to set up authentication with a security token\&. .sp @@ -457,7 +466,7 @@ option below\&. Both mechanisms are similarly powerful, though FIDO2 is the more Added in version 245\&. .RE .PP -\fB\-\-fido2\-credential\-algorithm=\fR\fISTRING\fR +\fB\-\-fido2\-credential\-algorithm=\fR\fB\fISTRING\fR\fR .RS 4 Specify COSE algorithm used in credential generation\&. The default value is "es256"\&. Supported values are @@ -473,12 +482,12 @@ denotes 2048\-bit RSA with PKCS#1\&.5 padding and SHA\-256\&. "eddsa" denotes EDDSA over Curve25519 with SHA\-512\&. .sp -Note that your authenticator may not support some algorithms\&. +Note that your authenticator may choose not to support some algorithms\&. .sp Added in version 251\&. .RE .PP -\fB\-\-fido2\-device=\fR\fIPATH\fR +\fB\-\-fido2\-device=\fR\fB\fIPATH\fR\fR .RS 4 Takes a path to a Linux "hidraw" @@ -514,7 +523,7 @@ or Added in version 246\&. .RE .PP -\fB\-\-fido2\-with\-client\-pin=\fR\fIBOOL\fR +\fB\-\-fido2\-with\-client\-pin=\fR\fB\fIBOOL\fR\fR .RS 4 When enrolling a FIDO2 security token, controls whether to require the user to enter a PIN when unlocking the account (the FIDO2 "clientPin" @@ -526,7 +535,7 @@ feature at all, or does not allow enabling or disabling it\&.) Added in version 249\&. .RE .PP -\fB\-\-fido2\-with\-user\-presence=\fR\fIBOOL\fR +\fB\-\-fido2\-with\-user\-presence=\fR\fB\fIBOOL\fR\fR .RS 4 When enrolling a FIDO2 security token, controls whether to require the user to verify presence (tap the token, the FIDO2 "up" @@ -538,7 +547,7 @@ feature at all, or does not allow enabling or disabling it\&.) Added in version 249\&. .RE .PP -\fB\-\-fido2\-with\-user\-verification=\fR\fIBOOL\fR +\fB\-\-fido2\-with\-user\-verification=\fR\fB\fIBOOL\fR\fR .RS 4 When enrolling a FIDO2 security token, controls whether to require user verification when unlocking the account (the FIDO2 "uv" @@ -550,21 +559,40 @@ feature at all, or does not allow enabling or disabling it\&.) Added in version 249\&. .RE .PP -\fB\-\-recovery\-key=\fR\fIBOOL\fR +\fB\-\-recovery\-key=\fR\fB\fIBOOL\fR\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 +\fB\-\-blob=\fR\fB\fIPATH\fR\fR, \fB\-b\fR \fIPATH\fR, \fB\-\-blob=\fR\fB\fIFILENAME\fR\fR\fB=\fR\fB\fIPATH\fR\fR, \fB\-b\fR \fIFILENAME\fR=\fIPATH\fR +.RS 4 +Accepts either a directory path, or a file name followed by a file path\&. If just a directory path is specified, then the user\*(Aqs entire blob directory is replaced the specified path\&. Note that this replacement is performed before per\-file manipulations are applied, which means these per\-file manipulations will be applied on top of the specified directory\&. If a filename and file path are specified, then the single specified blob file will be overwritten with the specified path\&. If completely blank, the entire blob directory is emptied out (which also resets all previous blob\-related flags up to this point)\&. If a filename is specified but the corresponding path is blank, that single file will be deleted from the blob directory\&. All changes are performed in temporary copies of the specified files in directories, which means that the originals specified on the command line are not modified\&. See +\m[blue]\fBUser Record Blob Directories\fR\m[]\&\s-2\u[3]\d\s+2 +for more information about blob directories\&. +.sp +Added in version 256\&. +.RE +.PP +\fB\-\-avatar=\fR\fB\fIPATH\fR\fR, \fB\-\-login\-background=\fR\fB\fIPATH\fR\fR +.RS 4 +Accept a file path\&. If set, the specified file is used to overwrite the corresponding file in the user\*(Aqs blob directory\&. If blank, the corresponding file is deleted from the blob directory\&. Essentially, these options are shortcuts to +\fB\-\-blob=\fR\fB\fIFILENAME\fR\fR\fB=\fR\fB\fIPATH\fR\fR +for the known filenames defined in +\m[blue]\fBUser Record Blob Directories\fR\m[]\&\s-2\u[3]\d\s+2\&. +.sp +Added in version 256\&. +.RE +.PP +\fB\-\-locked=\fR\fB\fIBOOLEAN\fR\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 +\fB\-\-not\-before=\fR\fB\fITIMESTAMP\fR\fR, \fB\-\-not\-after=\fR\fB\fITIMESTAMP\fR\fR .RS 4 These options take a timestamp string, in the format documented in \fBsystemd.time\fR(7) @@ -573,14 +601,14 @@ and configures points in time before and after logins into this account are not Added in version 245\&. .RE .PP -\fB\-\-rate\-limit\-interval=\fR\fISECS\fR, \fB\-\-rate\-limit\-burst=\fR\fINUMBER\fR +\fB\-\-rate\-limit\-interval=\fR\fB\fISECS\fR\fR, \fB\-\-rate\-limit\-burst=\fR\fB\fINUMBER\fR\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 +\fB\-\-password\-hint=\fR\fB\fITEXT\fR\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\&. @@ -588,7 +616,7 @@ Takes a password hint to store alongside the user record\&. This string is store Added in version 245\&. .RE .PP -\fB\-\-enforce\-password\-policy=\fR\fIBOOL\fR, \fB\-P\fR +\fB\-\-enforce\-password\-policy=\fR\fB\fIBOOL\fR\fR, \fB\-P\fR .RS 4 Takes a boolean argument\&. Configures whether to enforce the system\*(Aqs password policy for this user, regarding quality and strength of selected passwords\&. Defaults to on\&. \fB\-P\fR @@ -598,14 +626,14 @@ is short for Added in version 245\&. .RE .PP -\fB\-\-password\-change\-now=\fR\fIBOOL\fR +\fB\-\-password\-change\-now=\fR\fB\fIBOOL\fR\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 +\fB\-\-password\-change\-min=\fR\fB\fITIME\fR\fR, \fB\-\-password\-change\-max=\fR\fB\fITIME\fR\fR, \fB\-\-password\-change\-warn=\fR\fB\fITIME\fR\fR, \fB\-\-password\-change\-inactive=\fR\fB\fITIME\fR\fR .RS 4 Each of these options takes a time span specification as argument (in the syntax documented in \fBsystemd.time\fR(7)) and configures various aspects of the user\*(Aqs password expiration policy\&. Specifically, @@ -623,7 +651,7 @@ configures the time which has to pass after the password as expired until the us Added in version 245\&. .RE .PP -\fB\-\-disk\-size=\fR\fIBYTES\fR +\fB\-\-disk\-size=\fR\fB\fIBYTES\fR\fR .RS 4 Either takes a size in bytes as argument (possibly using the usual K, M, G, \&... suffixes for 1024 base values), a percentage value, or the special strings "min" @@ -638,7 +666,7 @@ assigns the maximum disk space available\&. If the LUKS2 backend is used this co Added in version 245\&. .RE .PP -\fB\-\-access\-mode=\fR\fIMODE\fR +\fB\-\-access\-mode=\fR\fB\fIMODE\fR\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 @@ -646,21 +674,21 @@ Takes a UNIX file access mode written in octal\&. Configures the access mode of Added in version 245\&. .RE .PP -\fB\-\-umask=\fR\fIMASK\fR +\fB\-\-umask=\fR\fB\fIMASK\fR\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 +\fB\-\-nice=\fR\fB\fINICE\fR\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] +\fB\-\-rlimit=\fR\fB\fILIMIT\fR\fR\fB=\fR\fB\fIVALUE\fR\fR\fB[:\fIVALUE\fR]\fR .RS 4 Allows configuration of resource limits for processes of this user, see \fBgetrlimit\fR(2) @@ -670,7 +698,7 @@ for details\&. Takes a resource limit name (e\&.g\&. Added in version 245\&. .RE .PP -\fB\-\-tasks\-max=\fR\fITASKS\fR +\fB\-\-tasks\-max=\fR\fB\fITASKS\fR\fR .RS 4 Takes a non\-zero unsigned integer as argument\&. Configures the maximum number of tasks (i\&.e\&. threads, where each process is at least one thread) the user may have at any given time\&. This limit applies to all tasks forked off the user\*(Aqs sessions, even if they change user identity via \fBsu\fR(1) @@ -686,7 +714,7 @@ for further details\&. Added in version 245\&. .RE .PP -\fB\-\-memory\-high=\fR\fIBYTES\fR, \fB\-\-memory\-max=\fR\fIBYTES\fR +\fB\-\-memory\-high=\fR\fB\fIBYTES\fR\fR, \fB\-\-memory\-max=\fR\fB\fIBYTES\fR\fR .RS 4 Set a limit on the memory a user may take up on a system at any given time in bytes (the usual K, M, G, \&... suffixes are supported, to the base of 1024)\&. This includes all memory used by the user itself and all processes they forked off that changed user credentials\&. This controls the \fIMemoryHigh=\fR @@ -700,7 +728,7 @@ for further details\&. Added in version 245\&. .RE .PP -\fB\-\-cpu\-weight=\fR\fIWEIGHT\fR, \fB\-\-io\-weight=\fR\fIWEIGHT\fR +\fB\-\-cpu\-weight=\fR\fB\fIWEIGHT\fR\fR, \fB\-\-io\-weight=\fR\fB\fIWEIGHT\fR\fR .RS 4 Set CPU and IO scheduling weights of the processes of the user, including those of processes forked off by the user that changed user credentials\&. Takes a numeric value in the range 1\&...10000\&. This controls the \fICPUWeight=\fR @@ -714,7 +742,7 @@ for further details\&. Added in version 245\&. .RE .PP -\fB\-\-storage=\fR\fISTORAGE\fR +\fB\-\-storage=\fR\fB\fISTORAGE\fR\fR .RS 4 Selects the storage mechanism to use for this home directory\&. Takes one of "luks", @@ -728,7 +756,7 @@ defines which default storage to use\&. Added in version 245\&. .RE .PP -\fB\-\-image\-path=\fR\fIPATH\fR +\fB\-\-image\-path=\fR\fB\fIPATH\fR\fR .RS 4 Takes a file system path\&. Configures where to place the user\*(Aqs home directory\&. When LUKS2 storage is used refers to the path to the loopback file, otherwise to the path to the home directory (which may be in /home/ @@ -743,14 +771,14 @@ storage mechanism\&. To use LUKS2 storage on a regular block device (for example Added in version 245\&. .RE .PP -\fB\-\-drop\-caches=\fR\fIBOOL\fR +\fB\-\-drop\-caches=\fR\fB\fIBOOL\fR\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 +\fB\-\-fs\-type=\fR\fB\fITYPE\fR\fR .RS 4 When LUKS2 storage is used configures the file system type to use inside the home directory LUKS2 container\&. One of "btrfs", @@ -764,7 +792,7 @@ is not recommended as its support for file system resizing is too limited\&. Added in version 245\&. .RE .PP -\fB\-\-luks\-discard=\fR\fIBOOL\fR +\fB\-\-luks\-discard=\fR\fB\fIBOOL\fR\fR .RS 4 When LUKS2 storage is used configures whether to enable the "discard" @@ -773,7 +801,7 @@ feature of the file system\&. If enabled the file system on top of the LUKS2 vol Added in version 245\&. .RE .PP -\fB\-\-luks\-offline\-discard=\fR\fIBOOL\fR +\fB\-\-luks\-offline\-discard=\fR\fB\fIBOOL\fR\fR .RS 4 Similar to \fB\-\-luks\-discard=\fR, controls the trimming of the file system\&. However, while @@ -785,14 +813,14 @@ controls what happens when it becomes inactive, i\&.e\&. whether to trim/allocat Added in version 246\&. .RE .PP -\fB\-\-luks\-extra\-mount\-options=\fR\fIOPTIONS\fR +\fB\-\-luks\-extra\-mount\-options=\fR\fB\fIOPTIONS\fR\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 +\fB\-\-luks\-cipher=\fR\fB\fICIPHER\fR\fR, \fB\-\-luks\-cipher\-mode=\fR\fB\fIMODE\fR\fR, \fB\-\-luks\-volume\-key\-size=\fR\fB\fIBYTES\fR\fR, \fB\-\-luks\-pbkdf\-type=\fR\fB\fITYPE\fR\fR, \fB\-\-luks\-pbkdf\-hash\-algorithm=\fR\fB\fIALGORITHM\fR\fR, \fB\-\-luks\-pbkdf\-force\-iterations=\fR\fB\fIITERATIONS\fR\fR, \fB\-\-luks\-pbkdf\-time\-cost=\fR\fB\fISECONDS\fR\fR, \fB\-\-luks\-pbkdf\-memory\-cost=\fR\fB\fIBYTES\fR\fR, \fB\-\-luks\-pbkdf\-parallel\-threads=\fR\fB\fITHREADS\fR\fR, \fB\-\-luks\-sector\-size=\fR\fB\fIBYTES\fR\fR .RS 4 Configures various cryptographic parameters for the LUKS2 storage mechanism\&. See \fBcryptsetup\fR(8) @@ -841,7 +869,7 @@ with an empty parameter\&. Added in version 250\&. .RE .PP -\fB\-\-nosuid=\fR\fIBOOL\fR, \fB\-\-nodev=\fR\fIBOOL\fR, \fB\-\-noexec=\fR\fIBOOL\fR +\fB\-\-nosuid=\fR\fB\fIBOOL\fR\fR, \fB\-\-nodev=\fR\fB\fIBOOL\fR\fR, \fB\-\-noexec=\fR\fB\fIBOOL\fR\fR .RS 4 Configures the "nosuid", @@ -860,7 +888,7 @@ is off\&. For details about these mount options see 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 +\fB\-\-cifs\-domain=\fR\fB\fIDOMAIN\fR\fR, \fB\-\-cifs\-user\-name=\fR\fB\fIUSER\fR\fR, \fB\-\-cifs\-service=\fR\fB\fISERVICE\fR\fR, \fB\-\-cifs\-extra\-mount\-options=\fR\fB\fIOPTIONS\fR\fR .RS 4 Configures the Windows File Sharing (CIFS) domain and user to associate with the home directory/user account, as well as the file share ("service") to mount as directory\&. The latter is used when "cifs" @@ -874,7 +902,7 @@ for details\&. Added in version 245\&. .RE .PP -\fB\-\-stop\-delay=\fR\fISECS\fR +\fB\-\-stop\-delay=\fR\fB\fISECS\fR\fR .RS 4 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) @@ -883,7 +911,7 @@ Configures the time the per\-user service manager shall continue to run after th Added in version 245\&. .RE .PP -\fB\-\-kill\-processes=\fR\fIBOOL\fR +\fB\-\-kill\-processes=\fR\fB\fIBOOL\fR\fR .RS 4 Configures whether to kill all processes of the user on logout\&. The default is configured in \fBlogind.conf\fR(5)\&. @@ -891,12 +919,34 @@ Configures whether to kill all processes of the user on logout\&. The default is Added in version 245\&. .RE .PP -\fB\-\-auto\-login=\fR\fIBOOL\fR +\fB\-\-auto\-login=\fR\fB\fIBOOL\fR\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 +.PP +\fB\-\-session\-launcher=\fR\fB\fILAUNCHER\fR\fR +.RS 4 +Takes a string argument\&. Configures the user\*(Aqs preferred session launcher \&.desktop entry file (i\&.e\&. +"gnome", +"plasma", or other names that appear in +/usr/share/xesssions/ +or +/usr/share/wayland\-sessions)\&. This is read by the display manager to pick the default session that is launched when the user logs in\&. +.sp +Added in version 256\&. +.RE +.PP +\fB\-\-session\-type=\fR\fB\fITYPE\fR\fR +.RS 4 +Takes a string argument\&. Configures the user\*(Aqs preferred session type (i\&.e\&. +"x11", +"wayland", and other values accepted by +\fI$XDG_SESSION_TYPE\fR)\&. This is read by the display manage to pick the default session type the user is logged into\&. +.sp +Added in version 256\&. +.RE .SH "COMMANDS" .PP The following commands are understood: @@ -947,12 +997,12 @@ Validate authentication credentials of a home directory\&. This queries the call Added in version 245\&. .RE .PP -\fBcreate\fR \fIUSER\fR, \fBcreate\fR \fB\-\-identity=\fR\fIPATH\fR [\fIUSER\fR] +\fBcreate\fR \fIUSER\fR, \fBcreate\fR \fB\-\-identity=\fR\fB\fIPATH\fR\fR [\fIUSER\fR] .RS 4 Create a new home directory/user account of the specified name\&. Use the various user record property options (as documented above) to control various aspects of the home directory and its user accounts\&. .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\&. +\m[blue]\fBUser/Group Name Syntax\fR\m[]\&\s-2\u[4]\d\s+2\&. .sp Added in version 245\&. .RE @@ -964,7 +1014,7 @@ Remove a home directory/user account\&. This will remove both the home directory Added in version 245\&. .RE .PP -\fBupdate\fR \fIUSER\fR, \fBupdate\fR \fB\-\-identity=\fR\fIPATH\fR [\fIUSER\fR] +\fBupdate\fR \fIUSER\fR, \fBupdate\fR \fB\-\-identity=\fR\fB\fIPATH\fR\fR [\fIUSER\fR] .RS 4 Update a home directory/user account\&. Use the various user record property options (as documented above) to make changes to the account, or alternatively provide a full, updated JSON user record via the \fB\-\-identity=\fR @@ -1063,6 +1113,49 @@ above\&. This executes no operation unless there\*(Aqs at least one active LUKS2 .sp Added in version 250\&. .RE +.PP +\fBfirstboot\fR +.RS 4 +This command is supposed to be invoked during the initial boot of the system\&. It checks whether any regular home area exists so far, and if not queries the user interactively on the console for user name and password and creates one\&. Alternatively, if one or more service credentials whose name starts with +"home\&.create\&." +are passed to the command (containing a user record in JSON format) these users are automatically created at boot\&. +.sp +This command is invoked by the +systemd\-homed\-firstboot\&.service +service unit\&. +.sp +Added in version 256\&. +.RE +.SH "CREDENTIALS" +.PP +When invoked with the +\fBfirstboot\fR +command, +\fBhomectl\fR +supports the service credentials logic as implemented by +\fIImportCredential=\fR/\fILoadCredential=\fR/\fISetCredential=\fR +(see +\fBsystemd.exec\fR(5) +for details)\&. The following credentials are used when passed in: +.PP +\fIhome\&.create\&.*\fR +.RS 4 +If one or more credentials whose names begin with +"home\&.create\&.", followed by a valid UNIX username are passed, a new home area is created, one for each specified user record\&. +.sp +Added in version 256\&. +.RE +.SH "KERNEL COMMAND LINE" +.PP +\fIsystemd\&.firstboot=\fR +.RS 4 +This boolean will disable the effect of +\fBhomectl firstboot\fR +command\&. It\*(Aqs primarily interpreted by +\fBsystemd-firstboot\fR(1)\&. +.sp +Added in version 256\&. +.RE .SH "EXIT STATUS" .PP On success, 0 is returned, a non\-zero failure code otherwise\&. @@ -1077,7 +1170,7 @@ finishes successfully\&. .PP \fI$SYSTEMD_LOG_LEVEL\fR .RS 4 -The maximum log level of emitted messages (messages with a higher log level, i\&.e\&. less important ones, will be suppressed)\&. Either one of (in order of decreasing importance) +The maximum log level of emitted messages (messages with a higher log level, i\&.e\&. less important ones, will be suppressed)\&. Takes a comma\-separated list of values\&. A value may be either one of (in order of decreasing importance) \fBemerg\fR, \fBalert\fR, \fBcrit\fR, @@ -1087,7 +1180,15 @@ The maximum log level of emitted messages (messages with a higher log level, i\& \fBinfo\fR, \fBdebug\fR, or an integer in the range 0\&...7\&. See \fBsyslog\fR(3) -for more information\&. +for more information\&. Each value may optionally be prefixed with one of +\fBconsole\fR, +\fBsyslog\fR, +\fBkmsg\fR +or +\fBjournal\fR +followed by a colon to set the maximum log level for that specific log target (e\&.g\&. +\fBSYSTEMD_LOG_LEVEL=debug,console:info\fR +specifies to log at debug level except when logging to the console which should be at info level)\&. Note that the global maximum log level takes priority over any per target maximum log levels\&. .RE .PP \fI$SYSTEMD_LOG_COLOR\fR @@ -1206,6 +1307,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\&. @@ -1217,6 +1324,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 @@ -1347,12 +1460,7 @@ homectl update nihilbaxter \-\-fido2\-device=auto .\} .SH "SEE ALSO" .PP -\fBsystemd\fR(1), -\fBsystemd-homed.service\fR(8), -\fBhomed.conf\fR(5), -\fBuserdbctl\fR(1), -\fBuseradd\fR(8), -\fBcryptsetup\fR(8) +\fBsystemd\fR(1), \fBsystemd-homed.service\fR(8), \fBhomed.conf\fR(5), \fBuserdbctl\fR(1), \fBuseradd\fR(8), \fBcryptsetup\fR(8) .SH "NOTES" .IP " 1." 4 JSON User Records @@ -1365,6 +1473,11 @@ Icon Naming Specification \%https://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html .RE .IP " 3." 4 +User Record Blob Directories +.RS 4 +\%https://systemd.io/USER_RECORD_BLOB_DIRS +.RE +.IP " 4." 4 User/Group Name Syntax .RS 4 \%https://systemd.io/USER_NAMES |