setup: add gummiboot(1) man page

diff --git a/Makefile b/Makefile
index fcc3c11..ddcc447 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -85,14 +85,27 @@ gummiboot: src/setup/setup.c src/setup/efivars.h src/setup/efivars.c Makefile
          -o $@
 
 # ------------------------------------------------------------------------------
+man: gummiboot.1
+
+gummiboot.1: src/setup/gummiboot.xml
+       $(E) "  XSLT     " $@
+       $(Q) xsltproc -o @ --nonet \
+         --stringparam man.output.quietly 1 \
+         --stringparam man.th.extra1.suppress 1 \
+         --stringparam man.authors.section.enabled 0 \
+         --stringparam man.copyright.section.enabled 0 \
+         http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+# ------------------------------------------------------------------------------
 clean:
        rm -f src/efi/gummiboot.o src/efi/gummiboot.so gummiboot gummiboot$(MACHINE_TYPE_NAME).efi
 
-install:
+install: all
        mkdir -p $(DESTDIR)/usr/bin/
        cp gummiboot $(DESTDIR)/usr/bin
        mkdir -p $(DESTDIR)/usr/lib/gummiboot/
        cp gummiboot$(MACHINE_TYPE_NAME).efi $(DESTDIR)/usr/lib/gummiboot/
+       [ -e gummiboot.1 ] && mkdir -p $(DESTDIR)/usr/share/man/man1/ && cp gummiboot.1 $(DESTDIR)/usr/share/man/man1/ || :
 
 tar:
        git archive --format=tar --prefix=gummiboot-$(VERSION)/ $(VERSION) | xz > gummiboot-$(VERSION).tar.xz

diff --git a/src/setup/gummiboot.xml b/src/setup/gummiboot.xml
new file mode 100644 (file)
index 0000000..a922d4a
--- /dev/null
+++ b/src/setup/gummiboot.xml
@@ -0,0 +1,133 @@
+<?xml version='1.0'?> <!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<!--
+  Copyright 2013 Kay Sievers
+
+  gummiboot 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="gummiboot">
+        <refentryinfo>
+                <title>gummiboot</title>
+                <productname>gummiboot</productname>
+
+                <authorgroup>
+                        <author>
+                                <contrib>Developer</contrib>
+                                <firstname>Kay</firstname>
+                                <surname>Sievers</surname>
+                                <email>kay@vrfy.org</email>
+                        </author>
+                </authorgroup>
+        </refentryinfo>
+
+        <refmeta>
+                <refentrytitle>gummiboot</refentrytitle>
+                <manvolnum>1</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>gummiboot</refname>
+                <refpurpose>Setup and manage Gummibot Boot Manager</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <cmdsynopsis>
+                        <command>gummiboot <arg choice="opt" rep="repeat">OPTIONS</arg>status</command>
+                </cmdsynopsis>
+                <cmdsynopsis>
+                        <command>gummiboot <arg choice="opt" rep="repeat">OPTIONS</arg>update</command>
+                </cmdsynopsis>
+                <cmdsynopsis>
+                        <command>gummiboot <arg choice="opt" rep="repeat">OPTIONS</arg>install</command>
+                </cmdsynopsis>
+                <cmdsynopsis>
+                        <command>gummiboot <arg choice="opt" rep="repeat">OPTIONS</arg>remove</command>
+                </cmdsynopsis>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para><command>gummibot</command> checks, updates,
+                installs or removes the boot manager from the current
+                system.</para>
+
+                <para><command>gummiboot status</command> checks and
+                prints the currently installed version of the boot
+                manager.</para>
+
+                <para><command>gummiboot update</command> updates all installed
+                versions of gummiboot, if the current version is newer than the
+                version installed in the EFI system partition, and create a
+                gummiboot entry in the EFI boot variables if there is no entry
+                already.</para>
+
+                <para><command>gummiboot install</command>
+                installs gummiboot into the EFI system partition, and create
+                an active entry in the EFI boot varaibles.</para>
+
+                <para><command>gummiboot remove</command> removes all installed
+                versions of gummiboot from the EFI system partition, and remove
+                all gummiboot entries from the EFI boot variables.</para>
+
+                <para>If no command is passed <command>status</command> is
+                implied.</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>--path</option></term>
+                                <listitem><para>Path to the EFI system
+                                partition. The default is /boot.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>--no-variables</option></term>
+                                <listitem><para>Do not touch the EFI boot
+                                variables in the firmware.</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://freedesktop.org/wiki/Software/gummiboot">Gummiboot wiki</ulink>
+                        <ulink url="http://www.freedesktop.org/wiki/Specifications/BootLoaderSpec">Boot loader specification</ulink>
+                        <ulink url="http://www.freedesktop.org/wiki/Software/systemd/BootLoaderInterface">Systemd boot loader interface</ulink>
+                        <citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                </para>
+        </refsect1>
+</refentry>