Debian Codegraph @

upstream/fedora-44/man8/systemd-sysext.8

raw
1 '\" t
2 .TH "SYSTEMD\-SYSEXT" "8" "" "systemd 259.5" "systemd-sysext"
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 systemd-sysext, systemd-sysext.service, systemd-sysext-initrd.service, systemd-confext, systemd-confext.service, systemd-confext-initrd.service \- Activates System Extension Images
24 .SH "SYNOPSIS"
25 .HP \w'\fBsystemd\-sysext\fR\ 'u
26 \fBsystemd\-sysext\fR [OPTIONS...] COMMAND
27 .PP
28 systemd\-sysext\&.service
29 .HP \w'\fBsystemd\-confext\fR\ 'u
30 \fBsystemd\-confext\fR [OPTIONS...] COMMAND
31 .PP
32 systemd\-confext\&.service
33 .SH "DESCRIPTION"
34 .PP
35 \fBsystemd\-sysext\fR
36 activates/deactivates system extension images\&. System extension images may \(en dynamically at runtime \(em extend the
37 /usr/
38 and
39 /opt/
40 directory hierarchies with additional files\&. This is particularly useful on immutable system images where a
41 /usr/
42 and/or
43 /opt/
44 hierarchy residing on a read\-only file system shall be extended temporarily at runtime without making any persistent modifications\&.
45 .PP
46 System extension images should contain files and directories similar in fashion to regular operating system tree\&. When one or more system extension images are activated, their
47 /usr/
48 and
49 /opt/
50 hierarchies are combined via
51 "overlayfs"
52 with the same hierarchies of the host OS, and the host
53 /usr/
54 and
55 /opt/
56 overmounted with it ("merging")\&. When they are deactivated, the mount point is disassembled \(em again revealing the unmodified original host version of the hierarchy ("unmerging")\&. Merging thus makes the extension\*(Aqs resources suddenly appear below the
57 /usr/
58 and
59 /opt/
60 hierarchies as if they were included in the base OS image itself\&. Unmerging makes them disappear again, leaving in place only the files that were shipped with the base OS image itself\&.
61 .PP
62 Files and directories contained in the extension images outside of the
63 /usr/
64 and
65 /opt/
66 hierarchies are
67 \fInot\fR
68 merged, and hence have no effect when included in a system extension image\&. In particular, files in the
69 /etc/
70 and
71 /var/
72 included in a system extension image will
73 \fInot\fR
74 appear in the respective hierarchies after activation\&.
75 .PP
76 System extension images are strictly read\-only by default\&. On mutable host file systems,
77 /usr/
78 and
79 /opt/
80 hierarchies become read\-only while extensions are merged, unless mutability is enabled\&. Mutability may be enabled via the
81 \fB\-\-mutable=\fR
82 option and the
83 \fIMutable=\fR
84 option in the configuration file; see "Mutability" below for more information\&.
85 .PP
86 Various command options can be configured globally via configuration files\&. See
87 \fBsysext.conf\fR(5)
88 for details\&.
89 .PP
90 System extensions are supposed to be purely additive, i\&.e\&. they are supposed to include only files that do not exist in the underlying basic OS image\&. However, the underlying mechanism (overlayfs) also allows overlaying or removing files, but it is recommended not to make use of this\&.
91 .PP
92 System extension images may be provided in the following formats:
93 .sp
94 .RS 4
95 .ie n \{\
96 \h'-04' 1.\h'+01'\c
97 .\}
98 .el \{\
99 .sp -1
100 .IP " 1." 4.2
101 .\}
102 Plain directories or btrfs subvolumes containing the OS tree
103 .RE
104 .sp
105 .RS 4
106 .ie n \{\
107 \h'-04' 2.\h'+01'\c
108 .\}
109 .el \{\
110 .sp -1
111 .IP " 2." 4.2
112 .\}
113 Disk images with a GPT disk label, following the
114 \m[blue]\fBUAPI\&.2 Discoverable Partitions Specification\fR\m[]\&\s-2\u[1]\d\s+2
115 .RE
116 .sp
117 .RS 4
118 .ie n \{\
119 \h'-04' 3.\h'+01'\c
120 .\}
121 .el \{\
122 .sp -1
123 .IP " 3." 4.2
124 .\}
125 Disk images lacking a partition table, with a naked Linux file system (e\&.g\&. erofs, squashfs or ext4)
126 .RE
127 .PP
128 These image formats are the same ones that
129 \fBsystemd-nspawn\fR(1)
130 supports via its
131 \fB\-\-directory=\fR/\fB\-\-image=\fR
132 switches and those that the service manager supports via
133 \fBRootDirectory=\fR/\fBRootImage=\fR\&. Similar to them they may optionally carry Verity authentication information\&.
134 .PP
135 System extensions are searched for in the directories
136 /etc/extensions/,
137 /run/extensions/
138 and
139 /var/lib/extensions/\&. The first two listed directories are not suitable for carrying large binary images, however are still useful for carrying symlinks to them\&. The primary place for installing system extensions is
140 /var/lib/extensions/\&. Any directories found in these search directories are considered directory based extension images; any files with the
141 \&.raw
142 suffix are considered disk image based extension images\&. When invoked in the initrd, the additional directory
143 /\&.extra/sysext/
144 is included in the directories that are searched for extension images\&. Note however, that by default a tighter image policy applies to images found there, though, see below\&. This directory is populated by
145 \fBsystemd-stub\fR(7)
146 with extension images found in the system\*(Aqs EFI System Partition\&.
147 .PP
148 During boot OS extension images are activated automatically, if the
149 systemd\-sysext\&.service
150 is enabled\&. Note that this service runs only after the underlying file systems where system extensions may be located have been mounted\&. This means they are not suitable for shipping resources that are processed by subsystems running in earliest boot\&. Specifically, OS extension images are not suitable for shipping system services or
151 \fBsystemd-sysusers\fR(8)
152 definitions\&. See the
153 \m[blue]\fBPortable Services\fR\m[]\&\s-2\u[2]\d\s+2
154 page for a simple mechanism for shipping system services in disk images, in a similar fashion to OS extensions\&. Note the different isolation on these two mechanisms: while system extension directly extend the underlying OS image with additional files that appear in a way very similar to as if they were shipped in the OS image itself and thus imply no security isolation, portable services imply service level sandboxing in one way or another\&. The
155 systemd\-sysext\&.service
156 service is guaranteed to finish start\-up before
157 basic\&.target
158 is reached; i\&.e\&. at the time regular services initialize (those which do not use
159 \fIDefaultDependencies=no\fR), the files and directories system extensions provide are available in
160 /usr/
161 and
162 /opt/
163 and may be accessed\&.
164 .PP
165 Note that there is no concept of enabling/disabling installed system extension images: all installed extension images are automatically activated at boot\&. However, you can place an empty directory named like the extension (no
166 \&.raw) in
167 /etc/extensions/
168 to "mask" an extension with the same name in a system folder with lower precedence\&.
169 .PP
170 A simple mechanism for version compatibility is enforced: a system extension image must carry a
171 /usr/lib/extension\-release\&.d/extension\-release\&.\fINAME\fR
172 file, which must match its image name, that is compared with the host
173 os\-release
174 file: the contained
175 \fIID=\fR
176 fields have to match unless
177 "_any"
178 is set for the extension\&. If the extension
179 \fIID=\fR
180 is not
181 "_any", the
182 \fISYSEXT_LEVEL=\fR
183 field (if defined) has to match\&. If the latter is not defined, the
184 \fIVERSION_ID=\fR
185 field has to match instead\&. If the extension defines the
186 \fIARCHITECTURE=\fR
187 field and the value is not
188 "_any"
189 it has to match the kernel\*(Aqs architecture reported by
190 \fBuname\fR(2)
191 but the used architecture identifiers are the same as for
192 \fIConditionArchitecture=\fR
193 described in
194 \fBsystemd.unit\fR(5)\&.
195 \fIEXTENSION_RELOAD_MANAGER=\fR
196 can be set to 1 if the extension requires a service manager reload after application of the extension\&. Note that for the reasons mentioned earlier,
197 \m[blue]\fBPortable Services\fR\m[]\&\s-2\u[2]\d\s+2
198 remain the recommended way to ship system services\&. System extensions should not ship a
199 /usr/lib/os\-release
200 file (as that would be merged into the host
201 /usr/
202 tree, overriding the host OS version data, which is not desirable)\&. The
203 extension\-release
204 file follows the same format and semantics, and carries the same content, as the
205 os\-release
206 file of the OS, but it describes the resources carried in the extension image\&.
207 .PP
208 The
209 \fBsystemd\-confext\fR
210 concept follows the same principle as the
211 \fBsystemd-sysext\fR(8)
212 functionality but instead of working on
213 /usr
214 and
215 /opt,
216 \fBconfext\fR
217 will extend only
218 /etc\&. Files and directories contained in the confext images outside of the
219 /etc/
220 hierarchy are
221 \fInot\fR
222 merged, and hence have no effect when included in the image\&. Formats for these images are of the same as sysext images\&. The merged hierarchy will be mounted with
223 "nosuid"
224 and (if not disabled via
225 \fB\-\-noexec=false\fR)
226 "noexec"\&.
227 .PP
228 Just like sysexts, confexts are strictly read\-only by default\&. Merging confexts on mutable host file systems will result in
229 /etc/
230 becoming read\-only\&. As with sysexts, mutability can be enabled via the
231 \fB\-\-mutable=\fR
232 option\&. Refer to "Mutability" below for more information\&.
233 .PP
234 Confexts are looked for in the directories
235 /run/confexts/,
236 /var/lib/confexts/,
237 /usr/lib/confexts/
238 and
239 /usr/local/lib/confexts/\&. The first listed directory is not suitable for carrying large binary images, however is still useful for carrying symlinks to them\&. The primary place for installing configuration extensions is
240 /var/lib/confexts/\&. Any directories found in these search directories are considered directory based confext images; any files with the
241 \&.raw
242 suffix are considered disk image based confext images\&.
243 .PP
244 Again, just like sysext images, the confext images will contain a
245 /etc/extension\-release\&.d/extension\-release\&.\fINAME\fR
246 file, which must match the image name (with the usual escape hatch of the
247 \fIuser\&.extension\-release\&.strict\fR
248 \fBxattr\fR(7)), and again with content being one or more of
249 \fIID=\fR,
250 \fIVERSION_ID=\fR, and
251 \fICONFEXT_LEVEL\fR\&. Confext images will then be checked and matched against the base OS layer\&.
252 .SH "USES"
253 .PP
254 The primary use case for system images are immutable environments where debugging and development tools shall optionally be made available, but not included in the immutable base OS image itself (e\&.g\&.
255 \fBstrace\fR(1)
256 and
257 \fBgdb\fR(1)
258 shall be an optionally installable addition in order to make debugging/development easier)\&. System extension images should not be misunderstood as a generic software packaging framework, as no dependency scheme is available: system extensions should carry all files they need themselves, except for those already shipped in the underlying host system image\&. Typically, system extension images are built at the same time as the base OS image \(em within the same build system\&.
259 .PP
260 Another use case for the system extension concept is temporarily overriding OS supplied resources with newer ones, for example to install a locally compiled development version of some low\-level component over the immutable OS image without doing a full OS rebuild or modifying the nominally immutable image\&. (e\&.g\&. "install" a locally built package with
261 \fBDESTDIR=/var/lib/extensions/mytest make install && systemd\-sysext refresh\fR, making it available in
262 /usr/
263 as if it was installed in the OS image itself\&.) This case works regardless of whether the underlying host
264 /usr/
265 is managed as immutable disk image or is a traditional package manager controlled (i\&.e\&. writable) tree\&.
266 .PP
267 With
268 \fBsystemd\-confext\fR
269 one can perform runtime reconfiguration of OS services\&. Sometimes, there is a need to swap certain configuration parameter values or restart only a specific service without deployment of new code or a complete OS deployment\&. In other words, we want to be able to tie the most frequently configured options to runtime updateable flags that can be changed without a system reboot\&. This will help reduce servicing times when there is a need for changing the OS configuration\&. It also provides a reliable tool for managing configuration because all old configuration files disappear when the
270 \fBsystemd\-confext\fR
271 image is removed\&.
272 .SH "MUTABILITY"
273 .PP
274 By default, merging system extensions on mutable host file systems will render
275 /usr/
276 and
277 /opt/
278 hierarchies read\-only\&. Merging configuration extensions will have the same effect on
279 /etc/\&. Mutable mode allows writes to these locations when extensions are merged\&.
280 .PP
281 The following modes are supported:
282 .sp
283 .RS 4
284 .ie n \{\
285 \h'-04' 1.\h'+01'\c
286 .\}
287 .el \{\
288 .sp -1
289 .IP " 1." 4.2
290 .\}
291 \fBdisabled\fR: Force immutable mode even if write routing directories exist below
292 /var/lib/extensions\&.mutable/\&. This is the default\&.
293 .RE
294 .sp
295 .RS 4
296 .ie n \{\
297 \h'-04' 2.\h'+01'\c
298 .\}
299 .el \{\
300 .sp -1
301 .IP " 2." 4.2
302 .\}
303 \fBauto\fR: Automatic mode\&. Mutability is disabled by default and only enabled if a corresponding write routing directory exists below
304 /var/lib/extensions\&.mutable/\&.
305 .RE
306 .sp
307 .RS 4
308 .ie n \{\
309 \h'-04' 3.\h'+01'\c
310 .\}
311 .el \{\
312 .sp -1
313 .IP " 3." 4.2
314 .\}
315 \fBenabled\fR: Force mutable mode and automatically create write routing directories below
316 /var/lib/extensions\&.mutable/
317 when required\&.
318 .RE
319 .sp
320 .RS 4
321 .ie n \{\
322 \h'-04' 4.\h'+01'\c
323 .\}
324 .el \{\
325 .sp -1
326 .IP " 4." 4.2
327 .\}
328 \fBimport\fR: Force immutable mode like
329 \fBdisabled\fR
330 above, but merge the contents of directories below
331 /var/lib/extensions\&.mutable/
332 into the host file system\&.
333 .RE
334 .sp
335 .RS 4
336 .ie n \{\
337 \h'-04' 5.\h'+01'\c
338 .\}
339 .el \{\
340 .sp -1
341 .IP " 5." 4.2
342 .\}
343 \fBephemeral\fR: Force mutable mode like
344 \fBenabled\fR
345 above, but instead of using write routing directory below
346 /var/lib/extensions\&.mutable/,
347 \fBsystemd\-sysext\fR
348 will use empty ephemeral directories\&. This means that the modifications made in the merged hierarchies will be gone when the hierarchies are unmerged\&.
349 .RE
350 .sp
351 .RS 4
352 .ie n \{\
353 \h'-04' 6.\h'+01'\c
354 .\}
355 .el \{\
356 .sp -1
357 .IP " 6." 4.2
358 .\}
359 \fBephemeral\-import\fR: Force mutable mode like
360 \fBephemeral\fR
361 above, but instead of ignoring the contents of write routing directories under
362 /var/lib/extensions\&.mutable/, merge them into the host file system, like
363 \fBimport\fR
364 does\&.
365 .RE
366 .sp
367 See "Options" below on specifying modes using the
368 \fB\-\-mutable=\fR
369 command line option\&.
370 .PP
371 With exception of the ephemeral mode, the mutable mode routes writes to subdirectories in
372 /var/lib/extensions\&.mutable/\&.
373 .RS 4
374 Writes to /usr/ are directed to /var/lib/extensions\&.mutable/usr/
375 .RE
376 .RS 4
377 writes to /opt/ are directed to /var/lib/extensions\&.mutable/opt/, and
378 .RE
379 .RS 4
380 writes to /etc/ land in /var/lib/extensions\&.mutable/etc/\&.
381 .RE
382 .PP
383 If
384 usr/,
385 opt/, or
386 etc/
387 in
388 /var/lib/extensions\&.mutable/
389 are symlinks, then writes are directed to the symlinks\*(Aq targets\&. Consequently, to retain mutability of a host file system, create symlinks
390 .RS 4
391 /var/lib/extensions\&.mutable/etc/ → /etc/
392 .RE
393 .RS 4
394 /var/lib/extensions\&.mutable/usr/ → /usr/
395 .RE
396 .RS 4
397 /var/lib/extensions\&.mutable/opt/ → /opt/
398 .RE
399 to route writes back to the original base directory hierarchy\&.
400 .PP
401 Alternatively, a temporary file system may be mounted to
402 /var/lib/extensions\&.mutable/, or symlinks in
403 /var/lib/extensions\&.mutable/
404 may point to sub\-directories on a temporary file system (e\&.g\&. below
405 /tmp/) to only allow ephemeral changes\&. Note that this is not the same as ephemeral mode, because the temporary file system will still exist after unmerging\&.
406 .PP
407 Added in version 256\&.
408 .SH "COMMANDS"
409 .PP
410 The following commands are understood by both the sysext and confext concepts:
411 .PP
412 \fBstatus\fR
413 .RS 4
414 When invoked without any command verb, or when
415 \fBstatus\fR
416 is specified the current merge status is shown, separately (for both
417 /usr/
418 and
419 /opt/
420 of sysext and for
421 /etc/
422 of confext)\&.
423 .sp
424 Added in version 248\&.
425 .RE
426 .PP
427 \fBmerge\fR
428 .RS 4
429 Merges all currently installed system extension images into
430 /usr/
431 and
432 /opt/, by overmounting these hierarchies with an
433 "overlayfs"
434 file system combining the underlying hierarchies with those included in the extension images\&. This command will fail if the hierarchies are already merged\&. For confext, the merge happens into the
435 /etc/
436 directory instead\&.
437 .sp
438 Added in version 248\&.
439 .RE
440 .PP
441 \fBunmerge\fR
442 .RS 4
443 Unmerges all currently installed system extension images from
444 /usr/
445 and
446 /opt/
447 for sysext and
448 /etc/, for confext, by unmounting the
449 "overlayfs"
450 file systems created by
451 \fBmerge\fR
452 prior\&.
453 .sp
454 Added in version 248\&.
455 .RE
456 .PP
457 \fBrefresh\fR
458 .RS 4
459 A combination of
460 \fBunmerge\fR
461 and
462 \fBmerge\fR: if already mounted the existing
463 "overlayfs"
464 instance is unmounted temporarily, and then replaced by a new version\&. This command is useful after installing/removing system extension images, in order to update the
465 "overlayfs"
466 file system accordingly\&. If no system extensions are installed when this command is executed, the equivalent of
467 \fBunmerge\fR
468 is executed, without establishing any new
469 "overlayfs"
470 instance\&. Note that currently there\*(Aqs a brief moment where neither the old nor the new
471 "overlayfs"
472 file system is mounted\&. This implies that all resources supplied by a system extension will briefly disappear \(em even if it exists continuously during the refresh operation\&.
473 .sp
474 Added in version 248\&.
475 .RE
476 .PP
477 \fBlist\fR
478 .RS 4
479 A brief list of installed extension images is shown\&.
480 .sp
481 Added in version 248\&.
482 .RE
483 .PP
484 \fB\-h\fR, \fB\-\-help\fR
485 .RS 4
486 Print a short help text and exit\&.
487 .RE
488 .PP
489 \fB\-\-version\fR
490 .RS 4
491 Print a short version string and exit\&.
492 .RE
493 .SH "OPTIONS"
494 .PP
495 \fB\-\-root=\fR
496 .RS 4
497 Operate relative to the specified root directory, i\&.e\&. establish the
498 "overlayfs"
499 mount not on the top\-level host
500 /usr/
501 and
502 /opt/
503 hierarchies for sysext or
504 /etc/
505 for confext, but below some specified root directory\&.
506 .sp
507 Added in version 248\&.
508 .RE
509 .PP
510 \fB\-\-force\fR
511 .RS 4
512 When merging system extensions into
513 /usr/
514 and
515 /opt/
516 for sysext and
517 /etc/
518 for confext, ignore version incompatibilities, i\&.e\&. force merging regardless of whether the version information included in the images matches the host or not\&.
519 .sp
520 Added in version 248\&.
521 .RE
522 .PP
523 \fB\-\-image\-policy=\fR\fB\fIpolicy\fR\fR
524 .RS 4
525 Takes an image policy string as argument, as per
526 \fBsystemd.image-policy\fR(7)\&. The policy is enforced when operating on system extension disk images\&. If not specified, defaults to
527 "root=verity+signed+encrypted+unprotected+absent:usr=verity+signed+encrypted+unprotected+absent"
528 for system extensions, i\&.e\&. only the root and
529 /usr/
530 file systems in the image are used\&. For configuration extensions defaults to
531 "root=verity+signed+encrypted+unprotected+absent"\&. When run in the initrd and operating on a system extension image stored in the
532 /\&.extra/sysext/
533 directory a slightly stricter policy is used by default:
534 "root=signed+absent:usr=signed+absent", see above for details\&.
535 .sp
536 Added in version 254\&.
537 .RE
538 .PP
539 \fB\-\-mutable=\fR\fB\fIBOOL\fR\fR\fB|\fR\fB\fIauto\fR\fR\fB|\fR\fB\fIimport\fR\fR\fB|\fR\fB\fIephemeral\fR\fR\fB|\fR\fB\fIephemeral\-import\fR\fR\fB|\fR\fB\fIhelp\fR\fR
540 .RS 4
541 Set mutable mode\&. The special value
542 "help"
543 will list the known values\&.
544 .PP
545 \fBno\fR
546 .RS 4
547 force immutable mode even with write routing directories present\&. This is the default\&.
548 .sp
549 Added in version 256\&.
550 .RE
551 .PP
552 \fBauto\fR
553 .RS 4
554 enable mutable mode individually for
555 /usr/,
556 /opt/, and
557 /etc/
558 if write routing sub\-directories or symlinks are present in
559 /var/lib/extensions\&.mutable/; disable otherwise\&. See "Mutability" above for more information on write routing\&.
560 .sp
561 Added in version 256\&.
562 .RE
563 .PP
564 \fByes\fR
565 .RS 4
566 force mutable mode\&. Write routing directories will be created in
567 /var/lib/extensions\&.mutable/
568 if not present\&.
569 .sp
570 Added in version 256\&.
571 .RE
572 .PP
573 \fBimport\fR
574 .RS 4
575 immutable mode, but with contents of write routing directories in
576 /var/lib/extensions\&.mutable/
577 also merged into the host file system\&.
578 .sp
579 Added in version 256\&.
580 .RE
581 .PP
582 \fBephemeral\fR
583 .RS 4
584 force mutable mode, but with contents of write routing directories in
585 /var/lib/extensions\&.mutable/
586 being ignored, and modifications of the host file system being discarded after unmerge\&.
587 .sp
588 Added in version 256\&.
589 .RE
590 .PP
591 \fBephemeral\-import\fR
592 .RS 4
593 force mutable mode, with contents of write routing directories in
594 /var/lib/extensions\&.mutable/
595 being merged into the host file system, but with the modifications made to the host file system being discarded after unmerge\&.
596 .sp
597 Added in version 256\&.
598 .RE
599 .PP
600 \fBhelp\fR
601 .RS 4
602 list known values and exit immediately\&.
603 .sp
604 Added in version 259\&.
605 .RE
606 .sp
607 Added in version 256\&.
608 .RE
609 .PP
610 \fB\-\-noexec=\fR\fB\fIBOOL\fR\fR
611 .RS 4
612 When merging configuration extensions into
613 /etc/
614 the
615 "MS_NOEXEC"
616 mount flag is used by default\&. This option can be used to disable it\&.
617 .sp
618 Added in version 254\&.
619 .RE
620 .PP
621 \fB\-\-no\-reload\fR
622 .RS 4
623 When used with
624 \fBmerge\fR,
625 \fBunmerge\fR
626 or
627 \fBrefresh\fR, do not reload daemon after executing the changes even if an extension that is applied requires a reload via the
628 \fIEXTENSION_RELOAD_MANAGER=\fR
629 set to 1\&.
630 .sp
631 Added in version 255\&.
632 .RE
633 .PP
634 \fB\-\-no\-pager\fR
635 .RS 4
636 Do not pipe output into a pager\&.
637 .RE
638 .PP
639 \fB\-\-no\-legend\fR
640 .RS 4
641 Do not print the legend, i\&.e\&. column headers and the footer with hints\&.
642 .RE
643 .PP
644 \fB\-\-json=\fR\fB\fIMODE\fR\fR
645 .RS 4
646 Shows output formatted as JSON\&. Expects one of
647 "short"
648 (for the shortest possible output without any redundant whitespace or line breaks),
649 "pretty"
650 (for a pretty version of the same, with indentation and line breaks) or
651 "off"
652 (to turn off JSON output, the default)\&.
653 .RE
654 .SH "EXIT STATUS"
655 .PP
656 On success, 0 is returned\&.
657 .SH "SEE ALSO"
658 .PP
659 \fBsystemd\fR(1), \fBsysext.conf\fR(5), \fBsystemd-nspawn\fR(1), \fBsystemd-stub\fR(7), \fBimportctl\fR(1)
660 .SH "NOTES"
661 .IP " 1." 4
662 UAPI.2 Discoverable Partitions Specification
663 .RS 4
664 \%https://uapi-group.org/specifications/specs/discoverable_partitions_specification
665 .RE
666 .IP " 2." 4
667 Portable Services
668 .RS 4
669 \%https://systemd.io/PORTABLE_SERVICES
670 .RE