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
  25   <refentryinfo>
  26     <title>bootctl</title>
  27     <productname>systemd</productname>
  28
  29     <authorgroup>
  30       <author>
  31         <contrib>Developer</contrib>
  32         <firstname>Kay</firstname>
  33         <surname>Sievers</surname>
  34         <email>kay@vrfy.org</email>
  35       </author>
  36     </authorgroup>
  37   </refentryinfo>
  38
  39   <refmeta>
  40     <refentrytitle>bootctl</refentrytitle>
  41     <manvolnum>1</manvolnum>
  42   </refmeta>
  43
  44   <refnamediv>
  45     <refname>bootctl</refname>
  46     <refpurpose>Control the firmware and boot manager settings</refpurpose>
  47   </refnamediv>
  48
  49   <refsynopsisdiv>
  50     <cmdsynopsis>
  51       <command>bootctl</command>
  52       <arg choice="opt" rep="repeat">OPTIONS</arg>
  53       <arg choice="req">COMMAND</arg>
  54     </cmdsynopsis>
  55   </refsynopsisdiv>
  56
  57   <refsect1>
  58     <title>Description</title>
  59
  60     <para><command>bootctl</command> may be used to query or (in the
  61     future) change the firmware and boot manager settings.</para>
  62
  63     <para>Firmware information is available only on EFI systems.
  64     </para>
  65
  66     <para>Currently, only the
  67     <citerefentry project='gummiboot'><refentrytitle>gummiboot</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  68     boot manager implements the required boot loader interface to
  69     provide complete boot manager information.</para>
  70   </refsect1>
  71
  72   <refsect1>
  73     <title>Options</title>
  74
  75     <para>The following options are understood:</para>
  76
  77     <variablelist>
  78       <xi:include href="standard-options.xml" xpointer="help" />
  79       <xi:include href="standard-options.xml" xpointer="version" />
  80     </variablelist>
  81
  82     <para>The following commands are understood:</para>
  83
  84     <variablelist>
  85       <varlistentry>
  86         <term><command>status</command></term>
  87
  88         <listitem><para>Show firmware and boot manager information
  89         about the system, including secure boot mode status and
  90         selected firmware entry (where available).</para></listitem>
  91       </varlistentry>
  92     </variablelist>
  93
  94   </refsect1>
  95
  96   <refsect1>
  97     <title>Exit status</title>
  98
  99     <para>On success, 0 is returned, a non-zero failure code
 100     otherwise.</para>
 101   </refsect1>
 102
 103   <refsect1>
 104     <title>See Also</title>
 105     <para>
 106       <ulink url="http://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Boot loader interface</ulink>,
 107       <ulink url="http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot loader specification</ulink>,
 108       <ulink url="http://www.freedesktop.org/wiki/Software/gummiboot/">gummiboot</ulink>
 109     </para>
 110   </refsect1>
 111
 112 </refentry>