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