]>
Commit | Line | Data |
---|---|---|
1bc64d77 | 1 | <?xml version='1.0'?> <!--*-nxml-*--> |
3a54a157 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
12b42c76 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
0307f791 | 4 | <!-- SPDX-License-Identifier: LGPL-2.1+ --> |
1bc64d77 | 5 | |
dfdebb1b | 6 | <refentry id="bootctl" conditional='ENABLE_EFI' |
798d3a52 | 7 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
798d3a52 ZJS |
8 | <refentryinfo> |
9 | <title>bootctl</title> | |
10 | <productname>systemd</productname> | |
798d3a52 ZJS |
11 | </refentryinfo> |
12 | ||
13 | <refmeta> | |
14 | <refentrytitle>bootctl</refentrytitle> | |
15 | <manvolnum>1</manvolnum> | |
16 | </refmeta> | |
17 | ||
18 | <refnamediv> | |
19 | <refname>bootctl</refname> | |
20 | <refpurpose>Control the firmware and boot manager settings</refpurpose> | |
21 | </refnamediv> | |
22 | ||
23 | <refsynopsisdiv> | |
24 | <cmdsynopsis> | |
c779b82a YW |
25 | <command>bootctl</command> |
26 | <arg choice="opt" rep="repeat">OPTIONS</arg> | |
27 | <arg choice="req">COMMAND</arg> | |
798d3a52 ZJS |
28 | </cmdsynopsis> |
29 | </refsynopsisdiv> | |
30 | ||
31 | <refsect1> | |
32 | <title>Description</title> | |
33 | ||
4eb5636b LP |
34 | <para><command>bootctl</command> can check the EFI boot loader status, list available boot loaders and boot loader |
35 | entries, and install, update, or remove the | |
36 | <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry> boot loader on the | |
37 | current system.</para> | |
798d3a52 ZJS |
38 | </refsect1> |
39 | ||
40 | <refsect1> | |
41 | <title>Options</title> | |
798d3a52 ZJS |
42 | <para>The following options are understood:</para> |
43 | ||
44 | <variablelist> | |
798d3a52 | 45 | <varlistentry> |
3da2b703 LP |
46 | <term><option>--esp-path=</option></term> |
47 | <listitem><para>Path to the EFI System Partition (ESP). If not specified, <filename>/efi/</filename>, | |
48 | <filename>/boot/</filename>, and <filename>/boot/efi</filename> are checked in turn. It is recommended to mount | |
49 | the ESP to <filename>/efi/</filename>, if possible.</para></listitem> | |
50 | </varlistentry> | |
51 | ||
52 | <varlistentry> | |
53 | <term><option>--boot-path=</option></term> | |
54 | <listitem><para>Path to the Extended Boot Loader partition, as defined in the <ulink | |
55 | url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader Specification</ulink>. If not | |
56 | specified, <filename>/boot/</filename> are checked. It is recommended to mount the Extended Boot | |
57 | Loader partition to <filename>/boot/</filename>, if possible.</para></listitem> | |
0974a682 | 58 | </varlistentry> |
798d3a52 | 59 | |
30b50477 ZJS |
60 | <varlistentry> |
61 | <term><option>-p</option></term> | |
3da2b703 LP |
62 | <term><option>--print-esp-path</option></term> |
63 | <listitem><para>This option modifies the behaviour of <command>status</command>. Prints only the | |
64 | path to the EFI System Partition (ESP) to standard output and exits.</para></listitem> | |
65 | </varlistentry> | |
66 | ||
67 | <varlistentry> | |
68 | <term><option>--print-boot-path</option></term> | |
69 | <listitem><para>This option modifies the behaviour of <command>status</command>. Prints only the | |
70 | path to the Extended Boot Loader partition if it exists, and the path to the ESP otherwise to | |
71 | standard output and exit. This command is useful to determine where to place boot loader entries, as | |
72 | they are preferably placed in the Extended Boot Loader partition if it exists and in the ESP | |
73 | otherwise.</para></listitem> | |
30b50477 ZJS |
74 | </varlistentry> |
75 | ||
0974a682 KS |
76 | <varlistentry> |
77 | <term><option>--no-variables</option></term> | |
4eb5636b | 78 | <listitem><para>Do not touch the firmware's boot loader list stored in EFI variables.</para></listitem> |
798d3a52 | 79 | </varlistentry> |
dcb4fe74 LP |
80 | |
81 | <xi:include href="standard-options.xml" xpointer="no-pager"/> | |
82 | <xi:include href="standard-options.xml" xpointer="help"/> | |
83 | <xi:include href="standard-options.xml" xpointer="version"/> | |
798d3a52 | 84 | </variablelist> |
798d3a52 ZJS |
85 | </refsect1> |
86 | ||
c779b82a YW |
87 | <refsect1> |
88 | <title>Commands</title> | |
89 | <variablelist> | |
90 | ||
91 | <varlistentry> | |
92 | <term><option>status</option></term> | |
93 | ||
4eb5636b LP |
94 | <listitem><para>Shows brief information about the system firmware, the boot loader that was used to boot the |
95 | system, the boot loaders currently available in the ESP, the boot loaders listed in the firmware's list of boot | |
96 | loaders and the current default boot loader entry. If no command is specified, this is the implied | |
97 | default.</para></listitem> | |
c779b82a YW |
98 | </varlistentry> |
99 | ||
c779b82a | 100 | <varlistentry> |
4eb5636b | 101 | <term><option>install</option></term> |
c779b82a | 102 | |
3da2b703 LP |
103 | <listitem><para>Installs <command>systemd-boot</command> into the EFI system partition. A copy of |
104 | <command>systemd-boot</command> will be stored as the EFI default/fallback loader at | |
105 | <filename><replaceable>ESP</replaceable>/EFI/BOOT/BOOT*.EFI</filename>. The boot loader is then added | |
106 | to the top of the firmware's boot loader list.</para></listitem> | |
c779b82a YW |
107 | </varlistentry> |
108 | ||
109 | <varlistentry> | |
4eb5636b | 110 | <term><option>update</option></term> |
c779b82a | 111 | |
4eb5636b LP |
112 | <listitem><para>Updates all installed versions of |
113 | <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, if the | |
114 | available version is newer than the version installed in the EFI system partition. This also includes the EFI | |
115 | default/fallback loader at <filename><replaceable>ESP</replaceable>/EFI/BOOT/BOOT*.EFI</filename>. The boot | |
116 | loader is then added to end of the firmware's boot loader list if missing.</para></listitem> | |
c779b82a YW |
117 | </varlistentry> |
118 | ||
119 | <varlistentry> | |
120 | <term><option>remove</option></term> | |
121 | ||
4eb5636b LP |
122 | <listitem><para>Removes all installed versions of <command>systemd-boot</command> from the EFI system partition |
123 | and the firmware's boot loader list.</para></listitem> | |
c779b82a YW |
124 | </varlistentry> |
125 | ||
d88c96ff LP |
126 | <varlistentry> |
127 | <term><option>list</option></term> | |
128 | ||
129 | <listitem><para>Shows all available boot loader entries implementing the <ulink | |
a0848495 | 130 | url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader |
bd2865ca LP |
131 | Specification</ulink>, as well as any other entries discovered or automatically generated by the boot |
132 | loader.</para></listitem> | |
d88c96ff LP |
133 | </varlistentry> |
134 | ||
135 | <varlistentry> | |
136 | <term><option>set-default</option> <replaceable>ID</replaceable></term> | |
137 | <term><option>set-oneshot</option> <replaceable>ID</replaceable></term> | |
138 | ||
139 | <listitem><para>Sets the default boot loader entry. Takes a single boot loader entry ID string as argument. The | |
140 | <option>set-oneshot</option> command will set the default entry only for the next boot, the | |
141 | <option>set-default</option> will set it persistently for all future boots.</para></listitem> | |
142 | </varlistentry> | |
143 | ||
c779b82a YW |
144 | </variablelist> |
145 | </refsect1> | |
146 | ||
798d3a52 ZJS |
147 | <refsect1> |
148 | <title>Exit status</title> | |
c779b82a | 149 | <para>On success, 0 is returned, a non-zero failure code otherwise.</para> |
798d3a52 ZJS |
150 | </refsect1> |
151 | ||
8cbb7d87 LP |
152 | <refsect1> |
153 | <title>Environment</title> | |
3da2b703 LP |
154 | <para>If <varname>$SYSTEMD_RELAX_ESP_CHECKS=1</varname> is set the validation checks for the ESP are |
155 | relaxed, and the path specified with <option>--esp-path=</option> may refer to any kind of file system on | |
156 | any kind of partition.</para> | |
157 | ||
158 | <para>Similarly, <varname>$SYSTEMD_RELAX_XBOOTLDR_CHECKS=1</varname> turns off some validation checks for | |
159 | the Extended Boot Loader partition.</para> | |
8cbb7d87 LP |
160 | </refsect1> |
161 | ||
798d3a52 ZJS |
162 | <refsect1> |
163 | <title>See Also</title> | |
164 | <para> | |
70c8db75 | 165 | <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, |
a0848495 | 166 | <ulink url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader Specification</ulink>, |
2fe82132 | 167 | <ulink url="https://systemd.io/BOOT_LOADER_INTERFACE">Boot Loader Interface</ulink> |
798d3a52 ZJS |
168 | </para> |
169 | </refsect1> | |
1bc64d77 | 170 | </refentry> |