man/loader.conf.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
   5
   6 <refentry id="loader.conf" conditional='ENABLE_EFI'
   7     xmlns:xi="http://www.w3.org/2001/XInclude">
   8   <refentryinfo>
   9     <title>loader.conf</title>
  10     <productname>systemd</productname>
  11   </refentryinfo>
  12
  13   <refmeta>
  14     <refentrytitle>loader.conf</refentrytitle>
  15     <manvolnum>5</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>loader.conf</refname>
  20     <refpurpose>Configuration file for systemd-boot</refpurpose>
  21   </refnamediv>
  22
  23   <refsynopsisdiv>
  24     <para><filename><replaceable>ESP</replaceable>/loader/loader.conf</filename>,
  25     <filename><replaceable>ESP</replaceable>/loader/entries/*.conf</filename>
  26     </para>
  27   </refsynopsisdiv>
  28
  29   <refsect1>
  30     <title>Description</title>
  31
  32     <para>
  33     <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  34     will read <filename><replaceable>ESP</replaceable>/loader/loader.conf</filename> and any files with the
  35     <literal>.conf</literal> extension under
  36     <filename><replaceable>ESP</replaceable>/loader/entries/</filename> on the EFI system partition (ESP).
  37     </para>
  38
  39     <para>Each configuration file must consist of an option name, followed by
  40     whitespace, and the option value. <literal>#</literal> may be used to start
  41     a comment line. Empty and comment lines are ignored.</para>
  42
  43     <para>Boolean arguments may be written as
  44     <literal>yes</literal>/<literal>y</literal>/<literal>true</literal>/<literal>1</literal> or
  45     <literal>no</literal>/<literal>n</literal>/<literal>false</literal>/<literal>0</literal>.
  46     </para>
  47   </refsect1>
  48
  49   <refsect1>
  50     <title>Options</title>
  51
  52     <para>The following configuration options in <filename>loader.conf</filename> are understood:</para>
  53
  54     <variablelist>
  55       <varlistentry>
  56         <term>default</term>
  57
  58         <listitem><para>A glob pattern to select the default entry. The default entry
  59         may be changed in the boot menu itself, in which case the name of the
  60         selected entry will be stored as an EFI variable, overriding this option.
  61         </para></listitem>
  62       </varlistentry>
  63
  64       <varlistentry>
  65         <term>timeout</term>
  66
  67         <listitem><para>How long the boot menu should be shown before the default
  68         entry is booted, in seconds. This may be changed in the boot menu itself and
  69         will be stored as an EFI variable in that case, overriding this option.
  70         </para>
  71
  72         <para>If the timeout is disabled, the default entry will be booted
  73         immediately. The menu can be shown by pressing and holding a key before
  74         systemd-boot is launched.</para>
  75         </listitem>
  76       </varlistentry>
  77
  78       <varlistentry>
  79         <term>console-mode</term>
  80
  81         <listitem><para>This option configures the resolution of the console. Takes a
  82         number or one of the special values listed below. The following values may be
  83         used:</para>
  84
  85         <variablelist>
  86           <varlistentry>
  87             <term>0</term>
  88             <listitem>
  89               <para>Standard UEFI 80x25 mode</para>
  90             </listitem>
  91           </varlistentry>
  92
  93           <varlistentry>
  94             <term>1</term>
  95             <listitem>
  96               <para>80x50 mode, not supported by all devices</para>
  97             </listitem>
  98           </varlistentry>
  99
 100           <varlistentry>
 101             <term>2</term>
 102             <listitem>
 103               <para>the first non-standard mode provided by the device
 104               firmware, if any</para>
 105             </listitem>
 106           </varlistentry>
 107
 108           <varlistentry>
 109             <term>auto</term>
 110             <listitem>
 111               <para>Pick a suitable mode automatically using heuristics</para>
 112             </listitem>
 113           </varlistentry>
 114
 115           <varlistentry>
 116             <term>max</term>
 117             <listitem>
 118               <para>Pick the highest-numbered available mode</para>
 119             </listitem>
 120           </varlistentry>
 121
 122           <varlistentry>
 123             <term>keep</term>
 124             <listitem>
 125               <para>Keep the mode selected by firmware (the default)</para>
 126             </listitem>
 127           </varlistentry>
 128         </variablelist>
 129
 130         </listitem>
 131       </varlistentry>
 132
 133       <varlistentry>
 134         <term>editor</term>
 135
 136         <listitem><para>Takes a boolean argument. Enable (the default) or disable the
 137         editor. The editor should be disabled if the machine can be accessed by
 138         unauthorized persons.</para></listitem>
 139       </varlistentry>
 140
 141       <varlistentry>
 142         <term>auto-entries</term>
 143
 144         <listitem><para>Takes a boolean argument. Enable (the default) or disable
 145         entries for other boot entries found on the boot partition. In particular,
 146         this may be useful when loader entries are created to show replacement
 147         descriptions for those entries.</para></listitem>
 148       </varlistentry>
 149
 150       <varlistentry>
 151         <term>auto-firmware</term>
 152
 153         <listitem><para>Takes a boolean argument. Enable (the default) or disable
 154         the "Reboot into firmware" entry.</para></listitem>
 155       </varlistentry>
 156
 157       <varlistentry>
 158         <term>random-seed-mode</term>
 159
 160         <listitem><para>Takes one of <literal>off</literal>, <literal>with-system-token</literal> and
 161         <literal>always</literal>. If <literal>off</literal> no random seed data is read off the ESP, nor
 162         passed to the OS. If <literal>with-system-token</literal> (the default)
 163         <command>systemd-boot</command> will read a random seed from the ESP (from the file
 164         <filename>/loader/random-seed</filename>) only if the <varname>LoaderSystemToken</varname> EFI
 165         variable is set, and then derive the random seed to pass to the OS from the combination. If
 166         <literal>always</literal> the boot loader will do so even if <varname>LoaderSystemToken</varname> is
 167         not set. This mode is useful in environments where protection against OS image reuse is not a
 168         concern, and the random seed shall be used even with no further setup in place. Use <command>bootctl
 169         random-seed</command> to initialize both the random seed file in the ESP and the system token EFI
 170         variable.</para>
 171
 172         <para>See <ulink url="https://systemd.io/RANDOM_SEEDS">Random Seeds</ulink> for further
 173         information.</para></listitem>
 174       </varlistentry>
 175     </variablelist>
 176   </refsect1>
 177
 178   <refsect1>
 179     <title>Example</title>
 180
 181     <programlisting># /boot/efi/loader/loader.conf
 182 timeout 0
 183 default 01234567890abcdef1234567890abdf0-*
 184 editor no
 185     </programlisting>
 186
 187     <para>The menu will not be shown by default (the menu can still be shown by
 188     pressing and holding a key during boot). One of the entries with files with a
 189     name starting with <literal>01234567890abcdef1234567890abdf0-</literal> will be
 190     selected by default. If more than one entry matches, the one with the highest
 191     priority will be selected (generally the one with the highest version number).
 192     The editor will be disabled, so it is not possible to alter the kernel command
 193     line.</para>
 194   </refsect1>
 195
 196   <refsect1>
 197       <title>See Also</title>
 198       <para>
 199         <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
 200         <citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 201       </para>
 202   </refsect1>
 203 </refentry>