man/systemd-efi-boot-generator.xml

   1 <?xml version="1.0"?>
   2 <!--*-nxml-*-->
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!--
   5   This file is part of systemd.
   6
   7   Copyright 2013 Lennart Poettering
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 -->
  22 <refentry id="systemd-efi-boot-generator">
  23
  24   <refentryinfo>
  25     <title>systemd-efi-boot-generator</title>
  26     <productname>systemd</productname>
  27
  28     <authorgroup>
  29       <author>
  30         <contrib>Developer</contrib>
  31         <firstname>Lennart</firstname>
  32         <surname>Poettering</surname>
  33         <email>lennart@poettering.net</email>
  34       </author>
  35     </authorgroup>
  36   </refentryinfo>
  37
  38   <refmeta>
  39     <refentrytitle>systemd-efi-boot-generator</refentrytitle>
  40     <manvolnum>8</manvolnum>
  41   </refmeta>
  42
  43   <refnamediv>
  44     <refname>systemd-efi-boot-generator</refname>
  45     <refpurpose>Generator for automatically mounting the
  46     EFI System Partition used by the current boot to
  47     <filename>/boot</filename></refpurpose>
  48   </refnamediv>
  49
  50   <refsynopsisdiv>
  51     <para><filename>/usr/lib/systemd/system-generators/systemd-efi-boot-generator</filename></para>
  52   </refsynopsisdiv>
  53
  54   <refsect1>
  55     <title>Description</title>
  56
  57     <para><filename>systemd-efi-boot-generator</filename> is a
  58     generator that automatically creates mount and automount units for
  59     the EFI System Partition (ESP), mounting it to
  60     <filename>/boot</filename>. Note that this generator will execute
  61     no operation on non-EFI systems, on systems where the boot loader
  62     does not communicate the used ESP to the OS, on systems where
  63     <filename>/boot</filename> is an explicitly configured mount (for
  64     example, listed in
  65     <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
  66     or where the <filename>/boot</filename> mount point is non-empty.
  67     Since this generator creates an automount unit, the mount will
  68     only be activated on-demand, when accessed.</para>
  69
  70     <para><filename>systemd-efi-boot-generator</filename> implements
  71     the <ulink
  72     url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator
  73     specification</ulink>.</para>
  74   </refsect1>
  75
  76   <refsect1>
  77     <title>See Also</title>
  78     <para>
  79       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  80       <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  81       <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  82       <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  83       <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  84     </para>
  85   </refsect1>
  86
  87 </refentry>