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