diff options
Diffstat (limited to 'man/systemd-gpt-auto-generator.xml')
| -rw-r--r-- | man/systemd-gpt-auto-generator.xml | 111 |
1 files changed, 65 insertions, 46 deletions
diff --git a/man/systemd-gpt-auto-generator.xml b/man/systemd-gpt-auto-generator.xml index db51076..0893b3f 100644 --- a/man/systemd-gpt-auto-generator.xml +++ b/man/systemd-gpt-auto-generator.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-gpt-auto-generator" conditional='HAVE_BLKID' @@ -32,18 +32,22 @@ <para><filename>systemd-gpt-auto-generator</filename> is a unit generator that automatically discovers the root partition, <filename>/home/</filename>, <filename>/srv/</filename>, <filename>/var/</filename>, - <filename>/var/tmp/</filename>, the EFI System Partition, the Extended Boot Loader Partition, and swap - partitions and creates mount and swap units for them, based on the partition type GUIDs of GUID partition - tables (GPT). See <ulink url="https://uefi.org/specifications">UEFI Specification</ulink>, chapter 5 for - more details. It implements the <ulink + <filename>/var/tmp/</filename>, the EFI System Partition (ESP), the Extended Boot Loader Partition + (XBOOTLDR), and swap partitions and creates mount and swap units for them, based on the partition type + GUIDs of GUID partition tables (GPT). See <ulink url="https://uefi.org/specifications">UEFI + Specification</ulink>, chapter 5 for more details. It implements the <ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification</ulink>.</para> <para>Note that this generator has no effect on non-GPT systems. It will also not create mount point configuration for directories which already contain files or if the mount point is explicitly configured in <citerefentry - project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>. If - the units this generator creates are overridden, for example by units in directories with higher + project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Additionally + no unit will be created for the ESP or the XBOOTLDR partition if mount entries are found in the + <filename>/boot/</filename> or <filename>/efi/</filename> hierarchies in <citerefentry + project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> + + <para>If the units this generator creates are overridden, for example by units in directories with higher precedence, drop-ins and additional dependencies created by this generator might still be used.</para> <para>This generator will only look for the root partition on the same physical disk where the EFI System @@ -69,14 +73,16 @@ <table> <title>Partition Type GUIDs</title> - <tgroup cols='3' align='left' colsep='1' rowsep='1'> + <tgroup cols='5' align='left' colsep='1' rowsep='1'> + <colspec colname="type" /> <colspec colname="guid" /> <colspec colname="name" /> <colspec colname="where" /> <colspec colname="explanation" /> <thead> <row> - <entry>Partition Type GUID</entry> + <entry>Partition Type</entry> + <entry>GUID</entry> <entry>Name</entry> <entry>Mount Point</entry> <entry>Explanation</entry> @@ -84,63 +90,71 @@ </thead> <tbody> <row> - <entry><constant>SD_GPT_ROOT_X86_64</constant> <constant>4f68bce3-e8cd-4db1-96e7-fbcaf984b709</constant></entry> + <entry><constant>SD_GPT_ROOT_X86_64</constant></entry> + <entry><constant>4f68bce3-e8cd-4db1-96e7-fbcaf984b709</constant></entry> <entry><filename>Root Partition (x86-64)</filename></entry> <entry><filename>/</filename></entry> - <entry>The first partition with this type UUID, located on the same disk as the ESP, is used as the root file system <filename>/</filename> on AMD64 / 64-bit x86 systems.</entry> + <entry>The first partition with this type UUID, located on the same disk as the ESP used for booting, is used as the root file system <filename>/</filename> on AMD64 / 64-bit x86 systems.</entry> </row> <row> - <entry><constant>SD_GPT_ROOT_ARM64</constant> <constant>b921b045-1df0-41c3-af44-4c6f280d3fae</constant></entry> + <entry><constant>SD_GPT_ROOT_ARM64</constant></entry> + <entry><constant>b921b045-1df0-41c3-af44-4c6f280d3fae</constant></entry> <entry><filename>Root Partition (64-bit ARM)</filename></entry> <entry><filename>/</filename></entry> - <entry>The first partition with this type UUID, located on the same disk as the ESP, is used as the root file system <filename>/</filename> on AArch64 / 64-bit ARM systems.</entry> + <entry>The first partition with this type UUID, located on the same disk as the ESP used for booting, is used as the root file system <filename>/</filename> on AArch64 / 64-bit ARM systems.</entry> </row> <row> - <entry> - <constant>SD_GPT_ROOT_ALPHA</constant> <constant>SD_GPT_ROOT_ARC</constant> <constant>SD_GPT_ROOT_ARM</constant> <constant>SD_GPT_ROOT_ARM64</constant> <constant>SD_GPT_ROOT_IA64</constant> <constant>SD_GPT_ROOT_LOONGARCH64</constant> <constant>SD_GPT_ROOT_MIPS</constant> <constant>SD_GPT_ROOT_MIPS64</constant> <constant>SD_GPT_ROOT_MIPS_LE</constant> <constant>SD_GPT_ROOT_MIPS64_LE</constant> <constant>SD_GPT_ROOT_PARISC</constant> <constant>SD_GPT_ROOT_PPC</constant> <constant>SD_GPT_ROOT_PPC64</constant> <constant>SD_GPT_ROOT_PPC64_LE</constant> <constant>SD_GPT_ROOT_RISCV32</constant> <constant>SD_GPT_ROOT_RISCV64</constant> <constant>SD_GPT_ROOT_S390</constant> <constant>SD_GPT_ROOT_S390X</constant> <constant>SD_GPT_ROOT_TILEGX</constant> <constant>SD_GPT_ROOT_X86</constant> <constant>SD_GPT_ROOT_X86_64</constant> <constant>SD_GPT_USR_ALPHA</constant> <constant>SD_GPT_USR_ARC</constant> <constant>SD_GPT_USR_ARM</constant> <constant>SD_GPT_USR_IA64</constant> <constant>SD_GPT_USR_LOONGARCH64</constant> <constant>SD_GPT_USR_MIPS_LE</constant> <constant>SD_GPT_USR_MIPS64_LE</constant> <constant>SD_GPT_USR_PARISC</constant> <constant>SD_GPT_USR_PPC</constant> <constant>SD_GPT_USR_PPC64</constant> <constant>SD_GPT_USR_PPC64_LE</constant> <constant>SD_GPT_USR_RISCV32</constant> <constant>SD_GPT_USR_RISCV64</constant> <constant>SD_GPT_USR_S390</constant> <constant>SD_GPT_USR_S390X</constant> <constant>SD_GPT_USR_TILEGX</constant> <constant>SD_GPT_USR_X86</constant> - </entry> - <entry>root partitions for other architectures</entry> + <entry><constant>SD_GPT_ROOT_ALPHA</constant> <constant>SD_GPT_ROOT_ARC</constant> <constant>SD_GPT_ROOT_ARM</constant> <constant>SD_GPT_ROOT_ARM64</constant> <constant>SD_GPT_ROOT_IA64</constant> <constant>SD_GPT_ROOT_LOONGARCH64</constant> <constant>SD_GPT_ROOT_MIPS</constant> <constant>SD_GPT_ROOT_MIPS64</constant> <constant>SD_GPT_ROOT_MIPS_LE</constant> <constant>SD_GPT_ROOT_MIPS64_LE</constant> <constant>SD_GPT_ROOT_PARISC</constant> <constant>SD_GPT_ROOT_PPC</constant> <constant>SD_GPT_ROOT_PPC64</constant> <constant>SD_GPT_ROOT_PPC64_LE</constant> <constant>SD_GPT_ROOT_RISCV32</constant> <constant>SD_GPT_ROOT_RISCV64</constant> <constant>SD_GPT_ROOT_S390</constant> <constant>SD_GPT_ROOT_S390X</constant> <constant>SD_GPT_ROOT_TILEGX</constant> <constant>SD_GPT_ROOT_X86</constant> <constant>SD_GPT_ROOT_X86_64</constant> <constant>SD_GPT_USR_ALPHA</constant> <constant>SD_GPT_USR_ARC</constant> <constant>SD_GPT_USR_ARM</constant> <constant>SD_GPT_USR_IA64</constant> <constant>SD_GPT_USR_LOONGARCH64</constant> <constant>SD_GPT_USR_MIPS_LE</constant> <constant>SD_GPT_USR_MIPS64_LE</constant> <constant>SD_GPT_USR_PARISC</constant> <constant>SD_GPT_USR_PPC</constant> <constant>SD_GPT_USR_PPC64</constant> <constant>SD_GPT_USR_PPC64_LE</constant> <constant>SD_GPT_USR_RISCV32</constant> <constant>SD_GPT_USR_RISCV64</constant> <constant>SD_GPT_USR_S390</constant> <constant>SD_GPT_USR_S390X</constant> <constant>SD_GPT_USR_TILEGX</constant> <constant>SD_GPT_USR_X86</constant></entry> + <entry>…</entry> + <entry>Root partitions for other architectures</entry> <entry><filename>/</filename></entry> - <entry>The first partition with the type UUID matching the architecture, located on the same disk as the ESP, is used as the root file system <filename>/</filename>. For the full list and constant values, see <ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification</ulink>.</entry> + <entry>The first partition with the type UUID matching the architecture, located on the same disk as the ESP used for booting, is used as the root file system <filename>/</filename>. For the full list and constant values, see <ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification</ulink>.</entry> </row> <row> - <entry><constant>SD_GPT_HOME</constant> <constant>933ac7e1-2eb4-4f13-b844-0e14e2aef915</constant></entry> + <entry><constant>SD_GPT_HOME</constant></entry> + <entry><constant>933ac7e1-2eb4-4f13-b844-0e14e2aef915</constant></entry> <entry>Home Partition</entry> <entry><filename>/home/</filename></entry> - <entry>The first partition with this type UUID on the same disk as the ESP is mounted to <filename>/home/</filename>.</entry> + <entry>The first partition with this type UUID on the same disk as the root partition is mounted to <filename>/home/</filename>.</entry> </row> <row> - <entry><constant>SD_GPT_SRV</constant> <constant>3b8f8425-20e0-4f3b-907f-1a25a76f98e8</constant></entry> + <entry><constant>SD_GPT_SRV</constant></entry> + <entry><constant>3b8f8425-20e0-4f3b-907f-1a25a76f98e8</constant></entry> <entry>Server Data Partition</entry> <entry><filename>/srv/</filename></entry> - <entry>The first partition with this type UUID on the same disk as the ESP is mounted to <filename>/srv/</filename>.</entry> + <entry>The first partition with this type UUID on the same disk as the root partition is mounted to <filename>/srv/</filename>.</entry> </row> <row> - <entry><constant>SD_GPT_VAR</constant> <constant>4d21b016-b534-45c2-a9fb-5c16e091fd2d</constant></entry> + <entry><constant>SD_GPT_VAR</constant></entry> + <entry><constant>4d21b016-b534-45c2-a9fb-5c16e091fd2d</constant></entry> <entry>Variable Data Partition</entry> <entry><filename>/var/</filename></entry> - <entry>The first partition with this type UUID on the same disk as the ESP is mounted to <filename>/var/</filename> — under the condition its partition UUID matches the first 128 bit of the HMAC-SHA256 of the GPT type uuid of this partition keyed by the machine ID of the installation stored in <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</entry> + <entry>The first partition with this type UUID on the same disk as the root partition is mounted to <filename>/var/</filename> — under the condition its partition UUID matches the first 128 bit of the HMAC-SHA256 of the GPT type uuid of this partition keyed by the machine ID of the installation stored in <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</entry> </row> <row> - <entry><constant>SD_GPT_TMP</constant> <constant>7ec6f557-3bc5-4aca-b293-16ef5df639d1</constant></entry> + <entry><constant>SD_GPT_TMP</constant></entry> + <entry><constant>7ec6f557-3bc5-4aca-b293-16ef5df639d1</constant></entry> <entry>Temporary Data Partition</entry> <entry><filename>/var/tmp/</filename></entry> - <entry>The first partition with this type UUID on the same disk as the ESP is mounted to <filename>/var/tmp/</filename>.</entry> + <entry>The first partition with this type UUID on the same disk as the root partition is mounted to <filename>/var/tmp/</filename>.</entry> </row> <row> - <entry><constant>SD_GPT_SWAP</constant> <constant>0657fd6d-a4ab-43c4-84e5-0933c84b4f4f</constant></entry> + <entry><constant>SD_GPT_SWAP</constant></entry> + <entry><constant>0657fd6d-a4ab-43c4-84e5-0933c84b4f4f</constant></entry> <entry>Swap</entry> <entry>n/a</entry> - <entry>All partitions with this type UUID on the same disk as the ESP are used as swap.</entry> + <entry>All partitions with this type UUID on the same disk as the root partition are used as swap.</entry> </row> <row> - <entry><constant>SD_GPT_ESP</constant> <constant>c12a7328-f81f-11d2-ba4b-00a0c93ec93b</constant></entry> + <entry><constant>SD_GPT_ESP</constant></entry> + <entry><constant>c12a7328-f81f-11d2-ba4b-00a0c93ec93b</constant></entry> <entry>EFI System Partition (ESP)</entry> <entry><filename>/efi/</filename> or <filename>/boot/</filename></entry> <entry>The first partition with this type UUID located on the same disk as the root partition is mounted to <filename>/boot/</filename> or <filename>/efi/</filename>, see below.</entry> </row> <row> - <entry><constant>SD_GPT_XBOOTLDR</constant> <constant>bc13c2ff-59e6-4262-a352-b275fd6f7172</constant></entry> + <entry><constant>SD_GPT_XBOOTLDR</constant></entry> + <entry><constant>bc13c2ff-59e6-4262-a352-b275fd6f7172</constant></entry> <entry>Extended Boot Loader Partition</entry> <entry><filename>/boot/</filename></entry> <entry>The first partition with this type UUID located on the same disk as the root partition is mounted to <filename>/boot/</filename>, see below.</entry> @@ -153,32 +167,37 @@ <table> <title>Partition Attribute Flags</title> - <tgroup cols='3' align='left' colsep='1' rowsep='1'> + <tgroup cols='4' align='left' colsep='1' rowsep='1'> <colspec colname="flag" /> + <colspec colname="value" /> <colspec colname="where" /> <colspec colname="explanation" /> <thead> <row> <entry>Flag</entry> + <entry>Value</entry> <entry>Applicable to</entry> <entry>Explanation</entry> </row> </thead> <tbody> <row> - <entry><constant>SD_GPT_FLAG_READ_ONLY</constant> <constant>0x1000000000000000</constant></entry> + <entry><constant>SD_GPT_FLAG_READ_ONLY</constant></entry> + <entry><constant>0x1000000000000000</constant></entry> <entry><filename>/</filename>, <filename>/home/</filename>, <filename>/srv/</filename>, <filename>/var/</filename>, <filename>/var/tmp/</filename>, Extended Boot Loader Partition</entry> <entry>Partition is mounted read-only</entry> </row> <row> - <entry><constant>SD_GPT_FLAG_NO_AUTO</constant> <constant>0x8000000000000000</constant></entry> + <entry><constant>SD_GPT_FLAG_NO_AUTO</constant></entry> + <entry><constant>0x8000000000000000</constant></entry> <entry><filename>/</filename>, <filename>/home/</filename>, <filename>/srv/</filename>, <filename>/var/</filename>, <filename>/var/tmp/</filename>, Extended Boot Loader Partition</entry> <entry>Partition is not mounted automatically</entry> </row> <row> - <entry><constant>SD_GPT_FLAG_NO_BLOCK_IO_PROTOCOL</constant> <constant>0x0000000000000002</constant></entry> + <entry><constant>SD_GPT_FLAG_NO_BLOCK_IO_PROTOCOL</constant></entry> + <entry><constant>0x0000000000000002</constant></entry> <entry>EFI System Partition (ESP)</entry> <entry>Partition is not mounted automatically</entry> </row> @@ -312,18 +331,18 @@ <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-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-pcrfs@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='url'><refentrytitle url='https://btrfs.readthedocs.io/en/latest/btrfs.html'>btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-pcrfs@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='url'><refentrytitle url='https://btrfs.readthedocs.io/en/latest/btrfs.html'>btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> |