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 <!ENTITY % entities SYSTEM "custom-entities.ent" >
   5 %entities;
   6 ]>
   7
   8 <!--
   9   This file is part of systemd.
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 -->
  24
  25 <refentry id="bootctl" conditional='ENABLE_EFI'
  26     xmlns:xi="http://www.w3.org/2001/XInclude">
  27   <refentryinfo>
  28     <title>bootctl</title>
  29     <productname>systemd</productname>
  30
  31     <authorgroup>
  32       <author>
  33         <contrib>Developer</contrib>
  34         <firstname>Kay</firstname>
  35         <surname>Sievers</surname>
  36         <email>kay@vrfy.org</email>
  37       </author>
  38     </authorgroup>
  39   </refentryinfo>
  40
  41   <refmeta>
  42     <refentrytitle>bootctl</refentrytitle>
  43     <manvolnum>1</manvolnum>
  44   </refmeta>
  45
  46   <refnamediv>
  47     <refname>bootctl</refname>
  48     <refpurpose>Control the firmware and boot manager settings</refpurpose>
  49   </refnamediv>
  50
  51   <refsynopsisdiv>
  52     <cmdsynopsis>
  53       <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg>status</command>
  54     </cmdsynopsis>
  55     <cmdsynopsis>
  56       <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg>update</command>
  57     </cmdsynopsis>
  58     <cmdsynopsis>
  59       <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg>install</command>
  60     </cmdsynopsis>
  61     <cmdsynopsis>
  62       <command>bootctl <arg choice="opt" rep="repeat">OPTIONS</arg>remove</command>
  63     </cmdsynopsis>
  64   </refsynopsisdiv>
  65
  66   <refsect1>
  67     <title>Description</title>
  68
  69     <para><command>bootctl</command> checks, updates,
  70     installs or removes the boot loader from the current
  71     system.</para>
  72
  73     <para><command>bootctl status</command> checks and prints the
  74     currently installed versions of the boot loader binaries and the
  75     all current EFI boot variables.</para>
  76
  77     <para><command>bootctl update</command> updates all installed
  78     versions of systemd-boot, if the current version is newer than the
  79     version installed in the EFI system partition. This also includes
  80     the EFI default/fallback loader at /EFI/Boot/boot*.efi. A
  81     systemd-boot entry in the EFI boot variables is created, if there
  82     is no current entry. The created entry will be added to the end of
  83     the boot order list.</para>
  84
  85     <para><command>bootctl install</command> installs systemd-boot into
  86     the EFI system partition. A copy of systemd-boot will be stored as
  87     the EFI default/fallback loader at /EFI/Boot/boot*.efi. A systemd-boot
  88     entry in the EFI boot variables is created and added to the top
  89     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. The default is /boot.</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       <ulink url="http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot loader specification</ulink>
 128       <ulink url="http://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Systemd boot loader interface</ulink>
 129     </para>
 130   </refsect1>
 131 </refentry>