X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd.swap.xml;h=9cc3b80bb973f9a2a1fde8c29f1a90fc82c51b18;hb=302fbdf29eb0ad4ca1fe8ee18755edad7db11b37;hp=954e94412f4a21dd4792f5f8ce99fc6bc0dec987;hpb=ecb963cc40a0270a357c2640d368b3116e0f56b6;p=elogind.git
diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml
index 954e94412..9cc3b80bb 100644
--- a/man/systemd.swap.xml
+++ b/man/systemd.swap.xml
@@ -9,16 +9,16 @@
Copyright 2010 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ 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
- General Public License for more details.
+ Lesser General Public License for more details.
- You should have received a copy of the GNU General Public License
+ You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see .
-->
@@ -44,18 +44,18 @@
systemd.swap
- systemd swap configuration files
+ Swap unit configuration
- systemd.swap
+ swap.swapDescriptionA unit configuration file whose name ends in
- .swap encodes information about a
+ .swap encodes information about a
swap device or file for memory paging controlled and
supervised by systemd.
@@ -68,17 +68,29 @@
specific configuration options are configured in the
[Swap] section.
+ Additional options are listed in
+ systemd.exec5,
+ which define the execution environment the
+ swapon8
+ binary is executed in, and in
+ systemd.kill5,
+ which define the way the processes are
+ terminated, and in
+ systemd.resource-control5,
+ which configure resource control settings for the
+ processes of the service.
+
Swap units must be named after the devices
- (resp. files) they control. Example: the swap device
- /dev/sda5 must be configured in a
+ or files 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
+ file system path to a unit name, see
systemd.unit5.All swap units automatically get the appropriate
- dependencies on the devices (resp. on the mount points
- of the files) they are actived from.
+ dependencies on the devices or on the mount points
+ of the files they are activated from.
Swap units with
DefaultDependencies= enabled
@@ -93,18 +105,49 @@
Swap units may either be configured via unit
files, or via /etc/fstab (see
fstab5
- for details).
+ for details). Swaps listed in
+ /etc/fstab will be converted into
+ native units dynamically at boot and when the
+ configuration of the system manager is
+ reloaded. See
+ systemd-fstab-generator8
+ for details about the conversion.If a swap device or file is configured in both
- /etc/fstab and a unit file the
+ /etc/fstab and a unit file, the
configuration in the latter takes precedence.
- Unless the option is set
- for them all swap units configured in
- /etc/fstab are also added as
- requirements to swap.target, so
- that they are waited for and activated during
- boot.
+ When reading /etc/fstab a
+ few special options are understood by systemd which
+ influence how dependencies are created for swap
+ units.
+
+
+
+
+
+
+ With the
+ swap unit will not be added as a dependency for
+ swap.target. This means that
+ it will not be activated automatically during
+ boot, unless it is pulled in by some other
+ unit. Option has the
+ opposite meaning and is the default.
+
+
+
+
+
+
+ With the
+ swap unit will be only wanted, not required by
+ swap.target. This means that
+ the boot will continue even if this swap device is
+ not activated successfully.
+
+
+
@@ -115,11 +158,13 @@
supervises. A number of options that may be used in
this section are shared with other unit types. These
options are documented in
- systemd.exec5. The
+ systemd.exec5
+ and
+ systemd.kill5. The
options specific to the [Swap] section of swap units
are the following:
-
+ What=
@@ -150,72 +195,64 @@
setting is optional.
+
+ Options=
+
+ May contain an option
+ string for the swap device. This may
+ be used for controlling discard
+ options among other functionality, if
+ the swap backing device supports the
+ discard or trim operation. (See
+ swapon8
+ for more information.)
+
+
+
TimeoutSec=Configures the time to
wait for the swapon command to
finish. If a command does not exit
- within the configured time the swap
+ within the configured time, the swap
will be considered failed and be shut
down again. All commands still running
will be terminated forcibly via
- SIGTERM, and after another delay of
- this time with SIGKILL. (See
- below.)
+ SIGTERM, and after another delay of
+ this time with SIGKILL. (See
+ in
+ systemd.kill5.)
Takes a unit-less value in seconds, or
a time span value such as "5min
- 20s". Pass 0 to disable the timeout
- logic. Defaults to
- 90s.
-
-
-
- KillMode=
- Specifies how
- processes of this swap shall be
- killed. One of
- ,
- ,
- .
-
- This option is mostly equivalent
- to the
- option of service files. See
- systemd.service5
- for details.
-
-
-
- KillSignal=
- Specifies which signal
- to use when killing a process of this
- swap. Defaults to SIGTERM.
-
-
-
-
- SendSIGKILL=
- Specifies whether to
- send SIGKILL to remaining processes
- after a timeout, if the normal
- shutdown procedure left processes of
- the swap around. Takes a boolean
- value. Defaults to "yes".
+ 20s". Pass 0 to disable the timeout
+ logic. Defaults to DefaultTimeoutStartSec= from the
+ manager configuration file
+ (see systemd-system.conf5).
+
+ Check
+ systemd.exec5
+ and
+ systemd.kill5
+ for more settings.See Alsosystemd1,
- systemctl8,
+ systemctl1,
systemd.unit5,
systemd.exec5,
+ systemd.kill5,
+ systemd.resource-control5,
systemd.device5,
systemd.mount5,
- swapon8
+ swapon8,
+ systemd-fstab-generator8,
+ systemd.directives7