From e0cabd4bb536bce3a9636a12b8dbc512c28c2395 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 2 Jul 2010 01:33:54 +0200 Subject: [PATCH] man: document swap units --- Makefile.am | 1 + man/systemd.automount.xml | 11 +-- man/systemd.mount.xml | 8 ++- man/systemd.swap.xml | 146 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 160 insertions(+), 6 deletions(-) create mode 100644 man/systemd.swap.xml diff --git a/Makefile.am b/Makefile.am index 7df50cecc..cdf85f977 100644 --- a/Makefile.am +++ b/Makefile.am @@ -320,6 +320,7 @@ MANPAGES = \ man/systemd.socket.5 \ man/systemd.mount.5 \ man/systemd.automount.5 \ + man/systemd.swap.5 \ man/daemon.7 \ man/sd-daemon.7 \ man/runlevel.8 \ diff --git a/man/systemd.automount.xml b/man/systemd.automount.xml index a09839a68..b7777387e 100644 --- a/man/systemd.automount.xml +++ b/man/systemd.automount.xml @@ -68,10 +68,10 @@ automount specific configuration options are configured in the [Automount] section. - Automount units must be named after the file - paths they reflect. Example: the automount point - /home/lennart must be configured - in a unit file + Automount units must be named after the + automount directories they control. Example: the + automount point /home/lennart + must be configured in a unit file home-lennart.automount. For details about the escaping logic used to convert a file system path to a unit name see @@ -92,6 +92,9 @@ on-demand mounting as well as parallelized mounting of file systems. + If an automount point is beneath another mount + point in the file system hierarchy a dependency + between both units is created automatically. diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index 94ed66453..bb969bb4e 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -71,8 +71,8 @@ Additional options are listed in systemd.exec5. - Mount units must be named after the file paths - they reflect. Example: the mount point + Mount units must be named after the mount point + directories they control. Example: the mount point /home/lennart must be configured in a unit file home-lennart.mount. For details @@ -84,6 +84,10 @@ an automount unit, to allow on-demand or parallelized mounting. See systemd.automount5. + + If an mount point is beneath another mount point + in the file system hierarchy a dependency between both + units is created automatically. diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml new file mode 100644 index 000000000..6b2abedff --- /dev/null +++ b/man/systemd.swap.xml @@ -0,0 +1,146 @@ + + + + + + + + + systemd.swap + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd.swap + 5 + + + + systemd.swap + systemd swap configuration files + + + + systemd.swap + + + + Description + + A unit configuration file whose name ends in + .swap encodes information about a + swap device or file for memory paging controlled and + supervised by systemd. + + This man page lists the configuration options + specific to this unit type. See + systemd.unit5 + for the common options of all unit configuration + files. The common configuration items are configured + in the generic [Unit] and [Install] sections. The swap + specific configuration options are configured in the + [Swap] section. + + Swap units must be named after the devices they + control. Example: the swap device + /dev/sda5 must be configured in a + unit file dev-sda5.swap. For + details about the escaping logic used to convert a + file system path to a unit name see + systemd.unit5. + + + + <filename>fstab</filename> + + Swap units may either be configured via unit + files, or via /etc/fstab (see + fstab5 + for details). + + If a swap device or file is configured in both + /etc/fstab and a unit file the + configuration in the latter takes precedence. + + + + Options + + Swap files must include a [Swap] section, which + carries information about the swap device it + supervises. The options specific to the [Swap] section + of swap units are the following: + + + + + What= + Takes an absolute path + of a device node or file to use for + paging. See + swapon8 + for details. If this refers to a + device node a dependency on the + respective device unit is + automatically created. (See + systemd.device5 + for more information.) If this refers + to a file a dependency on the + respective mount unit is automatically + created. (See + systemd.mount5 + for more information.) This option is + mandatory. + + + + Priority= + + Swap priority to use + when activating the swap device or + file. This takes an integer. This + setting is optional. + + + + + + See Also + + systemd8, + systemctl8, + systemd.unit5, + systemd.device5, + systemd.mount5, + swapon8 + + + + -- 2.30.2