From 30712bf9c2baefc73ce110854c40be354a60bd78 Mon Sep 17 00:00:00 2001

From: Marko Myllynen <myllynen@redhat.com>

Date: Wed, 13 Nov 2013 11:06:13 +0200

Subject: [PATCH] man: add bootctl(8)

https://bugzilla.redhat.com/show_bug.cgi?id=1014303

---

 Makefile-man.am |   9 ++++

 man/bootctl.xml | 125 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++

 2 files changed, 134 insertions(+)

 create mode 100644 man/bootctl.xml

diff --git a/Makefile-man.am b/Makefile-man.am

index b8c8acc..3f626e8 100644

--- a/Makefile-man.am

+++ b/Makefile-man.am

@@ -650,6 +650,15 @@ MANPAGES_ALIAS += \

 endif

+if ENABLE_EFI

+MANPAGES += \

+	man/bootctl.1

+MANPAGES_ALIAS += \

+	#

+

+

+endif

+

 if ENABLE_HOSTNAMED

 MANPAGES += \

 	man/hostnamectl.1 \

diff --git a/man/bootctl.xml b/man/bootctl.xml

new file mode 100644

index 0000000..28f1b92

--- /dev/null

+++ b/man/bootctl.xml

@@ -0,0 +1,125 @@

+ 

+

+        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

+

+

+  This file is part of systemd.

+

+  systemd is free software; you can redistribute it and/or modify it

+  under the terms of the GNU Lesser General Public License as published by

+  the Free Software Foundation; either version 2.1 of the License, or

+  (at your option) any later version.

+

+  systemd is distributed in the hope that it will be useful, but

+  WITHOUT ANY WARRANTY; without even the implied warranty of

+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

+  Lesser General Public License for more details.

+

+  You should have received a copy of the GNU Lesser General Public License

+  along with systemd; If not, see <http://www.gnu.org/licenses/>.

+-->

+

+<refentry id="bootctl" conditional='ENABLE_EFI'>

+

+        <refentryinfo>

+                <title>bootctl</title>

+                <productname>systemd</productname>

+

+                <authorgroup>

+                        <author>

+                                <contrib>Developer</contrib>

+                                <firstname>Kay</firstname>

+                                <surname>Sievers</surname>

+                                <email>kay@vrfy.org</email>

+                        </author>

+                </authorgroup>

+        </refentryinfo>

+

+        <refmeta>

+                <refentrytitle>bootctl</refentrytitle>

+                <manvolnum>1</manvolnum>

+        </refmeta>

+

+        <refnamediv>

+                <refname>bootctl</refname>

+                <refpurpose>Control the firmware and boot manager settings</refpurpose>

+        </refnamediv>

+

+        <refsynopsisdiv>

+                <cmdsynopsis>

+                        <command>bootctl</command>

+                        <arg choice="opt" rep="repeat">OPTIONS</arg>

+                        <arg choice="req">COMMAND</arg>

+                </cmdsynopsis>

+        </refsynopsisdiv>

+

+        <refsect1>

+                <title>Description</title>

+

+                <para><command>bootctl</command> may be used to

+                query or (in the future) change the firmware and boot

+                manager settings.</para>

+

+                <para>Firmware information is available only on EFI

+                systems.</para>

+

+                <para>Currently, only the <citerefentry><refentrytitle>gummiboot</refentrytitle><manvolnum>8</manvolnum></citerefentry> boot

+                manager implements the required boot loader interface

+                to provide complete boot manager information.</para>

+        </refsect1>

+

+        <refsect1>

+                <title>Options</title>

+

+                <para>The following options are understood:</para>

+

+                <variablelist>

+                        <varlistentry>

+                                <term><option>-h</option></term>

+                                <term><option>--help</option></term>

+

+                                <listitem><para>Prints a short help

+                                text and exits.</para></listitem>

+                        </varlistentry>

+

+                        <varlistentry>

+                                <term><option>--version</option></term>

+

+                                <listitem><para>Prints a short version

+                                string and exits.</para></listitem>

+                        </varlistentry>

+                </variablelist>

+

+                <para>The following commands are understood:</para>

+

+                <variablelist>

+                        <varlistentry>

+                                <term><command>status</command></term>

+

+                                <listitem><para>Show firmware and boot

+                                manager information about the system,

+                                including secure boot mode status and

+                                selected firmware entry (where

+                                available).</para></listitem>

+                        </varlistentry>

+                </variablelist>

+

+        </refsect1>

+

+        <refsect1>

+                <title>Exit status</title>

+

+                <para>On success, 0 is returned, a non-zero failure

+                code otherwise.</para>

+        </refsect1>

+

+        <refsect1>

+                <title>See Also</title>

+                <para>

+                        <ulink url="http://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Boot loader interface</ulink>,

+                        <ulink url="http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot loader specification</ulink>,

+                        <ulink url="http://www.freedesktop.org/wiki/Software/gummiboot/">gummiboot</ulink>

+                </para>

+        </refsect1>

+

+</refentry>