Debian Codegraph @

upstream/debian-trixie/man1/bootctl.1

raw
1 '\" t
2 .TH "BOOTCTL" "1" "" "systemd 257.13" "bootctl"
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 bootctl \- Control EFI firmware boot settings and manage boot loader
24 .SH "SYNOPSIS"
25 .HP \w'\fBbootctl\fR\ 'u
26 \fBbootctl\fR [OPTIONS...] {COMMAND}
27 .SH "DESCRIPTION"
28 .PP
29 \fBbootctl\fR
30 can check the EFI firmware and boot loader status, list and manage available boot loaders and boot loader entries, and install, update, or remove the
31 \fBsystemd-boot\fR(7)
32 boot loader on the current system\&.
33 .SH "GENERIC EFI FIRMWARE/BOOT LOADER COMMANDS"
34 .PP
35 These commands are available on any EFI system, regardless of the boot loader used\&.
36 .PP
37 \fBstatus\fR
38 .RS 4
39 Shows brief information about the system firmware, the boot loader that was used to boot the system, the boot loaders currently available in the ESP, the boot loaders listed in the firmware\*(Aqs list of boot loaders and the current default boot loader entry\&. If no command is specified, this is the implied default\&.
40 .sp
41 See the example below for details of the output\&.
42 .sp
43 Added in version 239\&.
44 .RE
45 .PP
46 \fBreboot\-to\-firmware\fR [\fIBOOL\fR]
47 .RS 4
48 Query or set the "Reboot\-Into\-Firmware\-Setup" flag of the EFI firmware\&. Takes a boolean argument which controls whether to show the firmware setup on next system reboot\&. If the argument is omitted shows the current status of the flag, or whether the flag is supported\&. This controls the same flag as
49 \fBsystemctl reboot \-\-firmware\-setup\fR, but is more low\-level and allows setting the flag independently from actually requesting a reboot\&.
50 .sp
51 Hint: use
52 \fBsystemctl reboot \-\-firmware\-setup\fR
53 to reboot into firmware setup once\&. See
54 \fBsystemctl\fR(1)
55 for details\&.
56 .sp
57 Added in version 251\&.
58 .RE
59 .SH "BOOT LOADER SPECIFICATION COMMANDS"
60 .PP
61 These commands are available for all boot loaders that implement the
62 \m[blue]\fBBoot Loader Specification\fR\m[]\&\s-2\u[1]\d\s+2, such as
63 \fBsystemd\-boot\fR\&.
64 .PP
65 \fBlist\fR
66 .RS 4
67 Shows all available boot loader entries implementing the
68 \m[blue]\fBBoot Loader Specification\fR\m[]\&\s-2\u[1]\d\s+2, as well as any other entries discovered or automatically generated by a boot loader implementing the
69 \m[blue]\fBBoot Loader Interface\fR\m[]\&\s-2\u[2]\d\s+2\&. JSON output may be requested with
70 \fB\-\-json=\fR\&.
71 .sp
72 See the example below for details of the output\&.
73 .sp
74 Added in version 239\&.
75 .RE
76 .PP
77 \fBunlink\fR \fIID\fR
78 .RS 4
79 Removes a boot loader entry including the files it refers to\&. Takes a single boot loader entry ID string or a glob pattern as argument\&. Referenced files such as kernel or initrd are only removed if no other entry refers to them\&.
80 .sp
81 Added in version 253\&.
82 .RE
83 .PP
84 \fBcleanup\fR
85 .RS 4
86 Removes files from the ESP and XBOOTLDR partitions that belong to the entry token but are not referenced in any boot loader entries\&.
87 .sp
88 Added in version 253\&.
89 .RE
90 .SH "BOOT LOADER INTERFACE COMMANDS"
91 .PP
92 These commands are available for all boot loaders that implement the
93 \m[blue]\fBBoot Loader Specification\fR\m[]\&\s-2\u[1]\d\s+2
94 and the
95 \m[blue]\fBBoot Loader Interface\fR\m[]\&\s-2\u[2]\d\s+2, such as
96 \fBsystemd\-boot\fR\&.
97 .PP
98 \fBset\-default\fR \fIID\fR, \fBset\-oneshot\fR \fIID\fR
99 .RS 4
100 Sets the default boot loader entry\&. Takes a single boot loader entry ID string or a glob pattern as argument\&. The
101 \fBset\-oneshot\fR
102 command will set the default entry only for the next boot, the
103 \fBset\-default\fR
104 will set it persistently for all future boots\&.
105 .sp
106 \fBbootctl list\fR
107 can be used to list available boot loader entries and their IDs\&.
108 .sp
109 In addition, the boot loader entry ID may be specified as one of:
110 \fB@default\fR,
111 \fB@oneshot\fR
112 or
113 \fB@current\fR, which correspond to the current default boot loader entry for all future boots, the current default boot loader entry for the next boot, and the currently booted boot loader entry\&. These special IDs are resolved to the current values of the EFI variables
114 \fILoaderEntryDefault\fR,
115 \fILoaderEntryOneShot\fR
116 and
117 \fILoaderEntrySelected\fR, see
118 \m[blue]\fBBoot Loader Specification\fR\m[]\&\s-2\u[1]\d\s+2
119 for details\&. These special IDs are primarily useful as a quick way to persistently make the currently booted boot loader entry the default choice, or to upgrade the default boot loader entry for the next boot to the default boot loader entry for all future boots, but may be used for other operations too\&.
120 .sp
121 If set to
122 \fB@saved\fR
123 the chosen entry will be saved as an EFI variable on every boot and automatically selected the next time the boot loader starts\&.
124 .sp
125 When an empty string ("") is specified as the ID, then the corresponding EFI variable will be unset\&.
126 .sp
127 Hint: use
128 \fBsystemctl reboot \-\-boot\-loader\-entry=\fR\fB\fIID\fR\fR
129 to reboot into a specific boot entry and
130 \fBsystemctl reboot \-\-boot\-loader\-menu=\fR\fB\fItimeout\fR\fR
131 to reboot into the boot loader menu once\&. See
132 \fBsystemctl\fR(1)
133 for details\&.
134 .sp
135 Added in version 240\&.
136 .RE
137 .PP
138 \fBset\-timeout\fR \fITIMEOUT\fR, \fBset\-timeout\-oneshot\fR \fITIMEOUT\fR
139 .RS 4
140 Sets the boot loader menu timeout in seconds\&. The
141 \fBset\-timeout\-oneshot\fR
142 command will set the timeout only for the next boot\&. See
143 \fBsystemd.time\fR(7)
144 for details about the syntax of time spans\&.
145 .sp
146 If this is set to
147 \fBmenu\-disabled\fR
148 or
149 \fBmenu\-hidden\fR
150 or
151 \fB0\fR, no menu is shown and the default entry will be booted immediately, while setting this to
152 \fBmenu\-force\fR
153 disables the timeout while always showing the menu\&. When an empty string ("") is specified the bootloader will revert to its default menu timeout\&.
154 .sp
155 Added in version 250\&.
156 .RE
157 .SH "SYSTEMD\-BOOT COMMANDS"
158 .PP
159 These commands manage the
160 \fBsystemd\-boot\fR
161 EFI boot loader, and do not work in conjunction with other boot loaders\&.
162 .PP
163 \fBinstall\fR
164 .RS 4
165 Installs
166 \fBsystemd\-boot\fR
167 into the EFI system partition\&. A copy of
168 \fBsystemd\-boot\fR
169 will be stored as the EFI default/fallback loader at
170 \fIESP\fR/EFI/BOOT/BOOT*\&.EFI\&. The boot loader is then added to the top of the firmware\*(Aqs boot loader list\&.
171 .sp
172 Added in version 239\&.
173 .RE
174 .PP
175 \fBupdate\fR
176 .RS 4
177 Updates all installed versions of
178 \fBsystemd-boot\fR(7), if the available version is newer than the version installed in the EFI system partition\&. This also includes the EFI default/fallback loader at
179 \fIESP\fR/EFI/BOOT/BOOT*\&.EFI\&. The boot loader is then added to end of the firmware\*(Aqs boot loader list if missing\&.
180 .sp
181 Added in version 239\&.
182 .RE
183 .PP
184 \fBremove\fR
185 .RS 4
186 Removes all installed versions of
187 \fBsystemd\-boot\fR
188 from the EFI system partition and the firmware\*(Aqs boot loader list\&.
189 .sp
190 Added in version 239\&.
191 .RE
192 .PP
193 \fBis\-installed\fR
194 .RS 4
195 Checks whether
196 \fBsystemd\-boot\fR
197 is installed in the ESP\&. Note that a single ESP might host multiple boot loaders; this hence checks whether
198 \fBsystemd\-boot\fR
199 is one (of possibly many) installed boot loaders \(em and neither whether it is the default nor whether it is registered in any EFI variables\&.
200 .sp
201 Added in version 243\&.
202 .RE
203 .PP
204 \fBrandom\-seed\fR
205 .RS 4
206 Generates a random seed and stores it in the EFI System Partition (ESP), for use by the
207 \fBsystemd\-boot\fR
208 boot loader\&. If a random seed already exists in the ESP it is refreshed\&. Also generates a random \*(Aqsystem token\*(Aq and stores it persistently as an EFI variable, if one has not been set before\&. If the boot loader finds the random seed in the ESP and the system token in the EFI variable it will derive a random seed to pass to the OS and a new seed to store in the ESP from the combination of both\&. The random seed passed to the OS is credited to the kernel\*(Aqs entropy pool by the system manager during early boot, and permits userspace to boot up with an entropy pool fully initialized very early on\&. Also see
209 \fBsystemd-boot-random-seed.service\fR(8)\&.
210 .sp
211 See
212 \m[blue]\fBRandom Seeds\fR\m[]\&\s-2\u[3]\d\s+2
213 for further information\&.
214 .sp
215 Added in version 243\&.
216 .RE
217 .SH "KERNEL IMAGE COMMANDS"
218 .PP
219 \fBkernel\-identify\fR \fIKERNEL\-IMAGE\fR
220 .RS 4
221 Takes a kernel image as argument\&. Checks what kind of kernel the image is\&. Returns one of
222 "uki",
223 "addon",
224 "pe", and
225 "unknown"\&.
226 .sp
227 Added in version 253\&.
228 .RE
229 .PP
230 \fBkernel\-inspect\fR \fIKERNEL\-IMAGE\fR
231 .RS 4
232 Takes a kernel image as argument\&. Prints details about the image\&.
233 .sp
234 Added in version 253\&.
235 .RE
236 .SH "OPTIONS"
237 .PP
238 The following options are understood:
239 .PP
240 \fB\-\-esp\-path=\fR
241 .RS 4
242 Path to the EFI System Partition (ESP)\&. If not specified,
243 /efi/,
244 /boot/, and
245 /boot/efi/
246 are checked in turn\&. It is recommended to mount the ESP to
247 /efi/, if possible\&.
248 .RE
249 .PP
250 \fB\-\-boot\-path=\fR
251 .RS 4
252 Path to the Extended Boot Loader partition, as defined in the
253 \m[blue]\fBBoot Loader Specification\fR\m[]\&\s-2\u[1]\d\s+2\&. If not specified,
254 /boot/
255 is checked\&. It is recommended to mount the Extended Boot Loader partition to
256 /boot/, if possible\&.
257 .RE
258 .PP
259 \fB\-\-root=\fR\fB\fIroot\fR\fR
260 .RS 4
261 Takes a directory path as an argument\&. All paths will be prefixed with the given alternate
262 \fIroot\fR
263 path, including config search paths\&.
264 .sp
265 Added in version 252\&.
266 .RE
267 .PP
268 \fB\-\-image=\fR\fB\fIimage\fR\fR
269 .RS 4
270 Takes a path to a disk image file or block device node\&. If specified, all operations are applied to file system in the indicated disk image\&. This option is similar to
271 \fB\-\-root=\fR, but operates on file systems stored in disk images or block devices\&. The disk image should either contain just a file system or a set of file systems within a GPT partition table, following the
272 \m[blue]\fBDiscoverable Partitions Specification\fR\m[]\&\s-2\u[4]\d\s+2\&. For further information on supported disk images, see
273 \fBsystemd-nspawn\fR(1)\*(Aqs switch of the same name\&.
274 .sp
275 Added in version 252\&.
276 .RE
277 .PP
278 \fB\-\-image\-policy=\fR\fB\fIpolicy\fR\fR
279 .RS 4
280 Takes an image policy string as argument, as per
281 \fBsystemd.image-policy\fR(7)\&. The policy is enforced when operating on the disk image specified via
282 \fB\-\-image=\fR, see above\&. If not specified, defaults to the
283 "*"
284 policy, i\&.e\&. all recognized file systems in the image are used\&.
285 .RE
286 .PP
287 \fB\-\-install\-source=\fR
288 .RS 4
289 When installing binaries with
290 \fB\-\-root=\fR
291 or
292 \fB\-\-image=\fR, selects where to source them from\&. Takes one of
293 "auto"
294 (the default),
295 "image"
296 or
297 "host"\&. With
298 "auto"
299 binaries will be picked from the specified directory or image, and if not found they will be picked from the host\&. With
300 "image"
301 or
302 "host"
303 no fallback search will be performed if the binaries are not found in the selected source\&.
304 .sp
305 Added in version 252\&.
306 .RE
307 .PP
308 \fB\-p\fR, \fB\-\-print\-esp\-path\fR
309 .RS 4
310 This option modifies the behaviour of
311 \fBstatus\fR\&. Only prints the path to the EFI System Partition (ESP) to standard output and exits\&.
312 .sp
313 Added in version 236\&.
314 .RE
315 .PP
316 \fB\-x\fR, \fB\-\-print\-boot\-path\fR
317 .RS 4
318 This option modifies the behaviour of
319 \fBstatus\fR\&. Only prints the path to the Extended Boot Loader partition if it exists, and the path to the ESP otherwise to standard output and exit\&. This command is useful to determine where to place boot loader entries, as they are preferably placed in the Extended Boot Loader partition if it exists and in the ESP otherwise\&.
320 .sp
321 Boot Loader Specification Type #1 entries should generally be placed in the directory
322 "$(bootctl \-x)/loader/entries/"\&. Existence of that directory may also be used as indication that boot loader entry support is available on the system\&. Similarly, Boot Loader Specification Type #2 entries should be placed in the directory
323 "$(bootctl \-x)/EFI/Linux/"\&.
324 .sp
325 Note that this option (similarly to the
326 \fB\-\-print\-esp\-path\fR
327 option mentioned above), is available independently from the boot loader used, i\&.e\&. also without
328 \fBsystemd\-boot\fR
329 being installed\&.
330 .sp
331 Added in version 242\&.
332 .RE
333 .PP
334 \fB\-\-print\-loader\-path\fR
335 .RS 4
336 This option modifies the behaviour of
337 \fBstatus\fR: it shows the absolute path to the boot loader EFI binary used for the current boot if this information is available\&. Note that no attempt is made to verify whether the binary still exists\&.
338 .sp
339 Added in version 257\&.
340 .RE
341 .PP
342 \fB\-\-print\-stub\-path\fR
343 .RS 4
344 This option modifies the behaviour of
345 \fBstatus\fR: it shows the absolute path to the UKI/stub EFI binary used for the current boot if this information is available\&. Note that no attempt is made to verify whether the binary still exists\&.
346 .sp
347 Added in version 257\&.
348 .RE
349 .PP
350 \fB\-R\fR, \fB\-\-print\-root\-device\fR
351 .RS 4
352 Print the path to the block device node backing the root file system of the local OS\&. This prints a path such as
353 /dev/nvme0n1p5\&. If the root file system is backed by dm\-crypt/LUKS or dm\-verity the underlying block device is returned\&. If the root file system is backed by multiple block devices (as supported by btrfs) the operation will fail\&. If the switch is specified twice (i\&.e\&.
354 \fB\-RR\fR) and the discovered block device is a partition device the "whole" block device it belongs to is determined and printed (e\&.g\&.
355 /dev/nvme0n1)\&. If the root file system is
356 "tmpfs"
357 (or a similar in\-memory file system), the block device backing
358 /usr/
359 is returned if applicable\&. If the root file system is a network file system (e\&.g\&. NFS, CIFS) the operation will fail\&.
360 .sp
361 Added in version 254\&.
362 .RE
363 .PP
364 \fB\-\-no\-variables\fR
365 .RS 4
366 Do not touch the firmware\*(Aqs boot loader list stored in EFI variables\&.
367 .sp
368 Added in version 220\&.
369 .RE
370 .PP
371 \fB\-\-random\-seed=yes|no\fR
372 .RS 4
373 By default, the
374 \fBinstall\fR
375 command initializes a random seed file in the ESP\&. When creating an image it may be desirable to disable that in order to avoid having the same seed in all instances\&.
376 .sp
377 Added in version 257\&.
378 .RE
379 .PP
380 \fB\-\-graceful\fR
381 .RS 4
382 Ignore failure when the EFI System Partition cannot be found, when EFI variables cannot be written, or a different or newer boot loader is already installed\&. Currently only applies to
383 \fBis\-installed\fR,
384 \fBupdate\fR, and
385 \fBrandom\-seed\fR
386 verbs\&.
387 .sp
388 Added in version 244\&.
389 .RE
390 .PP
391 \fB\-q\fR, \fB\-\-quiet\fR
392 .RS 4
393 Suppress printing of the results of various commands and also the hints about ESP being unavailable\&.
394 .sp
395 Added in version 251\&.
396 .RE
397 .PP
398 \fB\-\-make\-entry\-directory=yes|no\fR
399 .RS 4
400 Controls creation and deletion of the
401 \m[blue]\fBBoot Loader Specification\fR\m[]\&\s-2\u[1]\d\s+2
402 Type #1 entry directory on the file system containing resources such as kernel and initrd images during
403 \fBinstall\fR
404 and
405 \fBremove\fR, respectively\&. The directory is named after the entry token, as specified with
406 \fB\-\-entry\-token=\fR
407 parameter described below, and is placed immediately below the
408 \fI$BOOT\fR
409 root directory (i\&.e\&. beneath the file system returned by the
410 \fB\-\-print\-boot\-path\fR
411 option, see above)\&. Defaults to
412 "no"\&.
413 .sp
414 Added in version 251\&.
415 .RE
416 .PP
417 \fB\-\-entry\-token=\fR
418 .RS 4
419 Controls how to name and identify boot loader entries for this OS installation\&. Accepted during
420 \fBinstall\fR, and takes one of
421 "auto",
422 "machine\-id",
423 "os\-id",
424 "os\-image\-id"
425 or an arbitrary string prefixed by
426 "literal:"
427 as argument\&.
428 .sp
429 If set to
430 \fBmachine\-id\fR
431 the entries are named after the machine ID of the running system (e\&.g\&.
432 "b0e793a9baf14b5fa13ecbe84ff637ac")\&. See
433 \fBmachine-id\fR(5)
434 for details about the machine ID concept and file\&.
435 .sp
436 If set to
437 \fBos\-id\fR
438 the entries are named after the OS ID of the running system, i\&.e\&. the
439 \fIID=\fR
440 field of
441 \fBos-release\fR(5)
442 (e\&.g\&.
443 "fedora")\&. Similarly, if set to
444 \fBos\-image\-id\fR
445 the entries are named after the OS image ID of the running system, i\&.e\&. the
446 \fIIMAGE_ID=\fR
447 field of
448 os\-release
449 (e\&.g\&.
450 "vendorx\-cashier\-system")\&.
451 .sp
452 If set to
453 \fBauto\fR
454 (the default), the
455 /etc/kernel/entry\-token
456 file will be read if it exists, and the stored value used\&. Otherwise, if the local machine ID is initialized it is used\&. Otherwise,
457 \fIIMAGE_ID=\fR
458 from
459 os\-release
460 will be used, if set\&. Otherwise,
461 \fIID=\fR
462 from
463 os\-release
464 will be used, if set\&.
465 .sp
466 Unless set to
467 "machine\-id", or when
468 \fB\-\-make\-entry\-directory=yes\fR
469 is used the selected token string is written to a file
470 /etc/kernel/entry\-token, to ensure it will be used for future entries\&. This file is also read by
471 \fBkernel-install\fR(8), in order to identify under which name to generate boot loader entries for newly installed kernels, or to determine the entry names for removing old ones\&.
472 .sp
473 Using the machine ID for naming the entries is generally preferable, however there are cases where using the other identifiers is a good option\&. Specifically: if the identification data that the machine ID entails shall not be stored on the (unencrypted)
474 \fI$BOOT\fR
475 partition, or if the ID shall be generated on first boot and is not known when the entries are prepared\&. Note that using the machine ID has the benefit that multiple parallel installations of the same OS can coexist on the same medium, and they can update their boot loader entries independently\&. When using another identifier (such as the OS ID or the OS image ID), parallel installations of the same OS would try to use the same entry name\&. To support parallel installations, the installer must use a different entry token when adding a second installation\&.
476 .sp
477 Added in version 251\&.
478 .RE
479 .PP
480 \fB\-\-all\-architectures\fR
481 .RS 4
482 Install binaries for all supported EFI architectures (this implies
483 \fB\-\-no\-variables\fR)\&.
484 .sp
485 Added in version 252\&.
486 .RE
487 .PP
488 \fB\-\-efi\-boot\-option\-description=\fR
489 .RS 4
490 Description of the entry added to the firmware\*(Aqs boot option list\&. Defaults to
491 "Linux Boot Manager"\&.
492 .sp
493 Using the default entry name
494 "Linux Boot Manager"
495 is generally preferable as only one bootloader installed to a single ESP partition should be used to boot any number of OS installations found on the various disks installed in the system\&. Specifically distributions should not use this flag to install a branded entry in the boot option list\&. However, in situations with multiple disks, each with their own ESP partition, it can be beneficial to make it easier to identify the bootloader being used in the firmware\*(Aqs boot option menu\&.
496 .sp
497 Added in version 252\&.
498 .RE
499 .PP
500 \fB\-\-dry\-run\fR
501 .RS 4
502 Dry run for
503 \fBunlink\fR
504 and
505 \fBcleanup\fR\&.
506 .sp
507 In dry run mode, the unlink and cleanup operations only print the files that would get deleted without actually deleting them\&.
508 .sp
509 Added in version 253\&.
510 .RE
511 .PP
512 \fB\-\-secure\-boot\-auto\-enroll=yes|no\fR, \fB\-\-private\-key=\fR\fB\fIPATH/URI\fR\fR, \fB\-\-private\-key\-source=\fR\fB\fITYPE\fR\fR\fB[:\fR\fB\fINAME\fR\fR\fB]\fR, \fB\-\-certificate=\fR\fB\fIPATH\fR\fR, \fB\-\-certificate\-source=\fR\fB\fITYPE\fR\fR\fB[:\fR\fB\fINAME\fR\fR\fB]\fR
513 .RS 4
514 Configure the ESP for secure boot auto\-enrollment when invoking the
515 \fBinstall\fR
516 command\&. Takes a boolean argument\&. Disabled by default\&. Enabling this option will make
517 \fBbootctl\fR
518 populate the ESP with signed
519 "PK",
520 "KEK"
521 and
522 "db"
523 signature databases, each containing the given certificate in
524 "DER"
525 format as their only entry\&. These secure boot signature databases will be picked up and enrolled by
526 \fBsystemd\-boot\fR
527 if secure boot is in setup mode and secure boot auto\-enrollment is enabled\&.
528 .sp
529 When specifying this option, a certificate and private key have to be provided as well using the
530 \fB\-\-certificate=\fR
531 and
532 \fB\-\-private\-key=\fR
533 options\&. The
534 \fB\-\-certificate=\fR
535 option takes a path to a PEM encoded X\&.509 certificate or a URI that\*(Aqs passed to the OpenSSL provider configured with
536 \fB\-\-certificate\-source\fR
537 which takes one of
538 "file"
539 or
540 "provider", with the latter being followed by a specific provider identifier, separated with a colon, e\&.g\&.
541 "provider:pkcs11"\&. The
542 \fB\-\-private\-key=\fR
543 option can take a path or a URI that will be passed to the OpenSSL engine or provider, as specified by
544 \fB\-\-private\-key\-source=\fR
545 as a
546 "type:name"
547 tuple, such as
548 "engine:pkcs11"\&. The specified OpenSSL signing engine or provider will be used to sign the EFI signature lists\&.
549 .sp
550 Added in version 257\&.
551 .RE
552 .PP
553 \fB\-\-no\-pager\fR
554 .RS 4
555 Do not pipe output into a pager\&.
556 .RE
557 .PP
558 \fB\-\-json=\fR\fB\fIMODE\fR\fR
559 .RS 4
560 Shows output formatted as JSON\&. Expects one of
561 "short"
562 (for the shortest possible output without any redundant whitespace or line breaks),
563 "pretty"
564 (for a pretty version of the same, with indentation and line breaks) or
565 "off"
566 (to turn off JSON output, the default)\&.
567 .RE
568 .PP
569 \fB\-h\fR, \fB\-\-help\fR
570 .RS 4
571 Print a short help text and exit\&.
572 .RE
573 .PP
574 \fB\-\-version\fR
575 .RS 4
576 Print a short version string and exit\&.
577 .RE
578 .SH "SIGNED \&.EFI FILES"
579 .PP
580 \fBbootctl\fR
581 \fBinstall\fR
582 and
583 \fBupdate\fR
584 will look for a
585 \fBsystemd\-boot\fR
586 file ending with the
587 "\&.efi\&.signed"
588 suffix first, and copy that instead of the normal
589 "\&.efi"
590 file\&. This allows distributions or end\-users to provide signed images for UEFI SecureBoot\&.
591 .SH "EXIT STATUS"
592 .PP
593 On success, 0 is returned, a non\-zero failure code otherwise\&.
594 \fBbootctl \-\-print\-root\-device\fR
595 returns exit status 80 in case the root file system is not backed by single block device, and other non\-zero exit statuses on other errors\&.
596 .SH "ENVIRONMENT"
597 .PP
598 If
599 \fI$SYSTEMD_RELAX_ESP_CHECKS=1\fR
600 is set the validation checks for the ESP are relaxed, and the path specified with
601 \fB\-\-esp\-path=\fR
602 may refer to any kind of file system on any kind of partition\&.
603 .PP
604 Similarly,
605 \fI$SYSTEMD_RELAX_XBOOTLDR_CHECKS=1\fR
606 turns off some validation checks for the Extended Boot Loader partition\&.
607 .SH "EXAMPLES"
608 .PP
609 \fBExample\ \&1.\ \&Output from status and list\fR
610 .sp
611 .if n \{\
612 .RS 4
613 .\}
614 .nf
615 $ \fBbootctl status\fR
616 System:
617 Firmware: UEFI 2\&.40 (\fIfirmware\-version\fR) ← firmware vendor and version
618 Secure Boot: disabled (setup) ← Secure Boot status
619 TPM2 Support: yes
620 Boot into FW: supported ← does the firmware support booting into itself
621
622 Current Boot Loader: ← details about sd\-boot or another boot loader
623 Product: systemd\-boot \fIversion\fR implementing the \m[blue]\fBBoot Loader Interface\fR\m[]\&\s-2\u[2]\d\s+2
624 Features: ✓ Boot counting
625 ✓ Menu timeout control
626 ✓ One\-shot menu timeout control
627 ✓ Default entry control
628 ✓ One\-shot entry control
629 ✓ Support for XBOOTLDR partition
630 ✓ Support for passing random seed to OS
631 ✓ Load drop\-in drivers
632 ✓ Boot loader sets ESP information
633 ✓ Menu can be disabled
634 ESP: /dev/disk/by\-partuuid/01234567\-89ab\-cdef\-dead\-beef00000000
635 File: └─/EFI/systemd/systemd\-bootx64\&.efi
636
637 Random Seed: ← random seed used for entropy in early boot
638 Passed to OS: yes
639 System Token: set
640 Exists: yes
641
642 Available Boot Loaders on ESP:
643 ESP: /boot/efi (/dev/disk/by\-partuuid/01234567\-89ab\-cdef\-dead\-beef00000000)
644 File: └─/EFI/systemd/systemd\-bootx64\&.efi (systemd\-boot 251
645 File: └─/EFI/BOOT/BOOTX64\&.EFI (systemd\-boot 251
646
647 Boot Loaders Listed in EFI Variables:
648 Title: Linux Boot Manager
649 ID: 0x0001
650 Status: active, boot\-order
651 Partition: /dev/disk/by\-partuuid/\&...
652 File: └─/EFI/systemd/systemd\-bootx64\&.efi
653
654 Title: Fedora
655 ID: 0x0000
656 Status: active, boot\-order
657 Partition: /dev/disk/by\-partuuid/\&...
658 File: └─/EFI/fedora/shimx64\&.efi
659
660 Title: Linux\-Firmware\-Updater
661 ID: 0x0002
662 Status: active, boot\-order
663 Partition: /dev/disk/by\-partuuid/\&...
664 File: └─/EFI/fedora/fwupdx64\&.efi
665
666 Boot Loader Entries:
667 $BOOT: /boot/efi (/dev/disk/by\-partuuid/01234567\-89ab\-cdef\-dead\-beef00000000)
668
669 Default Boot Loader Entry:
670 type: Boot Loader Specification Type #1 (\&.conf)
671 title: Fedora Linux 36 (Workstation Edition)
672 id: \&...
673 source: /boot/efi/loader/entries/\fIentry\-token\fR\-\fIkernel\-version\fR\&.conf
674 version: \fIkernel\-version\fR
675 machine\-id: \&...
676 linux: /\fIentry\-token\fR/\fIkernel\-version\fR/linux
677 initrd: /\fIentry\-token\fR/\fIkernel\-version\fR/initrd
678 options: root=\&...
679 .fi
680 .if n \{\
681 .RE
682 .\}
683 .sp
684 .if n \{\
685 .RS 4
686 .\}
687 .nf
688 $ \fBbootctl list\fR
689 Boot Loader Entries:
690 type: Boot Loader Specification Type #1 (\&.conf)
691 title: Fedora Linux 36 (Workstation Edition) (default) (selected)
692 id: \&...
693 source: /boot/efi/loader/entries/\fIentry\-token\fR\-\fIkernel\-version\fR\&.conf
694 version: \fIkernel\-version\fR
695 machine\-id: \&...
696 linux: /\fIentry\-token\fR/\fIkernel\-version\fR/linux
697 initrd: /\fIentry\-token\fR/\fIkernel\-version\fR/initrd
698 options: root=\&...
699
700 type: Boot Loader Specification Type #2 (\&.efi)
701 title: Fedora Linux 35 (Workstation Edition)
702 id: \&...
703 source: /boot/efi/EFI/Linux/fedora\-\fIkernel\-version\fR\&.efi
704 version: \fIkernel\-version\fR
705 machine\-id: \&...
706 linux: /EFI/Linux/fedora\-\fIkernel\-version\fR\&.efi
707 options: root=\&...
708
709 type: Automatic
710 title: Reboot Into Firmware Interface
711 id: auto\-reboot\-to\-firmware\-setup
712 source: /sys/firmware/efi/efivars/LoaderEntries\-4a67b082\-0a4c\-41cf\-b6c7\-440b29bb8c4f
713 .fi
714 .if n \{\
715 .RE
716 .\}
717 .PP
718 In the listing,
719 "(default)"
720 specifies the entry that will be used by default, and
721 "(selected)"
722 specifies the entry that was selected the last time (i\&.e\&. is currently running)\&.
723 .SH "SEE ALSO"
724 .PP
725 \fBsystemd-boot\fR(7), \m[blue]\fBBoot Loader Specification\fR\m[]\&\s-2\u[1]\d\s+2, \m[blue]\fBBoot Loader Interface\fR\m[]\&\s-2\u[2]\d\s+2, \fBsystemd-boot-random-seed.service\fR(8)
726 .SH "NOTES"
727 .IP " 1." 4
728 Boot Loader Specification
729 .RS 4
730 \%https://uapi-group.org/specifications/specs/boot_loader_specification
731 .RE
732 .IP " 2." 4
733 Boot Loader Interface
734 .RS 4
735 \%https://systemd.io/BOOT_LOADER_INTERFACE
736 .RE
737 .IP " 3." 4
738 Random Seeds
739 .RS 4
740 \%https://systemd.io/RANDOM_SEEDS
741 .RE
742 .IP " 4." 4
743 Discoverable Partitions Specification
744 .RS 4
745 \%https://uapi-group.org/specifications/specs/discoverable_partitions_specification
746 .RE