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