<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
-<refentry id="bootctl" conditional='ENABLE_BOOTLOADER'
+<refentry id="bootctl"
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>bootctl</title>
specified, this is the implied default.</para>
<para>See the example below for details of the output.</para>
+
+ <xi:include href="version-info.xml" xpointer="v239"/>
</listitem>
</varlistentry>
<para>Hint: use <command>systemctl reboot --firmware-setup</command> to reboot into firmware setup
once. See
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
- for details.</para></listitem>
+ for details.</para>
+
+ <xi:include href="version-info.xml" xpointer="v251"/></listitem>
</varlistentry>
</variablelist>
</refsect1>
JSON output may be requested with <option>--json=</option>.</para>
<para>See the example below for details of the output.</para>
+
+ <xi:include href="version-info.xml" xpointer="v239"/>
</listitem>
</varlistentry>
<listitem><para>Removes a boot loader entry including the files it refers to. Takes a single boot
loader entry ID string or a glob pattern as argument. Referenced files such as kernel or initrd are
- only removed if no other entry refers to them.</para></listitem>
+ only removed if no other entry refers to them.</para>
+
+ <xi:include href="version-info.xml" xpointer="v253"/></listitem>
</varlistentry>
<varlistentry>
<term><option>cleanup</option></term>
<listitem><para>Removes files from the ESP and XBOOTLDR partitions that belong to the entry token but
- are not referenced in any boot loader entries.</para></listitem>
+ are not referenced in any boot loader entries.</para>
+
+ <xi:include href="version-info.xml" xpointer="v253"/></listitem>
</varlistentry>
</variablelist>
</refsect1>
<command>systemctl reboot --boot-loader-menu=<replaceable>timeout</replaceable></command>
to reboot into the boot loader menu once. See
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
- for details.</para></listitem>
+ for details.</para>
+
+ <xi:include href="version-info.xml" xpointer="v240"/></listitem>
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>
for details about the syntax of time spans.</para>
- <para>If this is set to <option>menu-hidden</option> or <option>0</option> no menu is shown and
- the default entry will be booted immediately, while setting this to <option>menu-force</option>
- disables the timeout while always showing the menu. When an empty string ("") is specified the
- bootloader will revert to its default menu timeout.</para></listitem>
+ <para>If this is set to <option>menu-disabled</option> or <option>menu-hidden</option> or
+ <option>0</option>, no menu is shown and the default entry will be booted immediately, while
+ setting this to <option>menu-force</option> disables the timeout while always showing the menu.
+ When an empty string ("") is specified the bootloader will revert to its default menu timeout.</para>
+
+ <xi:include href="version-info.xml" xpointer="v250"/></listitem>
</varlistentry>
</variablelist>
</refsect1>
<listitem><para>Installs <command>systemd-boot</command> into the EFI system partition. A copy of
<command>systemd-boot</command> will be stored as the EFI default/fallback loader at
<filename><replaceable>ESP</replaceable>/EFI/BOOT/BOOT*.EFI</filename>. The boot loader is then added
- to the top of the firmware's boot loader list.</para></listitem>
+ to the top of the firmware's boot loader list.</para>
+
+ <xi:include href="version-info.xml" xpointer="v239"/></listitem>
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, if the
available version is newer than the version installed in the EFI system partition. This also includes the EFI
default/fallback loader at <filename><replaceable>ESP</replaceable>/EFI/BOOT/BOOT*.EFI</filename>. The boot
- loader is then added to end of the firmware's boot loader list if missing.</para></listitem>
+ loader is then added to end of the firmware's boot loader list if missing.</para>
+
+ <xi:include href="version-info.xml" xpointer="v239"/></listitem>
</varlistentry>
<varlistentry>
<term><option>remove</option></term>
<listitem><para>Removes all installed versions of <command>systemd-boot</command> from the EFI system partition
- and the firmware's boot loader list.</para></listitem>
+ and the firmware's boot loader list.</para>
+
+ <xi:include href="version-info.xml" xpointer="v239"/></listitem>
</varlistentry>
<varlistentry>
<listitem><para>Checks whether <command>systemd-boot</command> is installed in the ESP. Note that a
single ESP might host multiple boot loaders; this hence checks whether
<command>systemd-boot</command> is one (of possibly many) installed boot loaders — and neither
- whether it is the default nor whether it is registered in any EFI variables.</para></listitem>
+ whether it is the default nor whether it is registered in any EFI variables.</para>
+
+ <xi:include href="version-info.xml" xpointer="v243"/></listitem>
</varlistentry>
<varlistentry>
<citerefentry><refentrytitle>systemd-boot-random-seed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
<para>See <ulink url="https://systemd.io/RANDOM_SEEDS">Random Seeds</ulink> for further
- information.</para></listitem>
+ information.</para>
+
+ <xi:include href="version-info.xml" xpointer="v243"/></listitem>
</varlistentry>
</variablelist>
<listitem><para>Takes a kernel image as argument. Checks what kind of kernel the image is. Returns
one of <literal>uki</literal>, <literal>pe</literal>, and <literal>unknown</literal>.
- </para></listitem>
+ </para>
+
+ <xi:include href="version-info.xml" xpointer="v253"/></listitem>
</varlistentry>
<varlistentry>
<term><option>kernel-inspect</option> <replaceable>kernel</replaceable></term>
- <listitem><para>Takes a kernel image as argument. Prints details about the image.</para></listitem>
+ <listitem><para>Takes a kernel image as argument. Prints details about the image.</para>
+
+ <xi:include href="version-info.xml" xpointer="v253"/></listitem>
</varlistentry>
</variablelist>
</refsect1>
<listitem><para>Takes a directory path as an argument. All
paths will be prefixed with the given alternate
<replaceable>root</replaceable> path, including config search
- paths. </para></listitem>
+ paths. </para>
+
+ <xi:include href="version-info.xml" xpointer="v252"/></listitem>
</varlistentry>
<varlistentry>
table, following the <ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions
Specification</ulink>. For further information on supported disk images, see
<citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
- switch of the same name.</para></listitem>
+ switch of the same name.</para>
+
+ <xi:include href="version-info.xml" xpointer="v252"/></listitem>
</varlistentry>
<xi:include href="standard-options.xml" xpointer="image-policy-open" />
(the default), <literal>image</literal> or <literal>host</literal>. With <literal>auto</literal>
binaries will be picked from the specified directory or image, and if not found they will be picked
from the host. With <literal>image</literal> or <literal>host</literal> no fallback search will be
- performed if the binaries are not found in the selected source.</para></listitem>
+ performed if the binaries are not found in the selected source.</para>
+
+ <xi:include href="version-info.xml" xpointer="v252"/></listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option></term>
<term><option>--print-esp-path</option></term>
<listitem><para>This option modifies the behaviour of <command>status</command>. Only prints the path
- to the EFI System Partition (ESP) to standard output and exits.</para></listitem>
+ to the EFI System Partition (ESP) to standard output and exits.</para>
+
+ <xi:include href="version-info.xml" xpointer="v236"/></listitem>
</varlistentry>
<varlistentry>
Specification Type #2 entries should be placed in the directory <literal>$(bootctl
-x)/EFI/Linux/</literal>.</para>
- <para>Note that this option (similarly to the <option>--print-boot-path</option> option mentioned
+ <para>Note that this option (similarly to the <option>--print-esp-path</option> option mentioned
above), is available independently from the boot loader used, i.e. also without
- <command>systemd-boot</command> being installed.</para></listitem>
+ <command>systemd-boot</command> being installed.</para>
+
+ <xi:include href="version-info.xml" xpointer="v242"/></listitem>
</varlistentry>
<varlistentry>
(e.g. <filename>/dev/nvme0n1</filename>). If the root file system is <literal>tmpfs</literal> (or a
similar in-memory file system), the block device backing <filename>/usr/</filename> is returned if
applicable. If the root file system is a network file system (e.g. NFS, CIFS) the operation will
- fail.</para></listitem>
+ fail.</para>
+
+ <xi:include href="version-info.xml" xpointer="v254"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-variables</option></term>
- <listitem><para>Do not touch the firmware's boot loader list stored in EFI variables.</para></listitem>
+ <listitem><para>Do not touch the firmware's boot loader list stored in EFI variables.</para>
+
+ <xi:include href="version-info.xml" xpointer="v220"/></listitem>
</varlistentry>
<varlistentry>
<listitem><para>Ignore failure when the EFI System Partition cannot be found, when EFI variables
cannot be written, or a different or newer boot loader is already installed. Currently only applies
to <command>is-installed</command>, <command>update</command>, and <command>random-seed</command>
- verbs.</para></listitem>
+ verbs.</para>
+
+ <xi:include href="version-info.xml" xpointer="v244"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--quiet</option></term>
<listitem><para>Suppress printing of the results of various commands and also the hints about ESP
- being unavailable.</para></listitem>
+ being unavailable.</para>
+
+ <xi:include href="version-info.xml" xpointer="v251"/></listitem>
</varlistentry>
<varlistentry>
entry token, as specified with <option>--entry-token=</option> parameter described below, and is
placed immediately below the <varname>$BOOT</varname> root directory (i.e. beneath the file system
returned by the <option>--print-boot-path</option> option, see above). Defaults to
- <literal>no</literal>.</para></listitem>
+ <literal>no</literal>.</para>
+
+ <xi:include href="version-info.xml" xpointer="v251"/></listitem>
</varlistentry>
<varlistentry>
on the same medium, and they can update their boot loader entries independently. When using another
identifier (such as the OS ID or the OS image ID), parallel installations of the same OS would try to
use the same entry name. To support parallel installations, the installer must use a different entry
- token when adding a second installation.</para></listitem>
+ token when adding a second installation.</para>
+
+ <xi:include href="version-info.xml" xpointer="v251"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--all-architectures</option></term>
- <listitem><para>Install binaries for all supported EFI architectures (this implies <option>--no-variables</option>).</para></listitem>
+ <listitem><para>Install binaries for all supported EFI architectures (this implies <option>--no-variables</option>).</para>
+
+ <xi:include href="version-info.xml" xpointer="v252"/></listitem>
</varlistentry>
<varlistentry>
found on the various disks installed in the system. Specifically distributions should not use this flag
to install a branded entry in the boot option list. However in situations with multiple disks, each with
their own ESP partition, it can be beneficial to make it easier to identify the bootloader being used in
- the firmware's boot option menu.</para></listitem>
+ the firmware's boot option menu.</para>
+
+ <xi:include href="version-info.xml" xpointer="v252"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--dry-run</option></term>
- <listitem><para>Dry run for <option>--unlink</option> and <option>--cleanup</option>.</para>
+ <listitem><para>Dry run for <option>unlink</option> and <option>cleanup</option>.</para>
<para>In dry run mode, the unlink and cleanup operations only print the files that would get deleted
- without actually deleting them.</para></listitem>
+ without actually deleting them.</para>
+
+ <xi:include href="version-info.xml" xpointer="v253"/></listitem>
</varlistentry>
<xi:include href="standard-options.xml" xpointer="no-pager"/>
✓ Support for passing random seed to OS
✓ Load drop-in drivers
✓ Boot loader sets ESP information
+ ✓ Menu can be disabled
ESP: /dev/disk/by-partuuid/01234567-89ab-cdef-dead-beef00000000
File: └─/EFI/systemd/systemd-bootx64.efi
<refsect1>
<title>See Also</title>
- <para>
- <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
- <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink>,
- <ulink url="https://systemd.io/BOOT_LOADER_INTERFACE">Boot Loader Interface</ulink>,
- <citerefentry><refentrytitle>systemd-boot-random-seed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
- </para>
+ <para><simplelist type="inline">
+ <member><citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
+ <member><ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink></member>
+ <member><ulink url="https://systemd.io/BOOT_LOADER_INTERFACE">Boot Loader Interface</ulink></member>
+ <member><citerefentry><refentrytitle>systemd-boot-random-seed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
+ </simplelist></para>
</refsect1>
</refentry>
projects / thirdparty / systemd.git / blobdiff