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
  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</command>
  51                         <arg choice="opt" rep="repeat">OPTIONS</arg>
  52                         <arg choice="req">COMMAND</arg>
  53                 </cmdsynopsis>
  54         </refsynopsisdiv>
  55
  56         <refsect1>
  57                 <title>Description</title>
  58
  59                 <para><command>bootctl</command> may be used to
  60                 query or (in the future) change the firmware and boot
  61                 manager settings.</para>
  62
  63                 <para>Firmware information is available only on EFI
  64                 systems.</para>
  65
  66                 <para>Currently, only the <citerefentry><refentrytitle>gummiboot</refentrytitle><manvolnum>8</manvolnum></citerefentry> boot
  67                 manager implements the required boot loader interface
  68                 to provide complete boot manager information.</para>
  69         </refsect1>
  70
  71         <refsect1>
  72                 <title>Options</title>
  73
  74                 <para>The following options are understood:</para>
  75
  76                 <variablelist>
  77                         <varlistentry>
  78                                 <term><option>-h</option></term>
  79                                 <term><option>--help</option></term>
  80
  81                                 <listitem><para>Prints a short help
  82                                 text and exits.</para></listitem>
  83                         </varlistentry>
  84
  85                         <varlistentry>
  86                                 <term><option>--version</option></term>
  87
  88                                 <listitem><para>Prints a short version
  89                                 string and exits.</para></listitem>
  90                         </varlistentry>
  91                 </variablelist>
  92
  93                 <para>The following commands are understood:</para>
  94
  95                 <variablelist>
  96                         <varlistentry>
  97                                 <term><command>status</command></term>
  98
  99                                 <listitem><para>Show firmware and boot
 100                                 manager information about the system,
 101                                 including secure boot mode status and
 102                                 selected firmware entry (where
 103                                 available).</para></listitem>
 104                         </varlistentry>
 105                 </variablelist>
 106
 107         </refsect1>
 108
 109         <refsect1>
 110                 <title>Exit status</title>
 111
 112                 <para>On success, 0 is returned, a non-zero failure
 113                 code otherwise.</para>
 114         </refsect1>
 115
 116         <refsect1>
 117                 <title>See Also</title>
 118                 <para>
 119                         <ulink url="http://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Boot loader interface</ulink>,
 120                         <ulink url="http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot loader specification</ulink>,
 121                         <ulink url="http://www.freedesktop.org/wiki/Software/gummiboot/">gummiboot</ulink>
 122                 </para>
 123         </refsect1>
 124
 125 </refentry>