Debian Codegraph @

upstream/debian-trixie/man1/homectl.1

raw
1 '\" t
2 .TH "HOMECTL" "1" "" "systemd 257.13" "homectl"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 homectl, systemd-homed-firstboot.service \- Create, remove, change or inspect home directories
24 .SH "SYNOPSIS"
25 .HP \w'\fBhomectl\fR\ 'u
26 \fBhomectl\fR [OPTIONS...] {COMMAND} [NAME...]
27 .SH "DESCRIPTION"
28 .PP
29 \fBhomectl\fR
30 may be used to create, remove, change or inspect a user\*(Aqs home directory\&. It\*(Aqs primarily a command interfacing with
31 \fBsystemd-homed.service\fR(8)
32 which manages home directories of users\&.
33 .PP
34 Home directories managed by
35 systemd\-homed\&.service
36 are self\-contained, and thus include the user\*(Aqs full metadata record in the home\*(Aqs data storage itself, making them easy to migrate between machines\&. In particular, a home directory describes a matching user record, and every user record managed by
37 systemd\-homed\&.service
38 also implies existence and encapsulation of a home directory\&. The user account and home directory become the same concept\&.
39 .PP
40 The following backing storage mechanisms are supported:
41 .sp
42 .RS 4
43 .ie n \{\
44 \h'-04'\(bu\h'+03'\c
45 .\}
46 .el \{\
47 .sp -1
48 .IP \(bu 2.3
49 .\}
50 An individual LUKS2 encrypted loopback file for a user, stored in
51 /home/*\&.home\&. At login the file system contained in this files is mounted, after the LUKS2 encrypted volume has been attached\&. The user\*(Aqs password is identical to the encryption passphrase of the LUKS2 volume\&. Access to data without preceding user authentication is thus not possible, even for the system administrator\&. This storage mechanism provides the strongest data security and is thus recommended\&.
52 .RE
53 .sp
54 .RS 4
55 .ie n \{\
56 \h'-04'\(bu\h'+03'\c
57 .\}
58 .el \{\
59 .sp -1
60 .IP \(bu 2.3
61 .\}
62 Similar, but the LUKS2 encrypted file system is located on regular block device, such as a USB storage stick\&. In this mode home directories and all data they include are nicely migratable between machines, simply by plugging the USB stick into different systems at different times\&.
63 .RE
64 .sp
65 .RS 4
66 .ie n \{\
67 \h'-04'\(bu\h'+03'\c
68 .\}
69 .el \{\
70 .sp -1
71 .IP \(bu 2.3
72 .\}
73 An encrypted directory using
74 "fscrypt"
75 on file systems that support it (at the moment this is primarily
76 "ext4"), located in
77 /home/*\&.homedir\&. This mechanism also provides encryption, but substantially weaker than LUKS2, as most file system metadata is unprotected\&. Moreover it currently does not support changing user passwords once the home directory has been created\&.
78 .RE
79 .sp
80 .RS 4
81 .ie n \{\
82 \h'-04'\(bu\h'+03'\c
83 .\}
84 .el \{\
85 .sp -1
86 .IP \(bu 2.3
87 .\}
88 A
89 "btrfs"
90 subvolume for each user, also located in
91 /home/*\&.homedir\&. This provides no encryption, but good quota support\&.
92 .RE
93 .sp
94 .RS 4
95 .ie n \{\
96 \h'-04'\(bu\h'+03'\c
97 .\}
98 .el \{\
99 .sp -1
100 .IP \(bu 2.3
101 .\}
102 A regular directory for each user, also located in
103 /home/*\&.homedir\&. This provides no encryption, but is a suitable fallback available on all machines, even where LUKS2,
104 "fscrypt"
105 or
106 "btrfs"
107 support is not available\&.
108 .RE
109 .sp
110 .RS 4
111 .ie n \{\
112 \h'-04'\(bu\h'+03'\c
113 .\}
114 .el \{\
115 .sp -1
116 .IP \(bu 2.3
117 .\}
118 An individual Windows file share (CIFS) for each user\&.
119 .RE
120 .PP
121 Note that
122 systemd\-homed\&.service
123 and
124 \fBhomectl\fR
125 will not manage "classic" UNIX user accounts as created with
126 \fBuseradd\fR(8)
127 or similar tools\&. In particular, this functionality is not suitable for managing system users (i\&.e\&. users with a UID below 1000) but is exclusive to regular ("human") users\&.
128 .PP
129 Note that users/home directories managed via
130 \fBsystemd\-homed\&.service\fR
131 do not show up in
132 /etc/passwd
133 and similar files, they are synthesized via glibc NSS during runtime\&. They are thus resolvable and may be enumerated via the
134 \fBgetent\fR(1)
135 tool\&.
136 .PP
137 This tool interfaces directly with
138 systemd\-homed\&.service, and may execute specific commands on the home directories it manages\&. Since every home directory managed that way also defines a JSON user and group record these home directories may also be inspected and enumerated via
139 \fBuserdbctl\fR(1)\&.
140 .PP
141 Home directories managed by
142 systemd\-homed\&.service
143 are usually in one of two states, or in a transition state between them: when
144 "active"
145 they are unlocked and mounted, and thus accessible to the system and its programs; when
146 "inactive"
147 they are not mounted and thus not accessible\&. Activation happens automatically at login of the user and usually can only complete after a password (or other authentication token) has been supplied\&. Deactivation happens after the user fully logged out\&. A home directory remains active as long as the user is logged in at least once, i\&.e\&. has at least one login session\&. When the user logs in a second time simultaneously the home directory remains active\&. It is deactivated only after the last of the user\*(Aqs sessions ends\&.
148 .SH "OPTIONS"
149 .PP
150 The following general options are understood (further options that control the various properties of user records managed by
151 systemd\-homed\&.service
152 are documented further down):
153 .PP
154 \fB\-\-identity=\fR\fB\fIFILE\fR\fR
155 .RS 4
156 Read the user\*(Aqs JSON record from the specified file\&. If passed as
157 "\-"
158 read the user record from standard input\&. The supplied JSON object must follow the structure documented in
159 \m[blue]\fBJSON User Records\fR\m[]\&\s-2\u[1]\d\s+2\&. This option may be used in conjunction with the
160 \fBcreate\fR
161 and
162 \fBupdate\fR
163 commands (see below), where it allows configuring the user record in JSON as\-is, instead of setting the individual user record properties (see below)\&.
164 .sp
165 Added in version 245\&.
166 .RE
167 .PP
168 \fB\-\-json=\fR\fB\fIFORMAT\fR\fR, \fB\-j\fR
169 .RS 4
170 Controls whether to output the user record in JSON format, if the
171 \fBinspect\fR
172 command (see below) is used\&. Takes one of
173 "pretty",
174 "short"
175 or
176 "off"\&. If
177 "pretty"
178 human\-friendly whitespace and newlines are inserted in the output to make the JSON data more readable\&. If
179 "short"
180 all superfluous whitespace is suppressed\&. If
181 "off"
182 (the default) the user information is not shown in JSON format but in a friendly human readable formatting instead\&. The
183 \fB\-j\fR
184 option picks
185 "pretty"
186 when run interactively and
187 "short"
188 otherwise\&.
189 .sp
190 Added in version 245\&.
191 .RE
192 .PP
193 \fB\-\-export\-format=\fR\fB\fIFORMAT\fR\fR, \fB\-E\fR, \fB\-EE\fR
194 .RS 4
195 When used with the
196 \fBinspect\fR
197 verb in JSON mode (see above) may be used to suppress certain aspects of the JSON user record on output\&. Specifically, if
198 "stripped"
199 format is used the binding and runtime fields of the record are removed\&. If
200 "minimal"
201 format is used the cryptographic signature is removed too\&. If
202 "full"
203 format is used the full JSON record is shown (this is the default)\&. This option is useful for copying an existing user record to a different system in order to create a similar user there with the same settings\&. Specifically:
204 \fBhomectl inspect \-EE | ssh root@othersystem homectl create \-i\-\fR
205 may be used as simple command line for replicating a user on another host\&.
206 \fB\-E\fR
207 is equivalent to
208 \fB\-j \-\-export\-format=stripped\fR,
209 \fB\-EE\fR
210 to
211 \fB\-j \-\-export\-format=minimal\fR\&. Note that when replicating user accounts user records acquired in
212 "stripped"
213 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
214 "minimal"
215 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\&.
216 .sp
217 Added in version 245\&.
218 .RE
219 .PP
220 \fB\-\-offline\fR
221 .RS 4
222 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\&.
223 .sp
224 Added in version 256\&.
225 .RE
226 .PP
227 \fB\-\-prompt\-new\-user\fR
228 .RS 4
229 If used in conjunction with
230 \fBfirstboot\fR
231 and no regular user account exists on the system so far the tool will interactively query for user information and create an account\&.
232 .sp
233 Added in version 256\&.
234 .RE
235 .PP
236 \fB\-H\fR, \fB\-\-host=\fR
237 .RS 4
238 Execute the operation remotely\&. Specify a hostname, or a username and hostname separated by
239 "@", to connect to\&. The hostname may optionally be suffixed by a port ssh is listening on, separated by
240 ":", and then a container name, separated by
241 "/", which connects directly to a specific container on the specified host\&. This will use SSH to talk to the remote machine manager instance\&. Container names may be enumerated with
242 \fBmachinectl \-H \fR\fB\fIHOST\fR\fR\&. Put IPv6 addresses in brackets\&.
243 .RE
244 .PP
245 \fB\-M\fR, \fB\-\-machine=\fR
246 .RS 4
247 Execute operation on a local container\&. Specify a container name to connect to, optionally prefixed by a user name to connect as and a separating
248 "@"
249 character\&. If the special string
250 "\&.host"
251 is used in place of the container name, a connection to the local system is made (which is useful to connect to a specific user\*(Aqs user bus:
252 "\-\-user \-\-machine=lennart@\&.host")\&. If the
253 "@"
254 syntax is not used, the connection is made as root user\&. If the
255 "@"
256 syntax is used either the left hand side or the right hand side may be omitted (but not both) in which case the local user name and
257 "\&.host"
258 are implied\&.
259 .RE
260 .PP
261 \fB\-\-no\-pager\fR
262 .RS 4
263 Do not pipe output into a pager\&.
264 .RE
265 .PP
266 \fB\-\-no\-legend\fR
267 .RS 4
268 Do not print the legend, i\&.e\&. column headers and the footer with hints\&.
269 .RE
270 .PP
271 \fB\-\-no\-ask\-password\fR
272 .RS 4
273 Do not query the user for authentication for privileged operations\&.
274 .RE
275 .PP
276 \fB\-h\fR, \fB\-\-help\fR
277 .RS 4
278 Print a short help text and exit\&.
279 .RE
280 .PP
281 \fB\-\-version\fR
282 .RS 4
283 Print a short version string and exit\&.
284 .RE
285 .SH "USER RECORD PROPERTIES"
286 .PP
287 The following options control various properties of the user records/home directories that
288 systemd\-homed\&.service
289 manages\&. These switches may be used in conjunction with the
290 \fBcreate\fR
291 and
292 \fBupdate\fR
293 commands for configuring various aspects of the home directory and the user account:
294 .PP
295 \fB\-\-real\-name=\fR\fB\fINAME\fR\fR, \fB\-c\fR \fINAME\fR
296 .RS 4
297 The real name for the user\&. This corresponds with the GECOS field on classic UNIX NSS records\&.
298 .sp
299 Added in version 245\&.
300 .RE
301 .PP
302 \fB\-\-realm=\fR\fB\fIREALM\fR\fR
303 .RS 4
304 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\&.
305 .sp
306 Added in version 245\&.
307 .RE
308 .PP
309 \fB\-\-email\-address=\fR\fB\fIEMAIL\fR\fR
310 .RS 4
311 Takes an electronic mail address to associate with the user\&. On log\-in the
312 \fI$EMAIL\fR
313 environment variable is initialized from this value\&.
314 .sp
315 Added in version 245\&.
316 .RE
317 .PP
318 \fB\-\-location=\fR\fB\fITEXT\fR\fR
319 .RS 4
320 Takes location specification for this user\&. This is free\-form text, which might or might not be usable by geo\-location applications\&. Example:
321 \fB\-\-location="Berlin, Germany"\fR
322 or
323 \fB\-\-location="Basement, Room 3a"\fR
324 .sp
325 Added in version 245\&.
326 .RE
327 .PP
328 \fB\-\-icon\-name=\fR\fB\fIICON\fR\fR
329 .RS 4
330 Takes an icon name to associate with the user, following the scheme defined by the
331 \m[blue]\fBIcon Naming Specification\fR\m[]\&\s-2\u[2]\d\s+2\&.
332 .sp
333 Added in version 245\&.
334 .RE
335 .PP
336 \fB\-\-home\-dir=\fR\fB\fIPATH\fR\fR, \fB\-d\fR\fB\fIPATH\fR\fR
337 .RS 4
338 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
339 \fB\-\-image\-path=\fR
340 for that\&. If not specified, defaults to
341 /home/$USER\&.
342 .sp
343 Added in version 245\&.
344 .RE
345 .PP
346 \fB\-\-uid=\fR\fB\fIUID\fR\fR
347 .RS 4
348 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
349 \fBsystemd\-homed\fR
350 may assign the user a different UID on that system\&. The specified UID must be outside of the system user range\&. It is recommended to use the 60001\&...60513 UID range for this purpose\&. If not specified, the UID is automatically picked\&. If the home directory is found to be owned by a different UID when logging in, the home directory and everything underneath it will have its ownership changed automatically before login completes\&.
351 .sp
352 Note that changing this option for existing home directories generally has no effect on home directories that already have been registered locally (have a local
353 \fIbinding\fR), as the UID used for an account on the local system is determined when the home directory is first activated on it, and then remains in effect until the home directory is removed\&.
354 .sp
355 Note that users managed by
356 \fBsystemd\-homed\fR
357 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\&.
358 .sp
359 Added in version 245\&.
360 .RE
361 .PP
362 \fB\-\-member\-of=\fR\fB\fIGROUP\fR\fR, \fB\-G\fR \fIGROUP\fR
363 .RS 4
364 Takes a comma\-separated list of auxiliary UNIX groups this user shall belong to\&. Example:
365 \fB\-\-member\-of=wheel\fR
366 to provide the user with administrator privileges\&. Note that
367 \fBsystemd\-homed\fR
368 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
369 \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\&.
370 .sp
371 Added in version 245\&.
372 .RE
373 .PP
374 \fB\-\-capability\-bounding\-set=\fR\fB\fICAPABILITIES\fR\fR, \fB\-\-capability\-ambient\-set=\fR\fB\fICAPABILITIES\fR\fR
375 .RS 4
376 These options take a space separated list of process capabilities (e\&.g\&.
377 \fBCAP_WAKE_ALARM\fR,
378 \fBCAP_BLOCK_SUSPEND\fR, \&...) that shall be set in the capability bounding and ambient sets for all the user\*(Aqs sessions\&. See
379 \fBcapabilities\fR(7)
380 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
381 "~"
382 character the effect is inverted: the specified capability is dropped from the specific set\&.
383 .sp
384 Added in version 254\&.
385 .RE
386 .PP
387 \fB\-\-skel=\fR\fB\fIPATH\fR\fR
388 .RS 4
389 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
390 /etc/skel/\&.
391 .sp
392 Added in version 245\&.
393 .RE
394 .PP
395 \fB\-\-shell=\fR\fB\fISHELL\fR\fR
396 .RS 4
397 Takes a file system path\&. Specifies the shell binary to execute on terminal logins\&. If not specified, defaults to
398 /bin/bash\&.
399 .sp
400 Added in version 245\&.
401 .RE
402 .PP
403 \fB\-\-setenv=\fR\fB\fIVARIABLE\fR\fR\fB[=\fR\fB\fIVALUE\fR\fR\fB]\fR
404 .RS 4
405 Takes an environment variable assignment to set for all user processes\&. May be used multiple times to set multiple environment variables\&. When
406 "="
407 and
408 \fIVALUE\fR
409 are omitted, the value of the variable with the same name in the program environment will be used\&.
410 .sp
411 Note that a number of other settings also result in environment variables to be set for the user, including
412 \fB\-\-email=\fR,
413 \fB\-\-timezone=\fR
414 and
415 \fB\-\-language=\fR\&.
416 .sp
417 Added in version 245\&.
418 .RE
419 .PP
420 \fB\-\-timezone=\fR\fB\fITIMEZONE\fR\fR
421 .RS 4
422 Takes a time zone location name that sets the timezone for the specified user\&. When the user logs in the
423 \fI$TZ\fR
424 environment variable is initialized from this setting\&. Example:
425 \fB\-\-timezone=Europe/Amsterdam\fR
426 will result in the environment variable
427 "TZ=:Europe/Amsterdam"\&. (":"
428 is used intentionally as part of the timezone specification, see
429 \fBtzset\fR(3)\&.)
430 .sp
431 Added in version 245\&.
432 .RE
433 .PP
434 \fB\-\-language=\fR\fB\fILANG\fR\fR
435 .RS 4
436 Takes a comma\- or colon\-separated list of languages preferred by the user, ordered by descending priority\&. The
437 \fI$LANG\fR
438 and
439 \fI$LANGUAGE\fR
440 environment variables are initialized from this value on login, and thus values suitable for these environment variables are accepted here, for example
441 \fB\-\-language=de_DE\&.UTF\-8\fR\&. This option may be used more than once, in which case the language lists are concatenated\&.
442 .sp
443 Added in version 245\&.
444 .RE
445 .PP
446 \fB\-\-ssh\-authorized\-keys=\fR\fB\fIKEYS\fR\fR
447 .RS 4
448 Either takes a SSH authorized key line to associate with the user record or a
449 "@"
450 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\&.
451 .sp
452 Added in version 245\&.
453 .RE
454 .PP
455 \fB\-\-pkcs11\-token\-uri=\fR\fB\fIURI\fR\fR
456 .RS 4
457 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\&.
458 .sp
459 Instead of a valid PKCS#11 URI, the special strings
460 "list"
461 and
462 "auto"
463 may be specified\&. If
464 "list"
465 is passed, a brief table of suitable, currently plugged in PKCS#11 hardware tokens is shown, along with their URIs\&. If
466 "auto"
467 is passed, a suitable PKCS#11 hardware token is automatically selected (this operation will fail if there isn\*(Aqt exactly one suitable token discovered)\&. The latter is a useful shortcut for the most common case where a single PKCS#11 hardware token is plugged in\&.
468 .sp
469 Note that many hardware security tokens implement both PKCS#11/PIV and FIDO2 with the
470 "hmac\-secret"
471 extension (for example: the YubiKey 5 series), as supported with the
472 \fB\-\-fido2\-device=\fR
473 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\&.
474 .sp
475 Added in version 245\&.
476 .RE
477 .PP
478 \fB\-\-fido2\-credential\-algorithm=\fR\fB\fISTRING\fR\fR
479 .RS 4
480 Specify COSE algorithm used in credential generation\&. The default value is
481 "es256"\&. Supported values are
482 "es256",
483 "rs256"
484 and
485 "eddsa"\&.
486 .sp
487 "es256"
488 denotes ECDSA over NIST P\-256 with SHA\-256\&.
489 "rs256"
490 denotes 2048\-bit RSA with PKCS#1\&.5 padding and SHA\-256\&.
491 "eddsa"
492 denotes EDDSA over Curve25519 with SHA\-512\&.
493 .sp
494 Note that your authenticator may choose not to support some algorithms\&.
495 .sp
496 Added in version 251\&.
497 .RE
498 .PP
499 \fB\-\-fido2\-device=\fR\fB\fIPATH\fR\fR
500 .RS 4
501 Takes a path to a Linux
502 "hidraw"
503 device (e\&.g\&.
504 /dev/hidraw1), referring to a FIDO2 security token implementing the
505 "hmac\-secret"
506 extension that shall be able to unlock the user account\&. A random salt value is generated on the host and passed to the FIDO2 device, which calculates a HMAC hash of the salt using an internal secret key\&. The result is then used as the key to unlock the user account\&. The random salt is included in the user record, so that whenever authentication is needed it can be passed to the FIDO2 token again\&.
507 .sp
508 Instead of a valid path to a FIDO2
509 "hidraw"
510 device the special strings
511 "list"
512 and
513 "auto"
514 may be specified\&. If
515 "list"
516 is passed, a brief table of suitable discovered FIDO2 devices is shown\&. If
517 "auto"
518 is passed, a suitable FIDO2 token is automatically selected, if exactly one is discovered\&. The latter is a useful shortcut for the most common case where a single FIDO2 hardware token is plugged in\&.
519 .sp
520 Note that FIDO2 devices suitable for this option must implement the
521 "hmac\-secret"
522 extension\&. Most current devices (such as the YubiKey 5 series) do\&. If the extension is not implemented the device cannot be used for unlocking home directories\&.
523 .sp
524 The FIDO2 device may be subsequently removed by setting the device path to an empty string (e\&.g\&.
525 \fBhomectl update $USER \-\-fido2\-device=""\fR)\&.
526 .sp
527 Note that many hardware security tokens implement both FIDO2 and PKCS#11/PIV (and thus may be used with either
528 \fB\-\-fido2\-device=\fR
529 or
530 \fB\-\-pkcs11\-token\-uri=\fR), for a discussion see above\&.
531 .sp
532 Added in version 246\&.
533 .RE
534 .PP
535 \fB\-\-fido2\-with\-client\-pin=\fR\fB\fIBOOL\fR\fR
536 .RS 4
537 When enrolling a FIDO2 security token, controls whether to require the user to enter a PIN when unlocking the account (the FIDO2
538 "clientPin"
539 feature)\&. Defaults to
540 "yes"\&. (Note: this setting is without effect if the security token does not support the
541 "clientPin"
542 feature at all, or does not allow enabling or disabling it\&.)
543 .sp
544 Added in version 249\&.
545 .RE
546 .PP
547 \fB\-\-fido2\-with\-user\-presence=\fR\fB\fIBOOL\fR\fR
548 .RS 4
549 When enrolling a FIDO2 security token, controls whether to require the user to verify presence (tap the token, the FIDO2
550 "up"
551 feature) when unlocking the account\&. Defaults to
552 "yes"\&. (Note: this setting is without effect if the security token does not support the
553 "up"
554 feature at all, or does not allow enabling or disabling it\&.)
555 .sp
556 Added in version 249\&.
557 .RE
558 .PP
559 \fB\-\-fido2\-with\-user\-verification=\fR\fB\fIBOOL\fR\fR
560 .RS 4
561 When enrolling a FIDO2 security token, controls whether to require user verification when unlocking the account (the FIDO2
562 "uv"
563 feature)\&. Defaults to
564 "no"\&. (Note: this setting is without effect if the security token does not support the
565 "uv"
566 feature at all, or does not allow enabling or disabling it\&.)
567 .sp
568 Added in version 249\&.
569 .RE
570 .PP
571 \fB\-\-recovery\-key=\fR\fB\fIBOOL\fR\fR
572 .RS 4
573 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\&.
574 .sp
575 Added in version 247\&.
576 .RE
577 .PP
578 \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
579 .RS 4
580 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
581 \m[blue]\fBUser Record Blob Directories\fR\m[]\&\s-2\u[3]\d\s+2
582 for more information about blob directories\&.
583 .sp
584 Added in version 256\&.
585 .RE
586 .PP
587 \fB\-\-avatar=\fR\fB\fIPATH\fR\fR, \fB\-\-login\-background=\fR\fB\fIPATH\fR\fR
588 .RS 4
589 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
590 \fB\-\-blob=\fR\fB\fIFILENAME\fR\fR\fB=\fR\fB\fIPATH\fR\fR
591 for the known filenames defined in
592 \m[blue]\fBUser Record Blob Directories\fR\m[]\&\s-2\u[3]\d\s+2\&.
593 .sp
594 Added in version 256\&.
595 .RE
596 .PP
597 \fB\-\-locked=\fR\fB\fIBOOLEAN\fR\fR
598 .RS 4
599 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)\&.
600 .sp
601 Added in version 245\&.
602 .RE
603 .PP
604 \fB\-\-not\-before=\fR\fB\fITIMESTAMP\fR\fR, \fB\-\-not\-after=\fR\fB\fITIMESTAMP\fR\fR
605 .RS 4
606 These options take a timestamp string, in the format documented in
607 \fBsystemd.time\fR(7)
608 and configures points in time before and after logins into this account are not permitted\&.
609 .sp
610 Added in version 245\&.
611 .RE
612 .PP
613 \fB\-\-rate\-limit\-interval=\fR\fB\fISECS\fR\fR, \fB\-\-rate\-limit\-burst=\fR\fB\fINUMBER\fR\fR
614 .RS 4
615 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\&.
616 .sp
617 Added in version 245\&.
618 .RE
619 .PP
620 \fB\-\-password\-hint=\fR\fB\fITEXT\fR\fR
621 .RS 4
622 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:
623 \fB\-\-password\-hint="My first pet\*(Aqs name"\fR\&.
624 .sp
625 Added in version 245\&.
626 .RE
627 .PP
628 \fB\-\-enforce\-password\-policy=\fR\fB\fIBOOL\fR\fR, \fB\-P\fR
629 .RS 4
630 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\&.
631 \fB\-P\fR
632 is short for
633 \fB\-\-enforce\-password\-policy=no\fR\&.
634 .sp
635 Added in version 245\&.
636 .RE
637 .PP
638 \fB\-\-password\-change\-now=\fR\fB\fIBOOL\fR\fR
639 .RS 4
640 Takes a boolean argument\&. If true the user is asked to change their password on next login\&.
641 .sp
642 Added in version 245\&.
643 .RE
644 .PP
645 \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
646 .RS 4
647 Each of these options takes a time span specification as argument (in the syntax documented in
648 \fBsystemd.time\fR(7)) and configures various aspects of the user\*(Aqs password expiration policy\&. Specifically,
649 \fB\-\-password\-change\-min=\fR
650 configures how much time has to pass after changing the password of the user until the password may be changed again\&. If the user tries to change their password before this time passes the attempt is refused\&.
651 \fB\-\-password\-change\-max=\fR
652 configures how soon after it has been changed the password expires and needs to be changed again\&. After this time passes logging in may only proceed after the password is changed\&.
653 \fB\-\-password\-change\-warn=\fR
654 specifies how much earlier than then the time configured with
655 \fB\-\-password\-change\-max=\fR
656 the user is warned at login to change their password as it will expire soon\&. Finally,
657 \fB\-\-password\-change\-inactive=\fR
658 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\&.
659 .sp
660 Added in version 245\&.
661 .RE
662 .PP
663 \fB\-\-disk\-size=\fR\fB\fIBYTES\fR\fR
664 .RS 4
665 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
666 "min"
667 or
668 "max", and configures the disk space to assign to the user\&. If a percentage value is specified (i\&.e\&. the argument suffixed with
669 "%") it is taken relative to the available disk space of the backing file system\&. If specified as
670 "min"
671 assigns the minimal disk space permitted by the constraints of the backing file system and other limits, when specified as
672 "max"
673 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\&.
674 .sp
675 Added in version 245\&.
676 .RE
677 .PP
678 \fB\-\-access\-mode=\fR\fB\fIMODE\fR\fR
679 .RS 4
680 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:
681 \fB\-\-access\-mode=0700\fR
682 .sp
683 Added in version 245\&.
684 .RE
685 .PP
686 \fB\-\-umask=\fR\fB\fIMASK\fR\fR
687 .RS 4
688 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\&.
689 .sp
690 Added in version 245\&.
691 .RE
692 .PP
693 \fB\-\-nice=\fR\fB\fINICE\fR\fR
694 .RS 4
695 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)\&.
696 .sp
697 Added in version 245\&.
698 .RE
699 .PP
700 \fB\-\-rlimit=\fR\fB\fILIMIT\fR\fR\fB=\fR\fB\fIVALUE\fR\fR\fB[:\fIVALUE\fR]\fR
701 .RS 4
702 Allows configuration of resource limits for processes of this user, see
703 \fBgetrlimit\fR(2)
704 for details\&. Takes a resource limit name (e\&.g\&.
705 "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\&.
706 .sp
707 Added in version 245\&.
708 .RE
709 .PP
710 \fB\-\-tasks\-max=\fR\fB\fITASKS\fR\fR
711 .RS 4
712 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
713 \fBsu\fR(1)
714 or a similar tool\&. Use
715 \fB\-\-rlimit=LIMIT_NPROC=\fR
716 to place a limit on the tasks actually running under the UID of the user, thus excluding any child processes that might have changed user identity\&. This controls the
717 \fITasksMax=\fR
718 setting of the per\-user systemd slice unit
719 user\-$UID\&.slice\&. See
720 \fBsystemd.resource-control\fR(5)
721 for further details\&.
722 .sp
723 Added in version 245\&.
724 .RE
725 .PP
726 \fB\-\-memory\-high=\fR\fB\fIBYTES\fR\fR, \fB\-\-memory\-max=\fR\fB\fIBYTES\fR\fR
727 .RS 4
728 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
729 \fIMemoryHigh=\fR
730 and
731 \fIMemoryMax=\fR
732 settings of the per\-user systemd slice unit
733 user\-$UID\&.slice\&. See
734 \fBsystemd.resource-control\fR(5)
735 for further details\&.
736 .sp
737 Added in version 245\&.
738 .RE
739 .PP
740 \fB\-\-cpu\-weight=\fR\fB\fIWEIGHT\fR\fR, \fB\-\-io\-weight=\fR\fB\fIWEIGHT\fR\fR
741 .RS 4
742 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
743 \fICPUWeight=\fR
744 and
745 \fIIOWeight=\fR
746 settings of the per\-user systemd slice unit
747 user\-$UID\&.slice\&. See
748 \fBsystemd.resource-control\fR(5)
749 for further details\&.
750 .sp
751 Added in version 245\&.
752 .RE
753 .PP
754 \fB\-\-storage=\fR\fB\fISTORAGE\fR\fR
755 .RS 4
756 Selects the storage mechanism to use for this home directory\&. Takes one of
757 "luks",
758 "fscrypt",
759 "directory",
760 "subvolume",
761 "cifs"\&. For details about these mechanisms, see above\&. If a new home directory is created and the storage type is not specifically specified,
762 \fBhomed.conf\fR(5)
763 defines which default storage to use\&.
764 .sp
765 Added in version 245\&.
766 .RE
767 .PP
768 \fB\-\-image\-path=\fR\fB\fIPATH\fR\fR
769 .RS 4
770 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
771 /home/
772 or any other accessible filesystem)\&. When unspecified defaults to
773 /home/$USER\&.home
774 when LUKS storage is used and
775 /home/$USER\&.homedir
776 for the other storage mechanisms\&. Not defined for the
777 "cifs"
778 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\&.
779 .sp
780 Added in version 245\&.
781 .RE
782 .PP
783 \fB\-\-drop\-caches=\fR\fB\fIBOOL\fR\fR
784 .RS 4
785 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\&.
786 .sp
787 Added in version 250\&.
788 .RE
789 .PP
790 \fB\-\-fs\-type=\fR\fB\fITYPE\fR\fR
791 .RS 4
792 When LUKS2 storage is used configures the file system type to use inside the home directory LUKS2 container\&. One of
793 "btrfs",
794 "ext4",
795 "xfs"\&. If not specified
796 \fBhomed.conf\fR(5)
797 defines which default file system type to use\&. Note that
798 "xfs"
799 is not recommended as its support for file system resizing is too limited\&.
800 .sp
801 Added in version 245\&.
802 .RE
803 .PP
804 \fB\-\-luks\-discard=\fR\fB\fIBOOL\fR\fR
805 .RS 4
806 When LUKS2 storage is used configures whether to enable the
807 "discard"
808 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\&.
809 .sp
810 Added in version 245\&.
811 .RE
812 .PP
813 \fB\-\-luks\-offline\-discard=\fR\fB\fIBOOL\fR\fR
814 .RS 4
815 Similar to
816 \fB\-\-luks\-discard=\fR, controls the trimming of the file system\&. However, while
817 \fB\-\-luks\-discard=\fR
818 controls what happens when the home directory is active,
819 \fB\-\-luks\-offline\-discard=\fR
820 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\&.
821 .sp
822 Added in version 246\&.
823 .RE
824 .PP
825 \fB\-\-luks\-extra\-mount\-options=\fR\fB\fIOPTIONS\fR\fR
826 .RS 4
827 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\&.
828 .sp
829 Added in version 250\&.
830 .RE
831 .PP
832 \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
833 .RS 4
834 Configures various cryptographic parameters for the LUKS2 storage mechanism\&. See
835 \fBcryptsetup\fR(8)
836 for details on the specific attributes\&.
837 .sp
838 Note that
839 \fBhomectl\fR
840 uses bytes for key size, like
841 /proc/crypto, but
842 \fBcryptsetup\fR(8)
843 uses bits\&.
844 .sp
845 Added in version 245\&.
846 .RE
847 .PP
848 \fB\-\-auto\-resize\-mode=\fR
849 .RS 4
850 Configures whether to automatically grow and/or shrink the backing file system on login and logout\&. Takes one of the strings
851 "off",
852 "grow",
853 "shrink\-and\-grow"\&. Only applies to the LUKS2 backend currently, and if the btrfs file system is used inside it (since only then online growing/shrinking of the file system is supported)\&. Defaults to
854 "shrink\-and\-grow", if LUKS2/btrfs is used, otherwise is off\&. If set to
855 "off"
856 no automatic shrinking/growing during login or logout is done\&. If set to
857 "grow"
858 the home area is grown to the size configured via
859 \fB\-\-disk\-size=\fR
860 should it currently be smaller\&. If it already matches the configured size or is larger no operation is executed\&. If set to
861 "shrink\-and\-grow"
862 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\&.
863 .sp
864 Added in version 250\&.
865 .RE
866 .PP
867 \fB\-\-rebalance\-weight=\fR
868 .RS 4
869 Configures the weight parameter for the free disk space rebalancing logic\&. Only applies to the LUKS2 backend (since for the LUKS2 backend disk space is allocated from a per\-user loopback file system instead of immediately from a common pool like the other backends do it)\&. In regular intervals free disk space in the active home areas and their backing storage is redistributed among them, taking the weight value configured here into account\&. Expects an integer in the range 1\&...10000, or the special string
870 "off"\&. If not specified, defaults to 100\&. The weight is used to scale free space made available to the home areas: a home area with a weight of 200 will get twice the free space as one with a weight of 100; a home area with a weight of 50 will get half of that\&. The backing file system will be assigned space for a weight of 20\&. If set to
871 "off"
872 no automatic free space distribution is done for this home area\&. Note that resizing the home area explicitly (with
873 \fBhomectl resize\fR
874 see below) will implicitly turn off the automatic rebalancing\&. To reenable the automatic rebalancing use
875 \fB\-\-rebalance\-weight=\fR
876 with an empty parameter\&.
877 .sp
878 Added in version 250\&.
879 .RE
880 .PP
881 \fB\-\-nosuid=\fR\fB\fIBOOL\fR\fR, \fB\-\-nodev=\fR\fB\fIBOOL\fR\fR, \fB\-\-noexec=\fR\fB\fIBOOL\fR\fR
882 .RS 4
883 Configures the
884 "nosuid",
885 "nodev"
886 and
887 "noexec"
888 mount options for the home directories\&. By default,
889 "nodev"
890 and
891 "nosuid"
892 are on, while
893 "noexec"
894 is off\&. For details about these mount options see
895 \fBmount\fR(8)\&.
896 .sp
897 Added in version 245\&.
898 .RE
899 .PP
900 \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
901 .RS 4
902 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
903 "cifs"
904 storage is selected\&. The file share should be specified in format
905 "//\fIhost\fR/\fIshare\fR/\fIdirectory/\&...\fR"\&. The directory part is optional \(em if not specified, the home directory will be placed in the top\-level directory of the share\&. The
906 \fB\-\-cifs\-extra\-mount\-options=\fR
907 setting allows specifying additional mount options when mounting the share, see
908 \fBmount.cifs\fR(8)
909 for details\&.
910 .sp
911 Added in version 245\&.
912 .RE
913 .PP
914 \fB\-\-stop\-delay=\fR\fB\fISECS\fR\fR
915 .RS 4
916 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
917 \fBlogind.conf\fR(5)
918 (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 does not have to be started every time\&.
919 .sp
920 Added in version 245\&.
921 .RE
922 .PP
923 \fB\-\-kill\-processes=\fR\fB\fIBOOL\fR\fR
924 .RS 4
925 Configures whether to kill all processes of the user on logout\&. The default is configured in
926 \fBlogind.conf\fR(5)\&.
927 .sp
928 Added in version 245\&.
929 .RE
930 .PP
931 \fB\-\-auto\-login=\fR\fB\fIBOOL\fR\fR
932 .RS 4
933 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\&.
934 .sp
935 Added in version 245\&.
936 .RE
937 .PP
938 \fB\-\-session\-launcher=\fR\fB\fILAUNCHER\fR\fR
939 .RS 4
940 Takes a string argument\&. Configures the user\*(Aqs preferred session launcher \&.desktop entry file (i\&.e\&.
941 "gnome",
942 "plasma", or other names that appear in
943 /usr/share/xesssions/
944 or
945 /usr/share/wayland\-sessions)\&. This is read by the display manager to pick the default session that is launched when the user logs in\&.
946 .sp
947 Added in version 256\&.
948 .RE
949 .PP
950 \fB\-\-session\-type=\fR\fB\fITYPE\fR\fR
951 .RS 4
952 Takes a string argument\&. Configures the user\*(Aqs preferred session type (i\&.e\&.
953 "x11",
954 "wayland", and other values accepted by
955 \fI$XDG_SESSION_TYPE\fR)\&. This is read by the display manage to pick the default session type the user is logged into\&.
956 .sp
957 Added in version 256\&.
958 .RE
959 .SH "COMMANDS"
960 .PP
961 The following commands are understood:
962 .PP
963 \fBlist\fR
964 .RS 4
965 List all home directories (along with brief details) currently managed by
966 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
967 /etc/passwd\&.)
968 .sp
969 Added in version 245\&.
970 .RE
971 .PP
972 \fBactivate\fR \fIUSER\fR [\fIUSER\&...\fR]
973 .RS 4
974 Activate one or more home directories\&. The home directories of each listed user will be activated and made available under their mount points (typically in
975 /home/$USER)\&. Note that any home activated this way stays active indefinitely, until it is explicitly deactivated again (with
976 \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\&.
977 .sp
978 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\&.
979 .sp
980 Added in version 245\&.
981 .RE
982 .PP
983 \fBdeactivate\fR \fIUSER\fR [\fIUSER\&...\fR]
984 .RS 4
985 Deactivate one or more home directories\&. This undoes the effect of
986 \fBactivate\fR\&.
987 .sp
988 Added in version 245\&.
989 .RE
990 .PP
991 \fBinspect\fR \fIUSER\fR [\fIUSER\&...\fR]
992 .RS 4
993 Show various details about the specified home directories\&. This shows various information about the home directory and its user account, including runtime data such as current state, disk use and similar\&. Combine with
994 \fB\-\-json=\fR
995 to show the detailed JSON user record instead, possibly combined with
996 \fB\-\-export\-format=\fR
997 to suppress certain aspects of the output\&.
998 .sp
999 Added in version 245\&.
1000 .RE
1001 .PP
1002 \fBauthenticate\fR \fIUSER\fR [\fIUSER\&...\fR]
1003 .RS 4
1004 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\&.
1005 .sp
1006 Added in version 245\&.
1007 .RE
1008 .PP
1009 \fBcreate\fR \fIUSER\fR, \fBcreate\fR \fB\-\-identity=\fR\fB\fIPATH\fR\fR [\fIUSER\fR]
1010 .RS 4
1011 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\&.
1012 .sp
1013 The specified user name should follow the strict syntax described on
1014 \m[blue]\fBUser/Group Name Syntax\fR\m[]\&\s-2\u[4]\d\s+2\&.
1015 .sp
1016 Added in version 245\&.
1017 .RE
1018 .PP
1019 \fBremove\fR \fIUSER\fR
1020 .RS 4
1021 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\&.
1022 .sp
1023 Added in version 245\&.
1024 .RE
1025 .PP
1026 \fBupdate\fR \fIUSER\fR, \fBupdate\fR \fB\-\-identity=\fR\fB\fIPATH\fR\fR [\fIUSER\fR]
1027 .RS 4
1028 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
1029 \fB\-\-identity=\fR
1030 option\&.
1031 .sp
1032 Note that changes to user records not signed by a cryptographic private key available locally are not permitted, unless
1033 \fB\-\-identity=\fR
1034 is used with a user record that is already correctly signed by a recognized private key\&.
1035 .sp
1036 Added in version 245\&.
1037 .RE
1038 .PP
1039 \fBpasswd\fR \fIUSER\fR
1040 .RS 4
1041 Change the password of the specified home directory/user account\&.
1042 .sp
1043 Added in version 245\&.
1044 .RE
1045 .PP
1046 \fBresize\fR \fIUSER\fR \fIBYTES\fR
1047 .RS 4
1048 Change the disk space assigned to the specified home directory\&. If the LUKS2 storage mechanism is used this will automatically resize the loopback file and the file system contained within\&. Note that if
1049 "ext4"
1050 is used inside of the LUKS2 volume, it is necessary to deactivate the home directory before shrinking it (i\&.e the user has to log out)\&. Growing can be done while the home directory is active\&. If
1051 "xfs"
1052 is used inside of the LUKS2 volume the home directory may not be shrunk whatsoever\&. On all three of
1053 "ext4",
1054 "xfs"
1055 and
1056 "btrfs"
1057 the home directory may be grown while the user is logged in, and on the latter also shrunk while the user is logged in\&. If the
1058 "subvolume",
1059 "directory",
1060 "fscrypt"
1061 storage mechanisms are used, resizing will change file system quota\&. The size parameter may make use of the usual suffixes B, K, M, G, T (to the base of 1024)\&. The special strings
1062 "min"
1063 and
1064 "max"
1065 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\&.
1066 .sp
1067 Added in version 245\&.
1068 .RE
1069 .PP
1070 \fBlock\fR \fIUSER\fR
1071 .RS 4
1072 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\&.
1073 .sp
1074 Added in version 245\&.
1075 .RE
1076 .PP
1077 \fBunlock\fR \fIUSER\fR
1078 .RS 4
1079 Resume access to the user\*(Aqs home directory again, undoing the effect of
1080 \fBlock\fR
1081 above\&. This requires authentication of the user, as the cryptographic keys required for access to the home directory need to be reacquired\&.
1082 .sp
1083 Added in version 245\&.
1084 .RE
1085 .PP
1086 \fBlock\-all\fR
1087 .RS 4
1088 Execute the
1089 \fBlock\fR
1090 command on all suitable home directories at once\&. This operation is generally executed on system suspend (i\&.e\&. by
1091 \fBsystemctl suspend\fR
1092 and related commands), to ensure all active user\*(Aqs cryptographic keys for accessing their home directories are removed from memory\&.
1093 .sp
1094 Added in version 245\&.
1095 .RE
1096 .PP
1097 \fBdeactivate\-all\fR
1098 .RS 4
1099 Execute the
1100 \fBdeactivate\fR
1101 command on all active home directories at once\&. This operation is generally executed on system shut down (i\&.e\&. by
1102 \fBsystemctl poweroff\fR
1103 and related commands), to ensure all active user\*(Aqs home directories are fully deactivated before
1104 /home/
1105 and related file systems are unmounted\&.
1106 .sp
1107 Added in version 247\&.
1108 .RE
1109 .PP
1110 \fBwith\fR \fIUSER\fR \fICOMMAND\&...\fR
1111 .RS 4
1112 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\&.
1113 .sp
1114 Added in version 245\&.
1115 .RE
1116 .PP
1117 \fBrebalance\fR
1118 .RS 4
1119 Rebalance free disk space between active home areas and the backing storage\&. See
1120 \fB\-\-rebalance\-weight=\fR
1121 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\&.
1122 .sp
1123 Added in version 250\&.
1124 .RE
1125 .PP
1126 \fBfirstboot\fR
1127 .RS 4
1128 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 (only if
1129 \fB\-\-prompt\-new\-user\fR
1130 is specified)\&. Alternatively, if one or more service credentials whose name starts with
1131 "home\&.create\&."
1132 are passed to the command (containing a user record in JSON format) these users are automatically created at boot\&.
1133 .sp
1134 This command is invoked by the
1135 systemd\-homed\-firstboot\&.service
1136 service unit\&.
1137 .sp
1138 Added in version 256\&.
1139 .RE
1140 .SH "CREDENTIALS"
1141 .PP
1142 When invoked with the
1143 \fBfirstboot\fR
1144 command,
1145 \fBhomectl\fR
1146 supports the service credentials logic as implemented by
1147 \fIImportCredential=\fR/\fILoadCredential=\fR/\fISetCredential=\fR
1148 (see
1149 \fBsystemd.exec\fR(5)
1150 for details)\&. The following credentials are used when passed in:
1151 .PP
1152 \fIhome\&.create\&.*\fR
1153 .RS 4
1154 If one or more credentials whose names begin with
1155 "home\&.create\&.", followed by a valid UNIX username are passed, a new home area is created, one for each specified user record\&.
1156 .sp
1157 Added in version 256\&.
1158 .RE
1159 .SH "KERNEL COMMAND LINE"
1160 .PP
1161 \fIsystemd\&.firstboot=\fR
1162 .RS 4
1163 This boolean will disable the effect of
1164 \fBhomectl firstboot\fR
1165 command\&. It\*(Aqs primarily interpreted by
1166 \fBsystemd-firstboot\fR(1)\&.
1167 .sp
1168 Added in version 256\&.
1169 .RE
1170 .SH "EXIT STATUS"
1171 .PP
1172 On success, 0 is returned, a non\-zero failure code otherwise\&.
1173 .PP
1174 When a command is invoked with
1175 \fBwith\fR, the exit status of the child is propagated\&. Effectively,
1176 \fBhomectl\fR
1177 will exit without error if the command is successfully invoked
1178 \fIand\fR
1179 finishes successfully\&.
1180 .SH "ENVIRONMENT"
1181 .PP
1182 \fI$SYSTEMD_LOG_LEVEL\fR
1183 .RS 4
1184 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)
1185 \fBemerg\fR,
1186 \fBalert\fR,
1187 \fBcrit\fR,
1188 \fBerr\fR,
1189 \fBwarning\fR,
1190 \fBnotice\fR,
1191 \fBinfo\fR,
1192 \fBdebug\fR, or an integer in the range 0\&...7\&. See
1193 \fBsyslog\fR(3)
1194 for more information\&. Each value may optionally be prefixed with one of
1195 \fBconsole\fR,
1196 \fBsyslog\fR,
1197 \fBkmsg\fR
1198 or
1199 \fBjournal\fR
1200 followed by a colon to set the maximum log level for that specific log target (e\&.g\&.
1201 \fBSYSTEMD_LOG_LEVEL=debug,console:info\fR
1202 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\&.
1203 .RE
1204 .PP
1205 \fI$SYSTEMD_LOG_COLOR\fR
1206 .RS 4
1207 A boolean\&. If true, messages written to the tty will be colored according to priority\&.
1208 .sp
1209 This setting is only useful when messages are written directly to the terminal, because
1210 \fBjournalctl\fR(1)
1211 and other tools that display logs will color messages based on the log level on their own\&.
1212 .RE
1213 .PP
1214 \fI$SYSTEMD_LOG_TIME\fR
1215 .RS 4
1216 A boolean\&. If true, console log messages will be prefixed with a timestamp\&.
1217 .sp
1218 This setting is only useful when messages are written directly to the terminal or a file, because
1219 \fBjournalctl\fR(1)
1220 and other tools that display logs will attach timestamps based on the entry metadata on their own\&.
1221 .RE
1222 .PP
1223 \fI$SYSTEMD_LOG_LOCATION\fR
1224 .RS 4
1225 A boolean\&. If true, messages will be prefixed with a filename and line number in the source code where the message originates\&.
1226 .sp
1227 Note that the log location is often attached as metadata to journal entries anyway\&. Including it directly in the message text can nevertheless be convenient when debugging programs\&.
1228 .RE
1229 .PP
1230 \fI$SYSTEMD_LOG_TID\fR
1231 .RS 4
1232 A boolean\&. If true, messages will be prefixed with the current numerical thread ID (TID)\&.
1233 .sp
1234 Note that the this information is attached as metadata to journal entries anyway\&. Including it directly in the message text can nevertheless be convenient when debugging programs\&.
1235 .RE
1236 .PP
1237 \fI$SYSTEMD_LOG_TARGET\fR
1238 .RS 4
1239 The destination for log messages\&. One of
1240 \fBconsole\fR
1241 (log to the attached tty),
1242 \fBconsole\-prefixed\fR
1243 (log to the attached tty but with prefixes encoding the log level and "facility", see
1244 \fBsyslog\fR(3),
1245 \fBkmsg\fR
1246 (log to the kernel circular log buffer),
1247 \fBjournal\fR
1248 (log to the journal),
1249 \fBjournal\-or\-kmsg\fR
1250 (log to the journal if available, and to kmsg otherwise),
1251 \fBauto\fR
1252 (determine the appropriate log target automatically, the default),
1253 \fBnull\fR
1254 (disable log output)\&.
1255 .RE
1256 .PP
1257 \fI$SYSTEMD_LOG_RATELIMIT_KMSG\fR
1258 .RS 4
1259 Whether to ratelimit kmsg or not\&. Takes a boolean\&. Defaults to
1260 "true"\&. If disabled, systemd will not ratelimit messages written to kmsg\&.
1261 .RE
1262 .PP
1263 \fI$SYSTEMD_PAGER\fR, \fI$PAGER\fR
1264 .RS 4
1265 Pager to use when
1266 \fB\-\-no\-pager\fR
1267 is not given\&.
1268 \fI$SYSTEMD_PAGER\fR
1269 is used if set; otherwise
1270 \fI$PAGER\fR
1271 is used\&. If neither
1272 \fI$SYSTEMD_PAGER\fR
1273 nor
1274 \fI$PAGER\fR
1275 are set, a set of well\-known pager implementations is tried in turn, including
1276 \fBless\fR(1)
1277 and
1278 \fBmore\fR(1), until one is found\&. If no pager implementation is discovered, no pager is invoked\&. Setting those environment variables to an empty string or the value
1279 "cat"
1280 is equivalent to passing
1281 \fB\-\-no\-pager\fR\&.
1282 .sp
1283 Note: if
1284 \fI$SYSTEMD_PAGERSECURE\fR
1285 is not set,
1286 \fI$SYSTEMD_PAGER\fR
1287 and
1288 \fI$PAGER\fR
1289 can only be used to disable the pager (with
1290 "cat"
1291 or
1292 ""), and are otherwise ignored\&.
1293 .RE
1294 .PP
1295 \fI$SYSTEMD_LESS\fR
1296 .RS 4
1297 Override the options passed to
1298 \fBless\fR
1299 (by default
1300 "FRSXMK")\&.
1301 .sp
1302 Users might want to change two options in particular:
1303 .PP
1304 \fBK\fR
1305 .RS 4
1306 This option instructs the pager to exit immediately when
1307 Ctrl+C
1308 is pressed\&. To allow
1309 \fBless\fR
1310 to handle
1311 Ctrl+C
1312 itself to switch back to the pager command prompt, unset this option\&.
1313 .sp
1314 If the value of
1315 \fI$SYSTEMD_LESS\fR
1316 does not include
1317 "K", and the pager that is invoked is
1318 \fBless\fR,
1319 Ctrl+C
1320 will be ignored by the executable, and needs to be handled by the pager\&.
1321 .RE
1322 .PP
1323 \fBX\fR
1324 .RS 4
1325 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\&.
1326 .RE
1327 .sp
1328 Note that setting the regular
1329 \fI$LESS\fR
1330 environment variable has no effect for
1331 \fBless\fR
1332 invocations by systemd tools\&.
1333 .sp
1334 See
1335 \fBless\fR(1)
1336 for more discussion\&.
1337 .RE
1338 .PP
1339 \fI$SYSTEMD_LESSCHARSET\fR
1340 .RS 4
1341 Override the charset passed to
1342 \fBless\fR
1343 (by default
1344 "utf\-8", if the invoking terminal is determined to be UTF\-8 compatible)\&.
1345 .sp
1346 Note that setting the regular
1347 \fI$LESSCHARSET\fR
1348 environment variable has no effect for
1349 \fBless\fR
1350 invocations by systemd tools\&.
1351 .RE
1352 .PP
1353 \fI$SYSTEMD_PAGERSECURE\fR
1354 .RS 4
1355 Common pager commands like
1356 \fBless\fR(1), in addition to "paging", i\&.e\&. scrolling through the output, support opening of or writing to other files and running arbitrary shell commands\&. When commands are invoked with elevated privileges, for example under
1357 \fBsudo\fR(8)
1358 or
1359 \fBpkexec\fR(1), the pager becomes a security boundary\&. Care must be taken that only programs with strictly limited functionality are used as pagers, and unintended interactive features like opening or creation of new files or starting of subprocesses are not allowed\&. "Secure mode" for the pager may be enabled as described below,
1360 \fIif the pager supports that\fR
1361 (most pagers are not written in a way that takes this into consideration)\&. It is recommended to either explicitly enable "secure mode" or to completely disable the pager using
1362 \fB\-\-no\-pager\fR
1363 or
1364 \fIPAGER=cat\fR
1365 when allowing untrusted users to execute commands with elevated privileges\&.
1366 .sp
1367 This option takes a boolean argument\&. When set to true, the "secure mode" of the pager is enabled\&. In "secure mode",
1368 \fBLESSSECURE=1\fR
1369 will be set when invoking the pager, which instructs the pager to disable commands that open or create new files or start new subprocesses\&. Currently only
1370 \fBless\fR(1)
1371 is known to understand this variable and implement "secure mode"\&.
1372 .sp
1373 When set to false, no limitation is placed on the pager\&. Setting
1374 \fISYSTEMD_PAGERSECURE=0\fR
1375 or not removing it from the inherited environment may allow the user to invoke arbitrary commands\&.
1376 .sp
1377 When
1378 \fI$SYSTEMD_PAGERSECURE\fR
1379 is not set, systemd tools attempt to automatically figure out if "secure mode" should be enabled and whether the pager supports it\&. "Secure mode" is enabled if the effective UID is not the same as the owner of the login session, see
1380 \fBgeteuid\fR(2)
1381 and
1382 \fBsd_pid_get_owner_uid\fR(3), or when running under
1383 \fBsudo\fR(8)
1384 or similar tools (\fI$SUDO_UID\fR
1385 is set
1386 \&\s-2\u[5]\d\s+2)\&. In those cases,
1387 \fISYSTEMD_PAGERSECURE=1\fR
1388 will be set and pagers which are not known to implement "secure mode" will not be used at all\&. Note that this autodetection only covers the most common mechanisms to elevate privileges and is intended as convenience\&. It is recommended to explicitly set
1389 \fI$SYSTEMD_PAGERSECURE\fR
1390 or disable the pager\&.
1391 .sp
1392 Note that if the
1393 \fI$SYSTEMD_PAGER\fR
1394 or
1395 \fI$PAGER\fR
1396 variables are to be honoured, other than to disable the pager,
1397 \fI$SYSTEMD_PAGERSECURE\fR
1398 must be set too\&.
1399 .RE
1400 .PP
1401 \fI$SYSTEMD_COLORS\fR
1402 .RS 4
1403 Takes a boolean argument\&. When true,
1404 \fBsystemd\fR
1405 and related utilities will use colors in their output, otherwise the output will be monochrome\&. Additionally, the variable can take one of the following special values:
1406 "16",
1407 "256"
1408 to restrict the use of colors to the base 16 or 256 ANSI colors, respectively\&. This can be specified to override the automatic decision based on
1409 \fI$TERM\fR
1410 and what the console is connected to\&.
1411 .RE
1412 .PP
1413 \fI$SYSTEMD_URLIFY\fR
1414 .RS 4
1415 The value must be a boolean\&. Controls whether clickable links should be generated in the output for terminal emulators supporting this\&. This can be specified to override the decision that
1416 \fBsystemd\fR
1417 makes based on
1418 \fI$TERM\fR
1419 and other conditions\&.
1420 .RE
1421 .SH "EXAMPLES"
1422 .PP
1423 \fBExample\ \&1.\ \&Create a user "waldo" in the administrator group "wheel", and assign 500 MiB disk space to them\&.\fR
1424 .sp
1425 .if n \{\
1426 .RS 4
1427 .\}
1428 .nf
1429 homectl create waldo \-\-real\-name="Waldo McWaldo" \-G wheel \-\-disk\-size=500M
1430 .fi
1431 .if n \{\
1432 .RE
1433 .\}
1434 .PP
1435 \fBExample\ \&2.\ \&Create a user "wally" on a USB stick, and assign a maximum of 500 concurrent tasks to them\&.\fR
1436 .sp
1437 .if n \{\
1438 .RS 4
1439 .\}
1440 .nf
1441 homectl create wally \-\-real\-name="Wally McWally" \-\-image\-path=/dev/disk/by\-id/usb\-SanDisk_Ultra_Fit_476fff954b2b5c44\-0:0 \-\-tasks\-max=500
1442 .fi
1443 .if n \{\
1444 .RE
1445 .\}
1446 .PP
1447 \fBExample\ \&3.\ \&Change nice level of user "odlaw" to +5 and make sure the environment variable \fI$SOME\fR is set to the string "THING" for them on login\&.\fR
1448 .sp
1449 .if n \{\
1450 .RS 4
1451 .\}
1452 .nf
1453 homectl update odlaw \-\-nice=5 \-\-setenv=SOME=THING
1454 .fi
1455 .if n \{\
1456 .RE
1457 .\}
1458 .PP
1459 \fBExample\ \&4.\ \&Set up authentication with a YubiKey security token using PKCS#11/PIV:\fR
1460 .sp
1461 .if n \{\
1462 .RS 4
1463 .\}
1464 .nf
1465 # Clear the Yubikey from any old keys (careful!)
1466 ykman piv reset
1467
1468 # Generate a new private/public key pair on the device, store the public key in \*(Aqpubkey\&.pem\*(Aq\&.
1469 ykman piv generate\-key \-a RSA2048 9d pubkey\&.pem
1470
1471 # Create a self\-signed certificate from this public key, and store it on the device\&.
1472 ykman piv generate\-certificate \-\-subject "Knobelei" 9d pubkey\&.pem
1473
1474 # We do not need the public key on disk anymore
1475 rm pubkey\&.pem
1476
1477 # Allow the security token to unlock the account of user \*(Aqlafcadio\*(Aq\&.
1478 homectl update lafcadio \-\-pkcs11\-token\-uri=auto
1479 .fi
1480 .if n \{\
1481 .RE
1482 .\}
1483 .PP
1484 \fBExample\ \&5.\ \&Set up authentication with a FIDO2 security token:\fR
1485 .sp
1486 .if n \{\
1487 .RS 4
1488 .\}
1489 .nf
1490 # Allow a FIDO2 security token to unlock the account of user \*(Aqnihilbaxter\*(Aq\&.
1491 homectl update nihilbaxter \-\-fido2\-device=auto
1492 .fi
1493 .if n \{\
1494 .RE
1495 .\}
1496 .SH "SEE ALSO"
1497 .PP
1498 \fBsystemd\fR(1), \fBsystemd-homed.service\fR(8), \fBhomed.conf\fR(5), \fBuserdbctl\fR(1), \fBuseradd\fR(8), \fBcryptsetup\fR(8)
1499 .SH "NOTES"
1500 .IP " 1." 4
1501 JSON User Records
1502 .RS 4
1503 \%https://systemd.io/USER_RECORD
1504 .RE
1505 .IP " 2." 4
1506 Icon Naming Specification
1507 .RS 4
1508 \%https://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html
1509 .RE
1510 .IP " 3." 4
1511 User Record Blob Directories
1512 .RS 4
1513 \%https://systemd.io/USER_RECORD_BLOB_DIRS
1514 .RE
1515 .IP " 4." 4
1516 User/Group Name Syntax
1517 .RS 4
1518 \%https://systemd.io/USER_NAMES
1519 .RE
1520 .IP " 5." 4
1521 It is recommended for other tools to set and check
1522 \fI$SUDO_UID\fR
1523 as appropriate, treating it is a common interface.
1524