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</command>
  29       <arg choice="opt" rep="repeat">OPTIONS</arg>
  30       <arg choice="req">COMMAND</arg>
  31     </cmdsynopsis>
  32   </refsynopsisdiv>
  33
  34   <refsect1>
  35     <title>Description</title>
  36
  37     <para><command>bootctl</command> can check the EFI boot loader status, list available boot loaders and boot loader
  38     entries, and install, update, or remove the
  39     <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry> boot loader on the
  40     current system.</para>
  41   </refsect1>
  42
  43   <refsect1>
  44     <title>Options</title>
  45     <para>The following options are understood:</para>
  46
  47     <variablelist>
  48       <varlistentry>
  49         <term><option>--path=</option></term>
  50         <listitem><para>Path to the EFI System Partition (ESP). If not specified, <filename>/efi</filename>,
  51         <filename>/boot</filename>, and <filename>/boot/efi</filename> are checked in turn.  It is recommended to mount
  52         the ESP to <filename>/boot</filename>, if possible.</para></listitem>
  53       </varlistentry>
  54
  55       <varlistentry>
  56         <term><option>-p</option></term>
  57         <term><option>--print-path</option></term>
  58         <listitem><para>This option modifies the behaviour of <command>status</command>.
  59         Just print the path to the EFI System Partition (ESP) to standard output and
  60         exit.</para></listitem>
  61       </varlistentry>
  62
  63       <varlistentry>
  64         <term><option>--no-variables</option></term>
  65         <listitem><para>Do not touch the firmware's boot loader list stored in EFI variables.</para></listitem>
  66       </varlistentry>
  67
  68       <xi:include href="standard-options.xml" xpointer="no-pager"/>
  69       <xi:include href="standard-options.xml" xpointer="help"/>
  70       <xi:include href="standard-options.xml" xpointer="version"/>
  71     </variablelist>
  72   </refsect1>
  73
  74   <refsect1>
  75     <title>Commands</title>
  76     <variablelist>
  77
  78       <varlistentry>
  79         <term><option>status</option></term>
  80
  81         <listitem><para>Shows brief information about the system firmware, the boot loader that was used to boot the
  82         system, the boot loaders currently available in the ESP, the boot loaders listed in the firmware's list of boot
  83         loaders and the current default boot loader entry. If no command is specified, this is the implied
  84         default.</para></listitem>
  85       </varlistentry>
  86
  87       <varlistentry>
  88         <term><option>list</option></term>
  89
  90         <listitem><para>Shows all available boot loader entries implementing the <ulink
  91         url="https://github.com/systemd/systemd/blob/master/docs/BOOT_LOADER_SPECIFICATION.md">Boot Loader
  92         Specification</ulink>.</para></listitem>
  93       </varlistentry>
  94
  95       <varlistentry>
  96         <term><option>install</option></term>
  97
  98         <listitem><para>Installs systemd-boot into the EFI system partition. A copy of <command>systemd-boot</command>
  99         will be stored as the EFI default/fallback loader at
 100         <filename><replaceable>ESP</replaceable>/EFI/BOOT/BOOT*.EFI</filename>. The boot loader is then added to the
 101         top of the firmware's boot loader list.</para></listitem>
 102       </varlistentry>
 103
 104       <varlistentry>
 105         <term><option>update</option></term>
 106
 107         <listitem><para>Updates all installed versions of
 108         <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, if the
 109         available version is newer than the version installed in the EFI system partition. This also includes the EFI
 110         default/fallback loader at <filename><replaceable>ESP</replaceable>/EFI/BOOT/BOOT*.EFI</filename>. The boot
 111         loader is then added to end of the firmware's boot loader list if missing.</para></listitem>
 112       </varlistentry>
 113
 114       <varlistentry>
 115         <term><option>remove</option></term>
 116
 117         <listitem><para>Removes all installed versions of <command>systemd-boot</command> from the EFI system partition
 118         and the firmware's boot loader list.</para></listitem>
 119       </varlistentry>
 120
 121     </variablelist>
 122   </refsect1>
 123
 124   <refsect1>
 125     <title>Exit status</title>
 126     <para>On success, 0 is returned, a non-zero failure code otherwise.</para>
 127   </refsect1>
 128
 129   <refsect1>
 130     <title>Environment</title>
 131     <para>If <varname>$SYSTEMD_RELAX_ESP_CHECKS=1</varname> is set the validation checks for the ESP are relaxed, and
 132     the path specified with <option>--path=</option> may refer to any kind of file system on any kind of
 133     partition.</para>
 134   </refsect1>
 135
 136   <refsect1>
 137     <title>See Also</title>
 138     <para>
 139       <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
 140       <ulink url="https://github.com/systemd/systemd/blob/master/docs/BOOT_LOADER_SPECIFICATION.md">Boot Loader Specification</ulink>,
 141       <ulink url="https://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Boot Loader Interface</ulink>
 142     </para>
 143   </refsect1>
 144 </refentry>