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
   9 <refentry id="bootctl" conditional='ENABLE_EFI'
  10     xmlns:xi="http://www.w3.org/2001/XInclude">
  11   <refentryinfo>
  12     <title>bootctl</title>
  13     <productname>systemd</productname>
  14
  15     <authorgroup>
  16       <author>
  17         <contrib>Developer</contrib>
  18         <firstname>Kay</firstname>
  19         <surname>Sievers</surname>
  20         <email>kay@vrfy.org</email>
  21       </author>
  22     </authorgroup>
  23   </refentryinfo>
  24
  25   <refmeta>
  26     <refentrytitle>bootctl</refentrytitle>
  27     <manvolnum>1</manvolnum>
  28   </refmeta>
  29
  30   <refnamediv>
  31     <refname>bootctl</refname>
  32     <refpurpose>Control the firmware and boot manager settings</refpurpose>
  33   </refnamediv>
  34
  35   <refsynopsisdiv>
  36     <cmdsynopsis>
  37       <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> status</command>
  38     </cmdsynopsis>
  39     <cmdsynopsis>
  40       <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> list</command>
  41     </cmdsynopsis>
  42     <cmdsynopsis>
  43       <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> update</command>
  44     </cmdsynopsis>
  45     <cmdsynopsis>
  46       <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> install</command>
  47     </cmdsynopsis>
  48     <cmdsynopsis>
  49       <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg> remove</command>
  50     </cmdsynopsis>
  51   </refsynopsisdiv>
  52
  53   <refsect1>
  54     <title>Description</title>
  55
  56     <para><command>bootctl</command> can check the EFI boot loader status, list
  57     available entries, and install, update, or remove the
  58     <citerefentry><refentrytitle>sd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  59     boot loader on the current system.</para>
  60
  61     <para><command>bootctl status</command> shows the currently installed versions of
  62     the boot loader binaries and all current EFI boot variables.</para>
  63
  64     <para><command>bootctl list</command> displays all configured boot loader entries.
  65     </para>
  66
  67     <para><command>bootctl update</command> updates all installed versions of
  68     <citerefentry><refentrytitle>sd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
  69     if the current version is newer than the version installed in the EFI system
  70     partition. This also includes the EFI default/fallback loader at
  71     <filename><replaceable>ESP</replaceable>/EFI/BOOT/BOOT*.EFI</filename>. A
  72     systemd-boot entry in the EFI boot variables is created if there is no current
  73     entry. The created entry will be added to the end of the boot order list.</para>
  74
  75     <para><command>bootctl install</command> installs systemd-boot into the EFI
  76     system partition. A copy of systemd-boot will be stored as the EFI
  77     default/fallback loader at
  78     <filename><replaceable>ESP</replaceable>/EFI/BOOT/BOOT*.EFI</filename>. A
  79     systemd-boot entry in the EFI boot variables is created and added to the top of
  80     the boot order list.</para>
  81
  82     <para><command>bootctl remove</command> removes all installed versions of
  83     systemd-boot from the EFI system partition, and removes systemd-boot from the EFI
  84     boot variables.</para>
  85
  86     <para>If no command is passed, <command>status</command> is implied.</para>
  87   </refsect1>
  88
  89   <refsect1>
  90     <title>Options</title>
  91     <para>The following options are understood:</para>
  92
  93     <variablelist>
  94       <xi:include href="standard-options.xml" xpointer="help" />
  95       <xi:include href="standard-options.xml" xpointer="version" />
  96       <varlistentry>
  97         <term><option>--path=</option></term>
  98         <listitem><para>Path to the EFI System Partition (ESP). If not specified, <filename>/efi</filename>,
  99         <filename>/boot</filename>, and <filename>/boot/efi</filename> are checked in turn.  It is recommended to mount
 100         the ESP to <filename>/boot</filename>, if possible.</para></listitem>
 101       </varlistentry>
 102
 103       <varlistentry>
 104         <term><option>-p</option></term>
 105         <term><option>--print-path</option></term>
 106         <listitem><para>This option modifies the behaviour of <command>status</command>.
 107         Just print the path to the EFI System Partition (ESP) to standard output and
 108         exit.</para></listitem>
 109       </varlistentry>
 110
 111       <varlistentry>
 112         <term><option>--no-variables</option></term>
 113         <listitem><para>Do not touch the EFI boot variables.</para></listitem>
 114       </varlistentry>
 115     </variablelist>
 116   </refsect1>
 117
 118   <refsect1>
 119     <title>Exit status</title>
 120     <para>On success, 0 is returned, a non-zero failure
 121     code otherwise.</para>
 122   </refsect1>
 123
 124   <refsect1>
 125     <title>See Also</title>
 126     <para>
 127       <citerefentry><refentrytitle>sd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
 128       <ulink url="https://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot Loader Specification</ulink>,
 129       <ulink url="https://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Boot Loader Interface</ulink>
 130     </para>
 131   </refsect1>
 132 </refentry>