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 root, <filename>/home</filename> and
  47     <filename>/srv</filename> partitions, as well as
  48     discovering and enabling swap partitions, based on GPT
  49     partition type GUIDs.</refpurpose>
  50   </refnamediv>
  51
  52   <refsynopsisdiv>
  53     <para><filename>/usr/lib/systemd/system-generators/systemd-gpt-auto-generator</filename></para>
  54   </refsynopsisdiv>
  55
  56   <refsect1>
  57     <title>Description</title>
  58
  59     <para><filename>systemd-gpt-auto-generator</filename> is a unit
  60     generator that automatically discovers root,
  61     <filename>/home</filename>, <filename>/srv</filename> and swap
  62     partitions and creates mount and swap units for them, based on the
  63     partition type GUIDs of GUID partition tables (GPT). It implements
  64     the
  65     <ulink url="http://www.freedesktop.org/wiki/Specifications/DiscoverablePartitionsSpec/">Discoverable
  66     Partitions Specification</ulink>. Note that this generator has no
  67     effect on non-GPT systems, on systems where the units are
  68     explicitly configured (for example, listed in
  69     <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>),
  70     or where the mount points are non-empty.</para>
  71
  72     <para>This generator will only look for root partitions on the
  73     same physical disk the EFI System Partition (ESP) is located on.
  74     It will only look for the other partitions on the same physical
  75     disk the root file system is located on. These partitions will not
  76     be searched on systems where the root file system is distributed
  77     on multiple disks, for example via btrfs RAID.</para>
  78
  79     <para><filename>systemd-gpt-auto-generator</filename> is useful
  80     for centralizing file system configuration in the partition table
  81     and making manual configuration in <filename>/etc/fstab</filename>
  82     or suchlike unnecessary.</para>
  83
  84     <para>This generator looks for the partitions based on their
  85     partition type GUID. The following partition type GUIDs are
  86     identified:</para>
  87
  88     <table>
  89       <title>Partition Type GUIDs</title>
  90       <tgroup cols='3' align='left' colsep='1' rowsep='1'>
  91         <colspec colname="guid" />
  92         <colspec colname="name" />
  93         <colspec colname="explanation" />
  94         <thead>
  95           <row>
  96             <entry>Partition Type GUID</entry>
  97             <entry>Name</entry>
  98             <entry>Explanation</entry>
  99           </row>
 100         </thead>
 101         <tbody>
 102           <row>
 103             <entry>44479540-f297-41b2-9af7-d131d5f0458a</entry>
 104             <entry><filename>Root Partition (x86)</filename></entry>
 105             <entry>On 32-bit x86 systems, the first x86 root partition on the disk the EFI ESP is located on is mounted to the root directory <filename>/</filename>.</entry>
 106           </row>
 107           <row>
 108             <entry>4f68bce3-e8cd-4db1-96e7-fbcaf984b709</entry>
 109             <entry><filename>Root Partition (x86-64)</filename></entry>
 110             <entry>On 64-bit x86 systems, the first x86-64 root partition on the disk the EFI ESP is located on is mounted to the root directory <filename>/</filename>.</entry>
 111           </row>
 112           <row>
 113             <entry>69dad710-2ce4-4e3c-b16c-21a1d49abed3</entry>
 114             <entry><filename>Root Partition (32-bit ARM)</filename></entry>
 115             <entry>On 32-bit ARM systems, the first ARM root partition on the disk the EFI ESP is located on is mounted to the root directory <filename>/</filename>.</entry>
 116           </row>
 117           <row>
 118             <entry>b921b045-1df0-41c3-af44-4c6f280d3fae</entry>
 119             <entry><filename>Root Partition (64-bit ARM)</filename></entry>
 120             <entry>On 64-bit ARM systems, the first ARM root partition on the disk the EFI ESP is located on is mounted to the root directory <filename>/</filename>.</entry>
 121           </row>
 122           <row>
 123             <entry>933ac7e1-2eb4-4f13-b844-0e14e2aef915</entry>
 124             <entry>Home Partition</entry>
 125             <entry>The first home partition on the disk the root partition is located on is mounted to <filename>/home</filename>.</entry>
 126           </row>
 127           <row>
 128             <entry>3b8f8425-20e0-4f3b-907f-1a25a76f98e8</entry>
 129             <entry>Server Data Partition</entry>
 130             <entry>The first server data partition on the disk the root partition is located on is mounted to <filename>/srv</filename>.</entry>
 131           </row>
 132           <row>
 133             <entry>0657fd6d-a4ab-43c4-84e5-0933c84b4f4f</entry>
 134             <entry>Swap</entry>
 135             <entry>All swap partitions located on the disk the root partition is located on are enabled.</entry>
 136           </row>
 137         </tbody>
 138       </tgroup>
 139     </table>
 140
 141     <para>The <filename>/home</filename> and <filename>/srv</filename>
 142     partitions may be encrypted in LUKS format. In this case a device
 143     mapper device is set up under the names
 144     <filename>/dev/mapper/home</filename> and
 145     <filename>/dev/mapper/srv</filename>. Note that this might create
 146     conflicts if the same partition is listed in
 147     <filename>/etc/crypttab</filename> with a different device mapper
 148     device name.</para>
 149
 150     <para>Also note that
 151     <citerefentry><refentrytitle>systemd-efi-boot-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 152     will mount the EFI System Partition (ESP) to
 153     <filename>/boot</filename> if not otherwise mounted.</para>
 154
 155     <para>When using this generator in conjunction with btrfs file
 156     systems, make sure to set the correct default subvolumes on them,
 157     using <command>btrfs subvolume set-default</command>.</para>
 158
 159     <para><filename>systemd-gpt-auto-generator</filename> implements
 160     the
 161     <ulink url="http://www.freedesktop.org/wiki/Software/systemd/Generators">Generator
 162     Specification</ulink>.</para>
 163   </refsect1>
 164
 165   <refsect1>
 166     <title>See Also</title>
 167     <para>
 168       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 169       <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 170       <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 171       <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 172       <citerefentry><refentrytitle>systemd-efi-boot-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 173       <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 174       <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 175       <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 176       <citerefentry><refentrytitle>btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 177     </para>
 178   </refsect1>
 179
 180 </refentry>