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