<?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-gpt-auto-generator">

        <refentryinfo>
                <title>systemd-gpt-auto-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-gpt-auto-generator</refentrytitle>
                <manvolnum>8</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>systemd-gpt-auto-generator</refname>
                <refpurpose>Generator for automatically discovering
                and mounting <filename>/home</filename> and <filename>/srv</filename>, as well as
                discovering and enabling swap partitions, based on GPT
                partition type GUIDs.</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <para><filename>/usr/lib/systemd/system-generators/systemd-gpt-auto-generator</filename></para>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para><filename>systemd-gpt-auto-generator</filename>
                is a unit generator that automatically discovers
                <filename>/home</filename>, <filename>/srv</filename>
                and swap partitions and creates mount and swap units
                for them, based on the the partition type GUIDs of
                GUID partition tables (GPT). Note that this generator
                has no effect on non-GPT systems, on systems where the
                units are explicitly configured (for example, listed
                in
                <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>),
                or where the mount points are non-empty.</para>

                <para>This generator will only look for partitions on
                the same physical disk the root file system is stored
                on. This generator has no effect on systems where the
                root file system is distributed on multiple disks, for
                example via btrfs RAID.</para>

                <para><filename>systemd-gpt-auto-generator</filename>
                is useful for centralizing file system configuration
                in the partition table and making manual configuration
                in <filename>/etc/fstab</filename> or suchlike
                unnecessary.</para>

                <para>This generator looks for the partitions based on
                their partition type GUID. The following partition
                type GUIDs are identified:</para>

                <table>
                        <title>Partition Type GUIDs</title>
                        <tgroup cols='3' align='left' colsep='1' rowsep='1'>
                                <colspec colname="guid" />
                                <colspec colname="location" />
                                <colspec colname="explanation" />
                                <thead>
                                        <row>
                                                <entry>Partition Type GUID</entry>
                                                <entry>Location</entry>
                                                <entry>Explanation</entry>
                                        </row>
                                </thead>
                                <tbody>
                                        <row>
                                                <entry>0657fd6d-a4ab-43c4-84e50933c84b4f4f</entry>
                                                <entry>Swap</entry>
                                                <entry>All swap partitions are enabled.</entry>
                                        </row>
                                        <row>
                                                <entry>933ac7e1-2eb4-4f13-b8440e14e2aef915</entry>
                                                <entry><filename>/home</filename></entry>
                                                <entry>The first home partition on the disk is mounted to <filename>/home</filename>.</entry>
                                        </row>
                                        <row>
                                                <entry>3b8f8425-20e0-4f3b-907f1a25a76f98e8</entry>
                                                <entry><filename>/srv</filename></entry>
                                                <entry>The first server data partition on the disk is mounted to <filename>/srv</filename>.</entry>
                                        </row>
                                </tbody>
                        </tgroup>
                </table>

                <para>The <filename>/home</filename> and
                <filename>/srv</filename> partitions may be encrypted
                in LUKS format. In this case a device mapper device is
                set up under the names
                <filename>/dev/mapper/home</filename> and
                <filename>/dev/mapper/srv</filename>. Note that this
                might create conflicts if the same partition is listed
                in <filename>/etc/crypttab</filename> with a different
                device mapper device name.</para>

                <para>Also note that
                <citerefentry><refentrytitle>systemd-efi-boot-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                will mount the EFI System Partition to
                <filename>/boot</filename> is not otherwise mounted.</para>

                <para><filename>systemd-gpt-auto-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.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd-efi-boot-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>