man/systemd-gpt-auto-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-gpt-auto-generator">
  23
  24         <refentryinfo>
  25                 <title>systemd-gpt-auto-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-gpt-auto-generator</refentrytitle>
  40                 <manvolnum>8</manvolnum>
  41         </refmeta>
  42
  43         <refnamediv>
  44                 <refname>systemd-gpt-auto-generator</refname>
  45                 <refpurpose>Generator for automatically discovering
  46                 and mounting <filename>/home</filename> as well as
  47                 discovering and enabling swap partitions, based on GPT
  48                 partition type GUIDs.</refpurpose>
  49         </refnamediv>
  50
  51         <refsynopsisdiv>
  52                 <para><filename>/usr/lib/systemd/system-generators/systemd-gpt-auto-generator</filename></para>
  53         </refsynopsisdiv>
  54
  55         <refsect1>
  56                 <title>Description</title>
  57
  58                 <para><filename>systemd-gpt-auto-generator</filename>
  59                 is a generator that automatically discovers
  60                 <filename>/home</filename> and swap partitions and
  61                 creates mount and swap units for them, based on the
  62                 the partition type GUIDs of GUID partition tables
  63                 (GPT). Note that this generator will execute no
  64                 operation on non-GPT systems, on systems where the
  65                 units are explicitly configured (for example, listed
  66                 in
  67                 <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
  68                 or where the mount point is non-empty.</para>
  69
  70                 <para>This generator will only look for partitions on
  71                 the same physical disk the root file system is stored
  72                 on. This generator has no effect on systems where the
  73                 root file system is distributed on multiple disks, for
  74                 example via btrfs RAID.</para>
  75
  76                 <para>This generator is useful for centralizing file
  77                 system configuration in the partition table and making
  78                 manual configuration in
  79                 <filename>/etc/fstab</filename> or suchlike
  80                 unnecessary.</para>
  81
  82                 <para>This generator looks for swap partitions using
  83                 GPT type 0657fd6d-a4ab-43c4-84e50933c84b4f4f. It looks
  84                 for <filename>/home</filename> partitions using GPT
  85                 type 933ac7e1-2eb4-4f13-b8440e14e2aef915.</para>
  86
  87                 <para><filename>systemd-gpt-auto-generator</filename>
  88                 implements the <ulink
  89                 url="http://www.freedesktop.org/wiki/Software/systemd/Generators">generator
  90                 specification</ulink>.</para>
  91         </refsect1>
  92
  93         <refsect1>
  94                 <title>See Also</title>
  95                 <para>
  96                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  97                         <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  98                         <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  99                         <citerefentry><refentrytitle>systemd-efi-boot-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 100                         <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 101                 </para>
 102         </refsect1>
 103
 104 </refentry>