X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd.swap.xml;h=beb8dba210718629088b3051ef956bcf3220a7e0;hb=a8eedf4953d379dc09ee2b04e69a0a54ba247a02;hp=6b2abedffde9f6f3f2f60fc88c0efa3c0742fdfb;hpb=e0cabd4bb536bce3a9636a12b8dbc512c28c2395;p=elogind.git
diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml
index 6b2abedff..beb8dba21 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 .
-->
@@ -68,13 +68,23 @@
specific configuration options are configured in the
[Swap] section.
- Swap units must be named after the devices they
- control. Example: the swap device
+ Swap units must be named after the devices
+ (resp. 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
systemd.unit5.
+
+ All swap units automatically get the appropriate
+ dependencies on the devices (resp. on the mount points
+ of the files) they are activated from.
+
+ Swap units with
+ DefaultDependencies= enabled
+ implicitly acquire a conflicting dependency to
+ umount.target so that they are
+ deactivated at shutdown.
@@ -83,11 +93,24 @@
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
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.
@@ -95,8 +118,12 @@
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:
+ 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
+ options specific to the [Swap] section of swap units
+ are the following:
@@ -107,12 +134,12 @@
paging. See
swapon8
for details. If this refers to a
- device node a dependency on the
+ 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
+ to a file, a dependency on the
respective mount unit is automatically
created. (See
systemd.mount5
@@ -128,18 +155,74 @@
file. This takes an integer. This
setting is optional.
+
+
+ TimeoutSec=
+ Configures the time to
+ wait for the swapon command to
+ finish. If a command does not exit
+ 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.)
+ 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".
+
+ See Also
- systemd8,
+ systemd1,
systemctl8,
systemd.unit5,
+ systemd.exec5,
systemd.device5,
systemd.mount5,
- swapon8
+ swapon8,
+ systemd-fstab-generator8