summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2013-08-14 03:31:06 +0200
committerLennart Poettering <lennart@poettering.net>2013-08-14 03:31:06 +0200
commit22d0d443b6fbdd319e4c6e0124e6acec086db3fa (patch)
tree5fac351689095813dc673fa6c61cd7fef9f8f923
parent38e19f93501d5a23d2176be30eea82e1be999f3d (diff)
man: document systemd-efi-boot-generator
-rw-r--r--Makefile-man.am1
-rw-r--r--man/systemd-efi-boot-generator.xml87
2 files changed, 88 insertions, 0 deletions
diff --git a/Makefile-man.am b/Makefile-man.am
index 4ebc76837e..235b5a1342 100644
--- a/Makefile-man.am
+++ b/Makefile-man.am
@@ -52,6 +52,7 @@ MANPAGES += \
man/systemd-cgtop.1 \
man/systemd-delta.1 \
man/systemd-detect-virt.1 \
+ man/systemd-efi-boot-generator.8 \
man/systemd-fsck@.service.8 \
man/systemd-fstab-generator.8 \
man/systemd-getty-generator.8 \
diff --git a/man/systemd-efi-boot-generator.xml b/man/systemd-efi-boot-generator.xml
new file mode 100644
index 0000000000..d5e5aeff3e
--- /dev/null
+++ b/man/systemd-efi-boot-generator.xml
@@ -0,0 +1,87 @@
+<?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">
+<!--
+ This file is part of systemd.
+
+ Copyright 2013 Lennart Poettering
+
+ 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="systemd-efi-boot-generator">
+
+ <refentryinfo>
+ <title>systemd-efi-boot-generator</title>
+ <productname>systemd</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Lennart</firstname>
+ <surname>Poettering</surname>
+ <email>lennart@poettering.net</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>systemd-efi-boot-generator</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>systemd-efi-boot-generator</refname>
+ <refpurpose>Generator for automatically mounting the
+ EFI System Partition used by the current boot to
+ <filename>/boot</filename></refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <para><filename>/usr/lib/systemd/system-generators/systemd-efi-boot-generator</filename></para>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para><filename>systemd-efi-boot-generator</filename>
+ is a generator that automatically creates mount and
+ automount units for the EFI System Partition (ESP)
+ mounting it to <filename>/boot</filename>. Note that
+ this generator will execute no operation on non-EFI
+ systems, on systems where the boot loader does not
+ communicate the used ESP to the OS, on systems where
+ <filename>/boot</filename> is an explicitly configured
+ mount (for example, listed in <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>) or where the <filename>/boot</filename> mount
+ point is non-empty. Since this generator creates an
+ automount unit the mount will only be activated
+ on-demand, when accessed.</para>
+
+ <para><filename>systemd-efi-boot-generator</filename>
+ implements the <ulink
+ url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator
+ specification</ulink>.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>gummiboot</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>