man/systemd-boot.xml

   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">
   4
   5 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
   6
   7 <refentry id="systemd-boot" conditional='ENABLE_EFI'
   8     xmlns:xi="http://www.w3.org/2001/XInclude">
   9   <refentryinfo>
  10     <title>systemd-boot</title>
  11     <productname>systemd</productname>
  12   </refentryinfo>
  13
  14   <refmeta>
  15     <refentrytitle>systemd-boot</refentrytitle>
  16     <manvolnum>7</manvolnum>
  17   </refmeta>
  18
  19   <refnamediv>
  20     <refname>systemd-boot</refname>
  21     <refname>sd-boot</refname>
  22     <refpurpose>A simple UEFI boot manager</refpurpose>
  23   </refnamediv>
  24
  25   <refsect1>
  26     <title>Description</title>
  27
  28     <para><command>systemd-boot</command> or <command>sd-boot</command> is a simple
  29     UEFI boot manager, previously known as <command>gummiboot</command>. It provides
  30     a graphical menu to select the entry to boot and an editor for the kernel command
  31     line. systemd-boot is only useful on machines using UEFI.
  32     </para>
  33
  34     <para>systemd-boot loads information from the EFI system partition (ESP), usually
  35     mounted at <filename>/boot</filename>, <filename>/efi</filename>, or
  36     <filename>/boot/efi</filename>. Configuration file fragments, kernels, initrds,
  37     other EFI images need to reside on the ESP. Linux kernels must be built with
  38     <option>CONFIG_EFI_STUB</option> to be able to be directly executed as an EFI
  39     image. systemd-boot will automatically list other boot entries registered as EFI boot
  40     variables, and a list of kernels from configuration files following the <ulink
  41     url="https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot Loader
  42     Specification</ulink> located under <filename>/loader/entries/</filename> on the
  43     ESP.</para>
  44
  45     <para><citerefentry><refentrytitle>kernel-install</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  46     may be used to copy kernel images onto the ESP and to generate entries compliant
  47     with the Boot Loader Specification.
  48     <citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  49     may be used from a running system to locate the ESP, list available entries, and
  50     install systemd-boot itself.</para>
  51
  52     <para>systemd-boot will provide information about the time spent in UEFI firmware
  53     using the
  54     <ulink url="https://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Boot Loader Interface</ulink>.
  55     This information can be displayed using
  56     <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
  57     </para>
  58   </refsect1>
  59
  60   <refsect1>
  61     <title>Configuration</title>
  62
  63     <para>systemd-boot reads configuration like the timeout and default entry from
  64     <filename>/loader/loader.conf</filename> on the ESP and from EFI variables. See
  65     <citerefentry><refentrytitle>loader.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  66     </para>
  67   </refsect1>
  68
  69   <refsect1>
  70     <title>Key bindings</title>
  71     <para>The following keys may be used in the boot menu:</para>
  72
  73     <variablelist>
  74       <varlistentry>
  75         <term>↑ (Up)</term>
  76         <term>↓ (Down)</term>
  77         <term>j</term>
  78         <term>k</term>
  79         <term>PageUp</term>
  80         <term>PageDown</term>
  81         <term>Home</term>
  82         <term>End</term>
  83         <listitem><para>Navigate up/down in the entry list</para></listitem>
  84       </varlistentry>
  85
  86       <varlistentry>
  87         <term>↵ (Enter)</term>
  88         <listitem><para>Boot selected entry</para></listitem>
  89       </varlistentry>
  90
  91       <varlistentry>
  92         <term>d</term>
  93         <listitem><para>Make selected entry the default</para></listitem>
  94       </varlistentry>
  95
  96       <varlistentry>
  97         <term>e</term>
  98         <listitem><para>Edit the kernel command line for selected entry</para></listitem>
  99       </varlistentry>
 100
 101       <varlistentry>
 102         <term>+</term>
 103         <term>t</term>
 104         <listitem><para>Increase the timeout before default entry is booted</para></listitem>
 105       </varlistentry>
 106
 107       <varlistentry>
 108         <term>-</term>
 109         <term>T</term>
 110         <listitem><para>Decrease the timeout</para></listitem>
 111       </varlistentry>
 112
 113       <varlistentry>
 114         <term>v</term>
 115         <listitem><para>Show systemd-boot, UEFI, and firmware versions</para></listitem>
 116       </varlistentry>
 117
 118       <varlistentry>
 119         <term>P</term>
 120         <listitem><para>Print status</para></listitem>
 121       </varlistentry>
 122
 123       <varlistentry>
 124         <term>Q</term>
 125         <listitem><para>Quit</para></listitem>
 126       </varlistentry>
 127
 128       <varlistentry>
 129         <term>h</term>
 130         <term>?</term>
 131         <listitem><para>Show a help screen</para></listitem>
 132       </varlistentry>
 133
 134       <varlistentry>
 135         <term>Ctrl + l</term>
 136         <listitem><para>Reprint the screen</para></listitem>
 137       </varlistentry>
 138     </variablelist>
 139
 140     <para>The following keys may be used during bootup or in the boot menu to
 141     directly boot a specific entry:</para>
 142
 143     <variablelist>
 144       <varlistentry>
 145         <term>l</term>
 146         <listitem><para>Linux</para></listitem>
 147       </varlistentry>
 148
 149       <varlistentry>
 150         <term>w</term>
 151         <listitem><para>Windows</para></listitem>
 152       </varlistentry>
 153
 154       <varlistentry>
 155         <term>a</term>
 156         <listitem><para>OS X</para></listitem>
 157       </varlistentry>
 158
 159       <varlistentry>
 160         <term>s</term>
 161         <listitem><para>EFI shell</para></listitem>
 162       </varlistentry>
 163
 164       <varlistentry>
 165         <term>1</term>
 166         <term>2</term>
 167         <term>3</term>
 168         <term>4</term>
 169         <term>5</term>
 170         <term>6</term>
 171         <term>7</term>
 172         <term>8</term>
 173         <term>9</term>
 174         <listitem><para>Entry number 1 .. 9</para></listitem>
 175       </varlistentry>
 176     </variablelist>
 177
 178     <para>In the editor, most keys simply insert themselves, but the following keys
 179     may be used to perform additional actions:</para>
 180
 181     <variablelist>
 182       <varlistentry>
 183         <term>← (Left)</term>
 184         <term>→ (Right)</term>
 185         <term>Home</term>
 186         <term>End</term>
 187         <listitem><para>Navigate left/right</para></listitem>
 188       </varlistentry>
 189
 190       <varlistentry>
 191         <term>Esc</term>
 192         <listitem><para>Abort the edit and quit the editor</para></listitem>
 193       </varlistentry>
 194
 195       <varlistentry>
 196         <term>Ctrl + k</term>
 197         <listitem><para>Clear the command line</para></listitem>
 198       </varlistentry>
 199
 200       <varlistentry>
 201         <term>Ctrl + w</term>
 202         <term>Alt + Backspace</term>
 203         <listitem><para>Delete word backwards</para></listitem>
 204       </varlistentry>
 205
 206       <varlistentry>
 207         <term>Alt + d </term>
 208         <listitem><para>Delete word forwards</para></listitem>
 209       </varlistentry>
 210
 211       <varlistentry>
 212         <term>↵ (Enter)</term>
 213         <listitem><para>Boot entry with the edited command line</para></listitem>
 214       </varlistentry>
 215     </variablelist>
 216
 217     <para>Note that unless configured otherwise in the UEFI firmware, systemd-boot will
 218     use the US keyboard layout, so key labels might not match for keys like +/-.
 219     </para>
 220   </refsect1>
 221
 222   <refsect1>
 223     <title>See Also</title>
 224     <para>
 225       <citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 226       <citerefentry><refentrytitle>loader.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 227       <ulink url="https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot Loader Specification</ulink>,
 228       <ulink url="https://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Boot Loader Interface</ulink>,
 229       <ulink url="https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/">upstream wiki page</ulink>
 230     </para>
 231   </refsect1>
 232 </refentry>