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">
6 SPDX-License-Identifier: LGPL-2.1+
8 This file is part of systemd.
11 <refentry id=
"bootctl" conditional='ENABLE_EFI'
12 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
14 <title>bootctl
</title>
15 <productname>systemd
</productname>
19 <contrib>Developer
</contrib>
20 <firstname>Kay
</firstname>
21 <surname>Sievers
</surname>
22 <email>kay@vrfy.org
</email>
28 <refentrytitle>bootctl
</refentrytitle>
29 <manvolnum>1</manvolnum>
33 <refname>bootctl
</refname>
34 <refpurpose>Control the firmware and boot manager settings
</refpurpose>
39 <command>bootctl
<arg choice=
"opt" rep=
"repeat">OPTIONS
</arg> status
</command>
42 <command>bootctl
<arg choice=
"opt" rep=
"repeat">OPTIONS
</arg> list
</command>
45 <command>bootctl
<arg choice=
"opt" rep=
"repeat">OPTIONS
</arg> update
</command>
48 <command>bootctl
<arg choice=
"opt" rep=
"repeat">OPTIONS
</arg> install
</command>
51 <command>bootctl
<arg choice=
"opt" rep=
"repeat">OPTIONS
</arg> remove
</command>
56 <title>Description
</title>
58 <para><command>bootctl
</command> can check the EFI boot loader status, list
59 available entries, and install, update, or remove the
60 <citerefentry><refentrytitle>sd-boot
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
61 boot loader on the current system.
</para>
63 <para><command>bootctl status
</command> shows the currently installed versions of
64 the boot loader binaries and all current EFI boot variables.
</para>
66 <para><command>bootctl list
</command> displays all configured boot loader entries.
69 <para><command>bootctl update
</command> updates all installed versions of
70 <citerefentry><refentrytitle>sd-boot
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
71 if the current version is newer than the version installed in the EFI system
72 partition. This also includes the EFI default/fallback loader at
73 <filename><replaceable>ESP
</replaceable>/EFI/BOOT/BOOT*.EFI
</filename>. A
74 systemd-boot entry in the EFI boot variables is created if there is no current
75 entry. The created entry will be added to the end of the boot order list.
</para>
77 <para><command>bootctl install
</command> installs systemd-boot into the EFI
78 system partition. A copy of systemd-boot will be stored as the EFI
79 default/fallback loader at
80 <filename><replaceable>ESP
</replaceable>/EFI/BOOT/BOOT*.EFI
</filename>. A
81 systemd-boot entry in the EFI boot variables is created and added to the top of
82 the boot order list.
</para>
84 <para><command>bootctl remove
</command> removes all installed versions of
85 systemd-boot from the EFI system partition, and removes systemd-boot from the EFI
86 boot variables.
</para>
88 <para>If no command is passed,
<command>status
</command> is implied.
</para>
92 <title>Options
</title>
93 <para>The following options are understood:
</para>
96 <xi:include href=
"standard-options.xml" xpointer=
"help" />
97 <xi:include href=
"standard-options.xml" xpointer=
"version" />
99 <term><option>--path=
</option></term>
100 <listitem><para>Path to the EFI System Partition (ESP). If not specified,
<filename>/efi
</filename>,
101 <filename>/boot
</filename>, and
<filename>/boot/efi
</filename> are checked in turn. It is recommended to mount
102 the ESP to
<filename>/boot
</filename>, if possible.
</para></listitem>
106 <term><option>-p
</option></term>
107 <term><option>--print-path
</option></term>
108 <listitem><para>This option modifies the behaviour of
<command>status
</command>.
109 Just print the path to the EFI System Partition (ESP) to standard output and
110 exit.
</para></listitem>
114 <term><option>--no-variables
</option></term>
115 <listitem><para>Do not touch the EFI boot variables.
</para></listitem>
121 <title>Exit status
</title>
122 <para>On success,
0 is returned, a non-zero failure
123 code otherwise.
</para>
127 <title>See Also
</title>
129 <citerefentry><refentrytitle>sd-boot
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
130 <ulink url=
"https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot Loader Specification
</ulink>,
131 <ulink url=
"https://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Boot Loader Interface
</ulink>