diff --git a/man/bootctl.xml b/man/bootctl.xml
index 7662593a70..8dc3f35d26 100644
--- a/man/bootctl.xml
+++ b/man/bootctl.xml
@@ -68,32 +68,37 @@
Description
- bootctl checks, updates,
- installs or removes the boot loader from the current
- system.
+ bootctl can check the EFI boot loader status, list
+ available entries, and install, update, or remove the
+ sd-boot7
+ boot loader on the current system.
- bootctl status checks and prints the
- currently installed versions of the boot loader binaries and
- all current EFI boot variables.
+ bootctl status shows the currently installed versions of
+ the boot loader binaries and all current EFI boot variables.bootctl list displays all configured boot loader entries.
- bootctl update updates all installed versions of systemd-boot, if the current version is
- newer than the version installed in the EFI system partition. This also includes the EFI default/fallback loader at
- /EFI/BOOT/BOOT*.EFI. A systemd-boot entry in the EFI boot variables is created if there is no
- current entry. The created entry will be added to the end of the boot order list.
+ bootctl update updates all installed versions of
+ sd-boot7,
+ if the current version is newer than the version installed in the EFI system
+ partition. This also includes the EFI default/fallback loader at
+ ESP/EFI/BOOT/BOOT*.EFI. A
+ systemd-boot entry in the EFI boot variables is created if there is no current
+ entry. The created entry will be added to the end of the boot order list.
- bootctl install installs systemd-boot into the EFI system partition. A copy of
- systemd-boot will be stored as the EFI default/fallback loader at /EFI/BOOT/BOOT*.EFI. A
- systemd-boot entry in the EFI boot variables is created and added to the top of the boot order list.
+ bootctl install installs systemd-boot into the EFI
+ system partition. A copy of systemd-boot will be stored as the EFI
+ default/fallback loader at
+ ESP/EFI/BOOT/BOOT*.EFI. A
+ systemd-boot entry in the EFI boot variables is created and added to the top of
+ the boot order list.
- bootctl remove removes all installed
- versions of systemd-boot from the EFI system partition, and removes
- systemd-boot from the EFI boot variables.
+ bootctl remove removes all installed versions of
+ systemd-boot from the EFI system partition, and removes systemd-boot from the EFI
+ boot variables.
- If no command is passed, status is
- implied.
+ If no command is passed, status is implied.
@@ -134,8 +139,9 @@
See Also
- Boot loader specification
- systemd boot loader interface
+ sd-boot7,
+ Boot Loader Specification,
+ Boot Loader Interface
diff --git a/man/loader.conf.xml b/man/loader.conf.xml
new file mode 100644
index 0000000000..e3b895ab99
--- /dev/null
+++ b/man/loader.conf.xml
@@ -0,0 +1,194 @@
+
+
+
+
+
+
+
+ loader.conf
+ systemd
+
+
+
+ I wrote this page
+ Zbigniew
+ Jędrzejewski-Szmek
+ zbyszek@in.waw.pl
+
+
+
+
+
+ loader.conf
+ 5
+
+
+
+ loader.conf
+ Configuration file for sd-boot
+
+
+
+ ESP/loader/loader.conf,
+ ESP/loader/loader.conf.d/*.conf
+
+
+
+
+ Description
+
+
+ sd-boot7
+ will read /loader/loader.conf and any files with the
+ .conf extension under
+ /loader/loader.conf.d/ on the EFI system partition (ESP).
+
+
+ Each configuration file must consist of an option name, followed by
+ whitespace, and the option value. # may be used to start
+ a comment line. Empty and comment lines are ignored.
+
+ Boolean arguments may be written as
+ yes/y/true/1 or
+ no/n/false/0.
+
+
+
+
+ Options
+
+ The following configuration options are understood:
+
+
+
+ default
+
+ A glob pattern to select the default entry. The default entry
+ may be changed in the boot menu itself, in which case the name of the
+ selected entry will be stored as an EFI variable, overriding this option.
+
+
+
+
+ timeout
+
+ How long the boot menu should be shown before the default
+ entry is booted, in seconds. This may be changed in the boot menu itself and
+ will be stored as an EFI variable in that case, overriding this option.
+
+
+ If the timeout is disabled, the default entry will be booted
+ immediately. The menu can be shown by pressing and holding a key before
+ sd-boot is launched.
+
+
+
+
+ console-mode
+
+ This option configures the resolution of the console. Takes a
+ number or one of the special values listed below. The following values may be
+ used:
+
+
+
+ 0
+
+ Standard UEFI 80x25 mode
+
+
+
+
+ 1
+
+ 80x50 mode, not supported by all devices
+
+
+
+
+ 2
+
+ the first non-standard mode provided by the device
+ firmware, if any
+
+
+
+
+ auto
+
+ Pick a suitable mode automatically using heuristics
+
+
+
+
+ max
+
+ Pick the highest-numbered available mode
+
+
+
+
+ keep
+
+ Keep the mode selected by firmware (the default)
+
+
+
+
+
+
+
+
+ editor
+
+ Takes a boolean argument. Enable (the default) or disable the
+ editor. The editor should be disabled if the machine can be accessed by
+ unauthorized persons.
+
+
+
+ auto-entries
+
+ Takes a boolean argument. Enable (the default) or disable
+ entries for other boot entries found on the boot partition. In particular,
+ this may be useful when loader entries are created to show replacement
+ descriptions for those entries.
+
+
+
+ auto-firmware
+
+ Takes a boolean argument. Enable (the default) or disable
+ the "Reboot into firmware" entry.
+
+
+
+
+
+ Example
+
+ # /boot/efi/loader/loader.conf
+timeout 0
+default 01234567890abcdef1234567890abdf0-*
+editor no
+
+
+ The menu will not be shown by default (the menu can still be shown by
+ pressing and holding a key during boot). One of the entries with files with a
+ name starting with 01234567890abcdef1234567890abdf0- will be
+ selected by default. If more than one entry matches, the one with the highest
+ priority will be selected (generally the one with the highest version number).
+ The editor will be disabled, so it is not possible to alter the kernel command
+ line.
+
+
+
+ See Also
+
+ sd-boot7,
+ bootctl1
+
+
+
diff --git a/man/rules/meson.build b/man/rules/meson.build
index ec197796e8..196c6ef0d8 100644
--- a/man/rules/meson.build
+++ b/man/rules/meson.build
@@ -25,6 +25,7 @@ manpages = [
['kernel-command-line', '7', [], ''],
['kernel-install', '8', [], ''],
['libudev', '3', [], ''],
+ ['loader.conf', '5', [], 'ENABLE_EFI'],
['locale.conf', '5', [], ''],
['localectl', '1', [], 'ENABLE_LOCALED'],
['localtime', '5', [], ''],
@@ -44,6 +45,7 @@ manpages = [
['pam_systemd', '8', [], 'HAVE_PAM'],
['resolved.conf', '5', ['resolved.conf.d'], 'ENABLE_RESOLVE'],
['runlevel', '8', [], 'ENABLE_UTMP'],
+ ['sd-boot', '7', [], 'ENABLE_EFI'],
['sd-bus-errors',
'3',
['SD_BUS_ERROR_ACCESS_DENIED',
diff --git a/man/sd-boot.xml b/man/sd-boot.xml
new file mode 100644
index 0000000000..d5e50b0487
--- /dev/null
+++ b/man/sd-boot.xml
@@ -0,0 +1,240 @@
+
+
+
+
+
+
+
+ sd-boot
+ systemd
+
+
+
+ I wrote this page
+ Zbigniew
+ Jędrzejewski-Szmek
+ zbyszek@in.waw.pl
+
+
+
+
+
+ sd-boot
+ 7
+
+
+
+ sd-boot
+ A simple UEFI boot manager
+
+
+
+ Description
+
+ systemd-boot or sd-boot is a simple
+ UEFI boot manager, previously known as gummiboot. It provides
+ a graphical menu to select the entry to boot and an editor for the kernel command
+ line. sd-boot is only useful on machines using UEFI.
+
+
+ sd-boot loads information from the EFI system partition (ESP), usually
+ mounted at /boot, /efi, or
+ /boot/efi. Configuration file fragments, kernels, initrds,
+ other EFI images need to reside on the ESP. Linux kernels must be built with
+ to be able to be directly executed as an EFI
+ image. sd-boot will automatically list other boot entries registered as EFI boot
+ variables, and a list of kernels from configuration files following the Boot Loader
+ Specification located under /loader/entries/ on the
+ ESP.
+
+ kernel-install8
+ may be used to copy kernel images onto the ESP and to generate entries compliant
+ with the Boot Loader Specification.
+ bootctl1
+ may be used from a running system to locate the ESP, list available entries, and
+ install sd-boot itself.
+
+ sd-boot will provide information about the time spent in UEFI firmware
+ using the
+ Boot Loader Interface.
+ This information can be displayed using
+ systemd-analyze1.
+
+
+
+
+ Configuration
+
+ sd-boot reads configuration like the timeout and default entry from
+ /loader/loader.conf on the ESP and from EFI variables. See
+ loader.conf5.
+
+
+
+
+ Key bindings
+ The following keys may be used in the boot menu:
+
+
+
+ ↑ (Up)
+ ↓ (Down)
+ j
+ k
+ PageUp
+ PageDown
+ Home
+ End
+ Navigate up/down in the entry list
+
+
+
+ ↵ (Enter)
+ Boot selected entry
+
+
+
+ d
+ Make selected entry the default
+
+
+
+ e
+ Edit the kernel command line for selected entry
+
+
+
+ +
+ t
+ Increase the timeout before default entry is booted
+
+
+
+ -
+ T
+ Decrease the timeout
+
+
+
+ v
+ Show sd-boot, UEFI, and firmware versions
+
+
+
+ P
+ Print status
+
+
+
+ Q
+ Quit
+
+
+
+ h
+ ?
+ Show a help screen
+
+
+
+ Ctrl + l
+ Reprint the screen
+
+
+
+ The following keys may be used during bootup or in the boot menu to
+ directly boot a specific entry:
+
+
+
+ l
+ Linux
+
+
+
+ w
+ Windows
+
+
+
+ a
+ OS X
+
+
+
+ s
+ EFI shell
+
+
+
+ 1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+ Entry number 1 .. 9
+
+
+
+ In the editor, most keys simply insert themselves, but the following keys
+ may be used to perform additional actions:
+
+
+
+ ← (Left)
+ → (Right)
+ Home
+ End
+ Navigate left/right
+
+
+
+ Esc
+ Abort the edit and quit the editor
+
+
+
+ Ctrl + k
+ Clear the command line
+
+
+
+ Ctrl + w
+ Alt + Backspace
+ Delete word backwards
+
+
+
+ Alt + d
+ Delete word forwards
+
+
+
+ ↵ (Enter)
+ Boot entry with the edited command line
+
+
+
+ Note that unless configured otherwise in the UEFI firmware, sd-boot will
+ use the US keyboard layout, so key labels might not match for keys like +/-.
+
+
+
+
+ See Also
+
+ bootctl1,
+ loader.conf5,
+ Boot Loader Specification,
+ Boot Loader Interface,
+ upstream wiki page
+
+
+