]>
Commit | Line | Data |
---|---|---|
1bc64d77 MM |
1 | <?xml version='1.0'?> <!--*-nxml-*--> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | |
12b42c76 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
1bc64d77 MM |
4 | |
5 | <!-- | |
572eb058 ZJS |
6 | SPDX-License-Identifier: LGPL-2.1+ |
7 | ||
1bc64d77 MM |
8 | This file is part of systemd. |
9 | ||
10 | systemd is free software; you can redistribute it and/or modify it | |
11 | under the terms of the GNU Lesser General Public License as published by | |
12 | the Free Software Foundation; either version 2.1 of the License, or | |
13 | (at your option) any later version. | |
14 | ||
15 | systemd is distributed in the hope that it will be useful, but | |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
18 | Lesser General Public License for more details. | |
19 | ||
20 | You should have received a copy of the GNU Lesser General Public License | |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. | |
22 | --> | |
23 | ||
dfdebb1b | 24 | <refentry id="bootctl" conditional='ENABLE_EFI' |
798d3a52 | 25 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
798d3a52 ZJS |
26 | <refentryinfo> |
27 | <title>bootctl</title> | |
28 | <productname>systemd</productname> | |
29 | ||
30 | <authorgroup> | |
31 | <author> | |
32 | <contrib>Developer</contrib> | |
33 | <firstname>Kay</firstname> | |
34 | <surname>Sievers</surname> | |
35 | <email>kay@vrfy.org</email> | |
36 | </author> | |
37 | </authorgroup> | |
38 | </refentryinfo> | |
39 | ||
40 | <refmeta> | |
41 | <refentrytitle>bootctl</refentrytitle> | |
42 | <manvolnum>1</manvolnum> | |
43 | </refmeta> | |
44 | ||
45 | <refnamediv> | |
46 | <refname>bootctl</refname> | |
47 | <refpurpose>Control the firmware and boot manager settings</refpurpose> | |
48 | </refnamediv> | |
49 | ||
50 | <refsynopsisdiv> | |
51 | <cmdsynopsis> | |
fdc1af0a | 52 | <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> status</command> |
0974a682 | 53 | </cmdsynopsis> |
7e87c7d9 ZJS |
54 | <cmdsynopsis> |
55 | <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> list</command> | |
56 | </cmdsynopsis> | |
0974a682 | 57 | <cmdsynopsis> |
fdc1af0a | 58 | <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> update</command> |
0974a682 KS |
59 | </cmdsynopsis> |
60 | <cmdsynopsis> | |
fdc1af0a | 61 | <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> install</command> |
0974a682 KS |
62 | </cmdsynopsis> |
63 | <cmdsynopsis> | |
fdc1af0a | 64 | <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> remove</command> |
798d3a52 ZJS |
65 | </cmdsynopsis> |
66 | </refsynopsisdiv> | |
67 | ||
68 | <refsect1> | |
69 | <title>Description</title> | |
70 | ||
f37d3835 ZJS |
71 | <para><command>bootctl</command> can check the EFI boot loader status, list |
72 | available entries, and install, update, or remove the | |
73 | <citerefentry><refentrytitle>sd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry> | |
74 | boot loader on the current system.</para> | |
0974a682 | 75 | |
f37d3835 ZJS |
76 | <para><command>bootctl status</command> shows the currently installed versions of |
77 | the boot loader binaries and all current EFI boot variables.</para> | |
0974a682 | 78 | |
7e87c7d9 ZJS |
79 | <para><command>bootctl list</command> displays all configured boot loader entries. |
80 | </para> | |
81 | ||
f37d3835 ZJS |
82 | <para><command>bootctl update</command> updates all installed versions of |
83 | <citerefentry><refentrytitle>sd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, | |
84 | if the current version is newer than the version installed in the EFI system | |
85 | partition. This also includes the EFI default/fallback loader at | |
86 | <filename><replaceable>ESP</replaceable>/EFI/BOOT/BOOT*.EFI</filename>. A | |
87 | systemd-boot entry in the EFI boot variables is created if there is no current | |
88 | entry. The created entry will be added to the end of the boot order list.</para> | |
89 | ||
90 | <para><command>bootctl install</command> installs systemd-boot into the EFI | |
91 | system partition. A copy of systemd-boot will be stored as the EFI | |
92 | default/fallback loader at | |
93 | <filename><replaceable>ESP</replaceable>/EFI/BOOT/BOOT*.EFI</filename>. A | |
94 | systemd-boot entry in the EFI boot variables is created and added to the top of | |
95 | the boot order list.</para> | |
96 | ||
97 | <para><command>bootctl remove</command> removes all installed versions of | |
98 | systemd-boot from the EFI system partition, and removes systemd-boot from the EFI | |
99 | boot variables.</para> | |
100 | ||
101 | <para>If no command is passed, <command>status</command> is implied.</para> | |
798d3a52 ZJS |
102 | </refsect1> |
103 | ||
104 | <refsect1> | |
105 | <title>Options</title> | |
798d3a52 ZJS |
106 | <para>The following options are understood:</para> |
107 | ||
108 | <variablelist> | |
109 | <xi:include href="standard-options.xml" xpointer="help" /> | |
110 | <xi:include href="standard-options.xml" xpointer="version" /> | |
798d3a52 | 111 | <varlistentry> |
2f2c539c LP |
112 | <term><option>--path=</option></term> |
113 | <listitem><para>Path to the EFI System Partition (ESP). If not specified, <filename>/efi</filename>, | |
114 | <filename>/boot</filename>, and <filename>/boot/efi</filename> are checked in turn. It is recommended to mount | |
115 | the ESP to <filename>/boot</filename>, if possible.</para></listitem> | |
0974a682 | 116 | </varlistentry> |
798d3a52 | 117 | |
30b50477 ZJS |
118 | <varlistentry> |
119 | <term><option>-p</option></term> | |
120 | <term><option>--print-path</option></term> | |
121 | <listitem><para>This option modifies the behaviour of <command>status</command>. | |
122 | Just print the path to the EFI System Partition (ESP) to standard output and | |
123 | exit.</para></listitem> | |
124 | </varlistentry> | |
125 | ||
0974a682 KS |
126 | <varlistentry> |
127 | <term><option>--no-variables</option></term> | |
128 | <listitem><para>Do not touch the EFI boot variables.</para></listitem> | |
798d3a52 ZJS |
129 | </varlistentry> |
130 | </variablelist> | |
798d3a52 ZJS |
131 | </refsect1> |
132 | ||
133 | <refsect1> | |
134 | <title>Exit status</title> | |
b938cb90 | 135 | <para>On success, 0 is returned, a non-zero failure |
0974a682 | 136 | code otherwise.</para> |
798d3a52 ZJS |
137 | </refsect1> |
138 | ||
139 | <refsect1> | |
140 | <title>See Also</title> | |
141 | <para> | |
f37d3835 ZJS |
142 | <citerefentry><refentrytitle>sd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, |
143 | <ulink url="https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot Loader Specification</ulink>, | |
144 | <ulink url="https://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Boot Loader Interface</ulink> | |
798d3a52 ZJS |
145 | </para> |
146 | </refsect1> | |
1bc64d77 | 147 | </refentry> |