final v236 update (#7649)

[thirdparty/systemd.git] / man / bootctl.xml

<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  SPDX-License-Identifier: LGPL-2.1+

  This file is part of systemd.

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="bootctl" conditional='ENABLE_EFI'
    xmlns:xi="http://www.w3.org/2001/XInclude">
  <refentryinfo>
    <title>bootctl</title>
    <productname>systemd</productname>

    <authorgroup>
      <author>
        <contrib>Developer</contrib>
        <firstname>Kay</firstname>
        <surname>Sievers</surname>
        <email>kay@vrfy.org</email>
      </author>
    </authorgroup>
  </refentryinfo>

  <refmeta>
    <refentrytitle>bootctl</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>bootctl</refname>
    <refpurpose>Control the firmware and boot manager settings</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> status</command>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> list</command>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> update</command>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> install</command>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> remove</command>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><command>bootctl</command> checks, updates,
    installs or removes the boot loader from the current
    system.</para>

    <para><command>bootctl status</command> checks and prints the
    currently installed versions of the boot loader binaries and
    all current EFI boot variables.</para>

    <para><command>bootctl list</command> displays all configured boot loader entries.
    </para>

    <para><command>bootctl update</command> updates all installed versions of systemd-boot, if the current version is
    newer than the version installed in the EFI system partition. This also includes the EFI default/fallback loader at
    <filename>/EFI/BOOT/BOOT*.EFI</filename>. A systemd-boot entry in the EFI boot variables is created if there is no
    current entry. The created entry will be added to the end of the boot order list.</para>

    <para><command>bootctl install</command> installs systemd-boot into the EFI system partition. A copy of
    systemd-boot will be stored as the EFI default/fallback loader at <filename>/EFI/BOOT/BOOT*.EFI</filename>. A
    systemd-boot entry in the EFI boot variables is created and added to the top of the boot order list.</para>

    <para><command>bootctl remove</command> removes all installed
    versions of systemd-boot from the EFI system partition, and removes
    systemd-boot from the EFI boot variables.</para>

    <para>If no command is passed, <command>status</command> is
    implied.</para>
  </refsect1>

  <refsect1>
    <title>Options</title>
    <para>The following options are understood:</para>

    <variablelist>
      <xi:include href="standard-options.xml" xpointer="help" />
      <xi:include href="standard-options.xml" xpointer="version" />
      <varlistentry>
        <term><option>--path=</option></term>
        <listitem><para>Path to the EFI System Partition (ESP). If not specified, <filename>/efi</filename>,
        <filename>/boot</filename>, and <filename>/boot/efi</filename> are checked in turn.  It is recommended to mount
        the ESP to <filename>/boot</filename>, if possible.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-p</option></term>
        <term><option>--print-path</option></term>
        <listitem><para>This option modifies the behaviour of <command>status</command>.
        Just print the path to the EFI System Partition (ESP) to standard output and
        exit.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--no-variables</option></term>
        <listitem><para>Do not touch the EFI boot variables.</para></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Exit status</title>
    <para>On success, 0 is returned, a non-zero failure
    code otherwise.</para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <ulink url="https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot loader specification</ulink>
      <ulink url="https://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">systemd boot loader interface</ulink>
    </para>
  </refsect1>
</refentry>