Debian Codegraph @

upstream/fedora-44/man1/bootctl.1

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