]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/bootctl.xml
Merge pull request #7376 from keszybz/simplify-root-options
[thirdparty/systemd.git] / man / bootctl.xml
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 <!--
6 SPDX-License-Identifier: LGPL-2.1+
7
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
24 <refentry id="bootctl" conditional='ENABLE_EFI'
25 xmlns:xi="http://www.w3.org/2001/XInclude">
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>
52 <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> status</command>
53 </cmdsynopsis>
54 <cmdsynopsis>
55 <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> update</command>
56 </cmdsynopsis>
57 <cmdsynopsis>
58 <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> install</command>
59 </cmdsynopsis>
60 <cmdsynopsis>
61 <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> remove</command>
62 </cmdsynopsis>
63 </refsynopsisdiv>
64
65 <refsect1>
66 <title>Description</title>
67
68 <para><command>bootctl</command> checks, updates,
69 installs or removes the boot loader from the current
70 system.</para>
71
72 <para><command>bootctl status</command> checks and prints the
73 currently installed versions of the boot loader binaries and
74 all current EFI boot variables.</para>
75
76 <para><command>bootctl update</command> updates all installed versions of systemd-boot, if the current version is
77 newer than the version installed in the EFI system partition. This also includes the EFI default/fallback loader at
78 <filename>/EFI/BOOT/BOOT*.EFI</filename>. A systemd-boot entry in the EFI boot variables is created if there is no
79 current entry. The created entry will be added to the end of the boot order list.</para>
80
81 <para><command>bootctl install</command> installs systemd-boot into the EFI system partition. A copy of
82 systemd-boot will be stored as the EFI default/fallback loader at <filename>/EFI/BOOT/BOOT*.EFI</filename>. A
83 systemd-boot entry in the EFI boot variables is created and added to the top of the boot order list.</para>
84
85 <para><command>bootctl remove</command> removes all installed
86 versions of systemd-boot from the EFI system partition, and removes
87 systemd-boot from the EFI boot variables.</para>
88
89 <para>If no command is passed, <command>status</command> is
90 implied.</para>
91 </refsect1>
92
93 <refsect1>
94 <title>Options</title>
95 <para>The following options are understood:</para>
96
97 <variablelist>
98 <xi:include href="standard-options.xml" xpointer="help" />
99 <xi:include href="standard-options.xml" xpointer="version" />
100 <varlistentry>
101 <term><option>--path=</option></term>
102 <listitem><para>Path to the EFI System Partition (ESP). If not specified, <filename>/efi</filename>,
103 <filename>/boot</filename>, and <filename>/boot/efi</filename> are checked in turn. It is recommended to mount
104 the ESP to <filename>/boot</filename>, if possible.</para></listitem>
105 </varlistentry>
106
107 <varlistentry>
108 <term><option>--no-variables</option></term>
109 <listitem><para>Do not touch the EFI boot variables.</para></listitem>
110 </varlistentry>
111 </variablelist>
112 </refsect1>
113
114 <refsect1>
115 <title>Exit status</title>
116 <para>On success, 0 is returned, a non-zero failure
117 code otherwise.</para>
118 </refsect1>
119
120 <refsect1>
121 <title>See Also</title>
122 <para>
123 <ulink url="https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot loader specification</ulink>
124 <ulink url="https://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Systemd boot loader interface</ulink>
125 </para>
126 </refsect1>
127 </refentry>