1 <?xml version='
1.0'
?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
5 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
7 <refentry id=
"sd-boot" conditional='ENABLE_EFI'
8 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
10 <title>sd-boot
</title>
11 <productname>systemd
</productname>
15 <contrib>I wrote this page
</contrib>
16 <firstname>Zbigniew
</firstname>
17 <surname>Jędrzejewski-Szmek
</surname>
18 <email>zbyszek@in.waw.pl
</email>
24 <refentrytitle>sd-boot
</refentrytitle>
25 <manvolnum>7</manvolnum>
29 <refname>sd-boot
</refname>
30 <refpurpose>A simple UEFI boot manager
</refpurpose>
34 <title>Description
</title>
36 <para><command>systemd-boot
</command> or
<command>sd-boot
</command> is a simple
37 UEFI boot manager, previously known as
<command>gummiboot
</command>. It provides
38 a graphical menu to select the entry to boot and an editor for the kernel command
39 line. sd-boot is only useful on machines using UEFI.
42 <para>sd-boot loads information from the EFI system partition (ESP), usually
43 mounted at
<filename>/boot
</filename>,
<filename>/efi
</filename>, or
44 <filename>/boot/efi
</filename>. Configuration file fragments, kernels, initrds,
45 other EFI images need to reside on the ESP. Linux kernels must be built with
46 <option>CONFIG_EFI_STUB
</option> to be able to be directly executed as an EFI
47 image. sd-boot will automatically list other boot entries registered as EFI boot
48 variables, and a list of kernels from configuration files following the
<ulink
49 url=
"https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot Loader
50 Specification
</ulink> located under
<filename>/loader/entries/
</filename> on the
53 <para><citerefentry><refentrytitle>kernel-install
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
54 may be used to copy kernel images onto the ESP and to generate entries compliant
55 with the Boot Loader Specification.
56 <citerefentry><refentrytitle>bootctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
57 may be used from a running system to locate the ESP, list available entries, and
58 install sd-boot itself.
</para>
60 <para>sd-boot will provide information about the time spent in UEFI firmware
62 <ulink url=
"https://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Boot Loader Interface
</ulink>.
63 This information can be displayed using
64 <citerefentry><refentrytitle>systemd-analyze
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
69 <title>Configuration
</title>
71 <para>sd-boot reads configuration like the timeout and default entry from
72 <filename>/loader/loader.conf
</filename> on the ESP and from EFI variables. See
73 <citerefentry><refentrytitle>loader.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
78 <title>Key bindings
</title>
79 <para>The following keys may be used in the boot menu:
</para>
91 <listitem><para>Navigate up/down in the entry list
</para></listitem>
95 <term>↵ (Enter)
</term>
96 <listitem><para>Boot selected entry
</para></listitem>
101 <listitem><para>Make selected entry the default
</para></listitem>
106 <listitem><para>Edit the kernel command line for selected entry
</para></listitem>
112 <listitem><para>Increase the timeout before default entry is booted
</para></listitem>
118 <listitem><para>Decrease the timeout
</para></listitem>
123 <listitem><para>Show sd-boot, UEFI, and firmware versions
</para></listitem>
128 <listitem><para>Print status
</para></listitem>
133 <listitem><para>Quit
</para></listitem>
139 <listitem><para>Show a help screen
</para></listitem>
143 <term>Ctrl + l
</term>
144 <listitem><para>Reprint the screen
</para></listitem>
148 <para>The following keys may be used during bootup or in the boot menu to
149 directly boot a specific entry:
</para>
154 <listitem><para>Linux
</para></listitem>
159 <listitem><para>Windows
</para></listitem>
164 <listitem><para>OS X
</para></listitem>
169 <listitem><para>EFI shell
</para></listitem>
182 <listitem><para>Entry number
1 ..
9</para></listitem>
186 <para>In the editor, most keys simply insert themselves, but the following keys
187 may be used to perform additional actions:
</para>
191 <term>← (Left)
</term>
192 <term>→ (Right)
</term>
195 <listitem><para>Navigate left/right
</para></listitem>
200 <listitem><para>Abort the edit and quit the editor
</para></listitem>
204 <term>Ctrl + k
</term>
205 <listitem><para>Clear the command line
</para></listitem>
209 <term>Ctrl + w
</term>
210 <term>Alt + Backspace
</term>
211 <listitem><para>Delete word backwards
</para></listitem>
215 <term>Alt + d
</term>
216 <listitem><para>Delete word forwards
</para></listitem>
220 <term>↵ (Enter)
</term>
221 <listitem><para>Boot entry with the edited command line
</para></listitem>
225 <para>Note that unless configured otherwise in the UEFI firmware, sd-boot will
226 use the US keyboard layout, so key labels might not match for keys like +/-.
231 <title>See Also
</title>
233 <citerefentry><refentrytitle>bootctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
234 <citerefentry><refentrytitle>loader.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
235 <ulink url=
"https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot Loader Specification
</ulink>,
236 <ulink url=
"https://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Boot Loader Interface
</ulink>,
237 <ulink url=
"https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/">upstream wiki page
</ulink>