]>
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 | ||
4eb5636b LP |
37 | <para><command>bootctl</command> can check the EFI boot loader status, list available boot loaders and boot loader |
38 | entries, and install, update, or remove the | |
39 | <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry> boot loader on the | |
40 | 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> | |
798d3a52 | 48 | <varlistentry> |
2f2c539c LP |
49 | <term><option>--path=</option></term> |
50 | <listitem><para>Path to the EFI System Partition (ESP). If not specified, <filename>/efi</filename>, | |
51 | <filename>/boot</filename>, and <filename>/boot/efi</filename> are checked in turn. It is recommended to mount | |
52 | the ESP to <filename>/boot</filename>, if possible.</para></listitem> | |
0974a682 | 53 | </varlistentry> |
798d3a52 | 54 | |
30b50477 ZJS |
55 | <varlistentry> |
56 | <term><option>-p</option></term> | |
57 | <term><option>--print-path</option></term> | |
58 | <listitem><para>This option modifies the behaviour of <command>status</command>. | |
59 | Just print the path to the EFI System Partition (ESP) to standard output and | |
60 | exit.</para></listitem> | |
61 | </varlistentry> | |
62 | ||
0974a682 KS |
63 | <varlistentry> |
64 | <term><option>--no-variables</option></term> | |
4eb5636b | 65 | <listitem><para>Do not touch the firmware's boot loader list stored in EFI variables.</para></listitem> |
798d3a52 | 66 | </varlistentry> |
dcb4fe74 LP |
67 | |
68 | <xi:include href="standard-options.xml" xpointer="no-pager"/> | |
69 | <xi:include href="standard-options.xml" xpointer="help"/> | |
70 | <xi:include href="standard-options.xml" xpointer="version"/> | |
798d3a52 | 71 | </variablelist> |
798d3a52 ZJS |
72 | </refsect1> |
73 | ||
c779b82a YW |
74 | <refsect1> |
75 | <title>Commands</title> | |
76 | <variablelist> | |
77 | ||
78 | <varlistentry> | |
79 | <term><option>status</option></term> | |
80 | ||
4eb5636b LP |
81 | <listitem><para>Shows brief information about the system firmware, the boot loader that was used to boot the |
82 | system, the boot loaders currently available in the ESP, the boot loaders listed in the firmware's list of boot | |
83 | loaders and the current default boot loader entry. If no command is specified, this is the implied | |
84 | default.</para></listitem> | |
c779b82a YW |
85 | </varlistentry> |
86 | ||
c779b82a | 87 | <varlistentry> |
4eb5636b | 88 | <term><option>install</option></term> |
c779b82a | 89 | |
4eb5636b LP |
90 | <listitem><para>Installs systemd-boot into the EFI system partition. A copy of <command>systemd-boot</command> |
91 | will be stored as the EFI default/fallback loader at | |
92 | <filename><replaceable>ESP</replaceable>/EFI/BOOT/BOOT*.EFI</filename>. The boot loader is then added to the | |
93 | top of the firmware's boot loader list.</para></listitem> | |
c779b82a YW |
94 | </varlistentry> |
95 | ||
96 | <varlistentry> | |
4eb5636b | 97 | <term><option>update</option></term> |
c779b82a | 98 | |
4eb5636b LP |
99 | <listitem><para>Updates all installed versions of |
100 | <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, if the | |
101 | available version is newer than the version installed in the EFI system partition. This also includes the EFI | |
102 | default/fallback loader at <filename><replaceable>ESP</replaceable>/EFI/BOOT/BOOT*.EFI</filename>. The boot | |
103 | loader is then added to end of the firmware's boot loader list if missing.</para></listitem> | |
c779b82a YW |
104 | </varlistentry> |
105 | ||
106 | <varlistentry> | |
107 | <term><option>remove</option></term> | |
108 | ||
4eb5636b LP |
109 | <listitem><para>Removes all installed versions of <command>systemd-boot</command> from the EFI system partition |
110 | and the firmware's boot loader list.</para></listitem> | |
c779b82a YW |
111 | </varlistentry> |
112 | ||
d88c96ff LP |
113 | <varlistentry> |
114 | <term><option>list</option></term> | |
115 | ||
116 | <listitem><para>Shows all available boot loader entries implementing the <ulink | |
a0848495 | 117 | url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader |
bd2865ca LP |
118 | Specification</ulink>, as well as any other entries discovered or automatically generated by the boot |
119 | loader.</para></listitem> | |
d88c96ff LP |
120 | </varlistentry> |
121 | ||
122 | <varlistentry> | |
123 | <term><option>set-default</option> <replaceable>ID</replaceable></term> | |
124 | <term><option>set-oneshot</option> <replaceable>ID</replaceable></term> | |
125 | ||
126 | <listitem><para>Sets the default boot loader entry. Takes a single boot loader entry ID string as argument. The | |
127 | <option>set-oneshot</option> command will set the default entry only for the next boot, the | |
128 | <option>set-default</option> will set it persistently for all future boots.</para></listitem> | |
129 | </varlistentry> | |
130 | ||
c779b82a YW |
131 | </variablelist> |
132 | </refsect1> | |
133 | ||
798d3a52 ZJS |
134 | <refsect1> |
135 | <title>Exit status</title> | |
c779b82a | 136 | <para>On success, 0 is returned, a non-zero failure code otherwise.</para> |
798d3a52 ZJS |
137 | </refsect1> |
138 | ||
8cbb7d87 LP |
139 | <refsect1> |
140 | <title>Environment</title> | |
141 | <para>If <varname>$SYSTEMD_RELAX_ESP_CHECKS=1</varname> is set the validation checks for the ESP are relaxed, and | |
142 | the path specified with <option>--path=</option> may refer to any kind of file system on any kind of | |
143 | partition.</para> | |
144 | </refsect1> | |
145 | ||
798d3a52 ZJS |
146 | <refsect1> |
147 | <title>See Also</title> | |
148 | <para> | |
70c8db75 | 149 | <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, |
a0848495 | 150 | <ulink url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader Specification</ulink>, |
2fe82132 | 151 | <ulink url="https://systemd.io/BOOT_LOADER_INTERFACE">Boot Loader Interface</ulink> |
798d3a52 ZJS |
152 | </para> |
153 | </refsect1> | |
1bc64d77 | 154 | </refentry> |