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   This file is part of systemd.
   7
   8   systemd is free software; you can redistribute it and/or modify it
   9   under the terms of the GNU Lesser General Public License as published by
  10   the Free Software Foundation; either version 2.1 of the License, or
  11   (at your option) any later version.
  12
  13   systemd is distributed in the hope that it will be useful, but
  14   WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16   Lesser General Public License for more details.
  17
  18   You should have received a copy of the GNU Lesser General Public License
  19   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  20 -->
  21
  22 <refentry id="bootctl" conditional='ENABLE_EFI'
  23     xmlns:xi="http://www.w3.org/2001/XInclude">
  24   <refentryinfo>
  25     <title>bootctl</title>
  26     <productname>systemd</productname>
  27
  28     <authorgroup>
  29       <author>
  30         <contrib>Developer</contrib>
  31         <firstname>Kay</firstname>
  32         <surname>Sievers</surname>
  33         <email>kay@vrfy.org</email>
  34       </author>
  35     </authorgroup>
  36   </refentryinfo>
  37
  38   <refmeta>
  39     <refentrytitle>bootctl</refentrytitle>
  40     <manvolnum>1</manvolnum>
  41   </refmeta>
  42
  43   <refnamediv>
  44     <refname>bootctl</refname>
  45     <refpurpose>Control the firmware and boot manager settings</refpurpose>
  46   </refnamediv>
  47
  48   <refsynopsisdiv>
  49     <cmdsynopsis>
  50       <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg>status</command>
  51     </cmdsynopsis>
  52     <cmdsynopsis>
  53       <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg>update</command>
  54     </cmdsynopsis>
  55     <cmdsynopsis>
  56       <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg>install</command>
  57     </cmdsynopsis>
  58     <cmdsynopsis>
  59       <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg>remove</command>
  60     </cmdsynopsis>
  61   </refsynopsisdiv>
  62
  63   <refsect1>
  64     <title>Description</title>
  65
  66     <para><command>bootctl</command> checks, updates,
  67     installs or removes the boot loader from the current
  68     system.</para>
  69
  70     <para><command>bootctl status</command> checks and prints the
  71     currently installed versions of the boot loader binaries and the
  72     all current EFI boot variables.</para>
  73
  74     <para><command>bootctl update</command> updates all installed
  75     versions of systemd-boot, if the current version is newer than the
  76     version installed in the EFI system partition. This also includes
  77     the EFI default/fallback loader at /EFI/Boot/boot*.efi. A
  78     systemd-boot entry in the EFI boot variables is created, if there
  79     is no current entry. The created entry will be added to the end of
  80     the boot order list.</para>
  81
  82     <para><command>bootctl install</command> installs systemd-boot into
  83     the EFI system partition. A copy of systemd-boot will be stored as
  84     the EFI default/fallback loader at /EFI/Boot/boot*.efi. A systemd-boot
  85     entry in the EFI boot variables is created and added to the top
  86     of the boot order list.</para>
  87
  88     <para><command>bootctl remove</command> removes all installed
  89     versions of systemd-boot from the EFI system partition, and removes
  90     systemd-boot from the EFI boot variables.</para>
  91
  92     <para>If no command is passed <command>status</command> is
  93     implied.</para>
  94   </refsect1>
  95
  96   <refsect1>
  97     <title>Options</title>
  98     <para>The following options are understood:</para>
  99
 100     <variablelist>
 101       <xi:include href="standard-options.xml" xpointer="help" />
 102       <xi:include href="standard-options.xml" xpointer="version" />
 103       <varlistentry>
 104         <term><option>--path</option></term>
 105         <listitem><para>Path to the EFI system partition. The default is /boot.</para></listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109         <term><option>--no-variables</option></term>
 110         <listitem><para>Do not touch the EFI boot variables.</para></listitem>
 111       </varlistentry>
 112     </variablelist>
 113   </refsect1>
 114
 115   <refsect1>
 116     <title>Exit status</title>
 117     <para>On success 0 is returned, a non-zero failure
 118     code otherwise.</para>
 119   </refsect1>
 120
 121   <refsect1>
 122     <title>See Also</title>
 123     <para>
 124       <ulink url="http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot loader specification</ulink>
 125       <ulink url="http://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Systemd boot loader interface</ulink>
 126     </para>
 127   </refsect1>
 128 </refentry>