systemd/man/systemd-gpt-auto-generator.xml

<?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> 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 generator that automatically discovers
                <filename>/home</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 will execute no
                operation 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 point is 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>This generator 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 swap partitions using
                GPT type 0657fd6d-a4ab-43c4-84e50933c84b4f4f. It looks
                for <filename>/home</filename> partitions using GPT
                type 933ac7e1-2eb4-4f13-b8440e14e2aef915.</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-efi-boot-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>