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+
9 <refentry id=
"bootctl" conditional='ENABLE_EFI'
10 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
12 <title>bootctl
</title>
13 <productname>systemd
</productname>
17 <refentrytitle>bootctl
</refentrytitle>
18 <manvolnum>1</manvolnum>
22 <refname>bootctl
</refname>
23 <refpurpose>Control the firmware and boot manager settings
</refpurpose>
28 <command>bootctl
</command>
29 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
30 <arg choice=
"req">COMMAND
</arg>
35 <title>Description
</title>
37 <para><command>bootctl
</command> can check the EFI boot loader status, list
38 available entries, and install, update, or remove the
39 <citerefentry><refentrytitle>systemd-boot
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
40 boot loader on the current system.
</para>
44 <title>Options
</title>
45 <para>The following options are understood:
</para>
48 <xi:include href=
"standard-options.xml" xpointer=
"help" />
49 <xi:include href=
"standard-options.xml" xpointer=
"version" />
51 <term><option>--path=
</option></term>
52 <listitem><para>Path to the EFI System Partition (ESP). If not specified,
<filename>/efi
</filename>,
53 <filename>/boot
</filename>, and
<filename>/boot/efi
</filename> are checked in turn. It is recommended to mount
54 the ESP to
<filename>/boot
</filename>, if possible.
</para></listitem>
58 <term><option>-p
</option></term>
59 <term><option>--print-path
</option></term>
60 <listitem><para>This option modifies the behaviour of
<command>status
</command>.
61 Just print the path to the EFI System Partition (ESP) to standard output and
62 exit.
</para></listitem>
66 <term><option>--no-variables
</option></term>
67 <listitem><para>Do not touch the EFI boot variables.
</para></listitem>
73 <title>Commands
</title>
77 <term><option>status
</option></term>
79 <listitem><para>Shows the currently installed versions of the boot loader binaries and all current
80 EFI boot variables. If no command is specified, this is the implied default.
</para></listitem>
84 <term><option>list
</option></term>
86 <listitem><para>Shows all configured boot loader entries.
</para></listitem>
90 <term><option>update
</option></term>
92 <listitem><para>Updates all installed versions of
93 <citerefentry><refentrytitle>systemd-boot
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
94 if the current version is newer than the version installed in the EFI system
95 partition. This also includes the EFI default/fallback loader at
96 <filename><replaceable>ESP
</replaceable>/EFI/BOOT/BOOT*.EFI
</filename>. A
97 systemd-boot entry in the EFI boot variables is created if there is no current
98 entry. The created entry will be added to the end of the boot order list.
</para></listitem>
102 <term><option>install
</option></term>
104 <listitem><para>Installs systemd-boot into the EFI system partition. A copy of systemd-boot will
105 be stored as the EFI default/fallback loader at
106 <filename><replaceable>ESP
</replaceable>/EFI/BOOT/BOOT*.EFI
</filename>. A systemd-boot entry in
107 the EFI boot variables is created and added to the top of the boot order list.
</para></listitem>
111 <term><option>remove
</option></term>
113 <listitem><para>Removes all installed versions of systemd-boot from the EFI system partition,
114 and removes systemd-boot from the EFI boot variables.
</para></listitem>
121 <title>Exit status
</title>
122 <para>On success,
0 is returned, a non-zero failure code otherwise.
</para>
126 <title>See Also
</title>
128 <citerefentry><refentrytitle>systemd-boot
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
129 <ulink url=
"https://github.com/systemd/systemd/blob/master/doc/BOOT_LOADER_SPECIFICATION.md">Boot Loader Specification
</ulink>,
130 <ulink url=
"https://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Boot Loader Interface
</ulink>