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> list</command>
  56     </cmdsynopsis>
  57     <cmdsynopsis>
  58       <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> update</command>
  59     </cmdsynopsis>
  60     <cmdsynopsis>
  61       <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> install</command>
  62     </cmdsynopsis>
  63     <cmdsynopsis>
  64       <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> remove</command>
  65     </cmdsynopsis>
  66   </refsynopsisdiv>
  67
  68   <refsect1>
  69     <title>Description</title>
  70
  71     <para><command>bootctl</command> checks, updates,
  72     installs or removes the boot loader from the current
  73     system.</para>
  74
  75     <para><command>bootctl status</command> checks and prints the
  76     currently installed versions of the boot loader binaries and
  77     all current EFI boot variables.</para>
  78
  79     <para><command>bootctl list</command> displays all configured boot loader entries.
  80     </para>
  81
  82     <para><command>bootctl update</command> updates all installed versions of systemd-boot, if the current version is
  83     newer than the version installed in the EFI system partition. This also includes the EFI default/fallback loader at
  84     <filename>/EFI/BOOT/BOOT*.EFI</filename>. A systemd-boot entry in the EFI boot variables is created if there is no
  85     current entry. The created entry will be added to the end of the boot order list.</para>
  86
  87     <para><command>bootctl install</command> installs systemd-boot into the EFI system partition. A copy of
  88     systemd-boot will be stored as the EFI default/fallback loader at <filename>/EFI/BOOT/BOOT*.EFI</filename>. A
  89     systemd-boot entry in the EFI boot variables is created and added to the top of the boot order list.</para>
  90
  91     <para><command>bootctl remove</command> removes all installed
  92     versions of systemd-boot from the EFI system partition, and removes
  93     systemd-boot from the EFI boot variables.</para>
  94
  95     <para>If no command is passed, <command>status</command> is
  96     implied.</para>
  97   </refsect1>
  98
  99   <refsect1>
 100     <title>Options</title>
 101     <para>The following options are understood:</para>
 102
 103     <variablelist>
 104       <xi:include href="standard-options.xml" xpointer="help" />
 105       <xi:include href="standard-options.xml" xpointer="version" />
 106       <varlistentry>
 107         <term><option>--path=</option></term>
 108         <listitem><para>Path to the EFI System Partition (ESP). If not specified, <filename>/efi</filename>,
 109         <filename>/boot</filename>, and <filename>/boot/efi</filename> are checked in turn.  It is recommended to mount
 110         the ESP to <filename>/boot</filename>, if possible.</para></listitem>
 111       </varlistentry>
 112
 113       <varlistentry>
 114         <term><option>-p</option></term>
 115         <term><option>--print-path</option></term>
 116         <listitem><para>This option modifies the behaviour of <command>status</command>.
 117         Just print the path to the EFI System Partition (ESP) to standard output and
 118         exit.</para></listitem>
 119       </varlistentry>
 120
 121       <varlistentry>
 122         <term><option>--no-variables</option></term>
 123         <listitem><para>Do not touch the EFI boot variables.</para></listitem>
 124       </varlistentry>
 125     </variablelist>
 126   </refsect1>
 127
 128   <refsect1>
 129     <title>Exit status</title>
 130     <para>On success, 0 is returned, a non-zero failure
 131     code otherwise.</para>
 132   </refsect1>
 133
 134   <refsect1>
 135     <title>See Also</title>
 136     <para>
 137       <ulink url="https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot loader specification</ulink>
 138       <ulink url="https://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">systemd boot loader interface</ulink>
 139     </para>
 140   </refsect1>
 141 </refentry>