]>
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 | 6 | SPDX-License-Identifier: LGPL-2.1+ |
1bc64d77 MM |
7 | --> |
8 | ||
dfdebb1b | 9 | <refentry id="bootctl" conditional='ENABLE_EFI' |
798d3a52 | 10 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
798d3a52 ZJS |
11 | <refentryinfo> |
12 | <title>bootctl</title> | |
13 | <productname>systemd</productname> | |
798d3a52 ZJS |
14 | </refentryinfo> |
15 | ||
16 | <refmeta> | |
17 | <refentrytitle>bootctl</refentrytitle> | |
18 | <manvolnum>1</manvolnum> | |
19 | </refmeta> | |
20 | ||
21 | <refnamediv> | |
22 | <refname>bootctl</refname> | |
23 | <refpurpose>Control the firmware and boot manager settings</refpurpose> | |
24 | </refnamediv> | |
25 | ||
26 | <refsynopsisdiv> | |
27 | <cmdsynopsis> | |
c779b82a YW |
28 | <command>bootctl</command> |
29 | <arg choice="opt" rep="repeat">OPTIONS</arg> | |
30 | <arg choice="req">COMMAND</arg> | |
798d3a52 ZJS |
31 | </cmdsynopsis> |
32 | </refsynopsisdiv> | |
33 | ||
34 | <refsect1> | |
35 | <title>Description</title> | |
36 | ||
f37d3835 ZJS |
37 | <para><command>bootctl</command> can check the EFI boot loader status, list |
38 | available entries, and install, update, or remove the | |
70c8db75 | 39 | <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry> |
f37d3835 | 40 | boot loader on the current system.</para> |
798d3a52 ZJS |
41 | </refsect1> |
42 | ||
43 | <refsect1> | |
44 | <title>Options</title> | |
798d3a52 ZJS |
45 | <para>The following options are understood:</para> |
46 | ||
47 | <variablelist> | |
48 | <xi:include href="standard-options.xml" xpointer="help" /> | |
49 | <xi:include href="standard-options.xml" xpointer="version" /> | |
798d3a52 | 50 | <varlistentry> |
2f2c539c LP |
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> | |
0974a682 | 55 | </varlistentry> |
798d3a52 | 56 | |
30b50477 ZJS |
57 | <varlistentry> |
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> | |
63 | </varlistentry> | |
64 | ||
0974a682 KS |
65 | <varlistentry> |
66 | <term><option>--no-variables</option></term> | |
67 | <listitem><para>Do not touch the EFI boot variables.</para></listitem> | |
798d3a52 ZJS |
68 | </varlistentry> |
69 | </variablelist> | |
798d3a52 ZJS |
70 | </refsect1> |
71 | ||
c779b82a YW |
72 | <refsect1> |
73 | <title>Commands</title> | |
74 | <variablelist> | |
75 | ||
76 | <varlistentry> | |
77 | <term><option>status</option></term> | |
78 | ||
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> | |
81 | </varlistentry> | |
82 | ||
83 | <varlistentry> | |
84 | <term><option>list</option></term> | |
85 | ||
86 | <listitem><para>Shows all configured boot loader entries.</para></listitem> | |
87 | </varlistentry> | |
88 | ||
89 | <varlistentry> | |
90 | <term><option>update</option></term> | |
91 | ||
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> | |
99 | </varlistentry> | |
100 | ||
101 | <varlistentry> | |
102 | <term><option>install</option></term> | |
103 | ||
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> | |
108 | </varlistentry> | |
109 | ||
110 | <varlistentry> | |
111 | <term><option>remove</option></term> | |
112 | ||
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> | |
115 | </varlistentry> | |
116 | ||
117 | </variablelist> | |
118 | </refsect1> | |
119 | ||
798d3a52 ZJS |
120 | <refsect1> |
121 | <title>Exit status</title> | |
c779b82a | 122 | <para>On success, 0 is returned, a non-zero failure code otherwise.</para> |
798d3a52 ZJS |
123 | </refsect1> |
124 | ||
125 | <refsect1> | |
126 | <title>See Also</title> | |
127 | <para> | |
70c8db75 | 128 | <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, |
f37d3835 ZJS |
129 | <ulink url="https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot Loader Specification</ulink>, |
130 | <ulink url="https://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Boot Loader Interface</ulink> | |
798d3a52 ZJS |
131 | </para> |
132 | </refsect1> | |
1bc64d77 | 133 | </refentry> |