relicense to LGPLv2.1 (with exceptions)

[elogind.git] / man / systemd.swap.xml

diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml
index 45467039e9e17b2842064c9682508d8911270ecb..30a15ecfc3bfd2313524937c2fc2603179efc940 100644 (file)
--- 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 <http://www.gnu.org/licenses/>.
 -->
 
@@ -68,13 +68,23 @@
                 specific configuration options are configured in the
                 [Swap] section.</para>
 
-                <para>Swap units must be named after the devices they
-                control. Example: the swap device
+                <para>Swap units must be named after the devices
+                (resp. files) they control. Example: the swap device
                 <filename>/dev/sda5</filename> must be configured in a
                 unit file <filename>dev-sda5.swap</filename>. For
                 details about the escaping logic used to convert a
                 file system path to a unit name see
                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
+
+                <para>All swap units automatically get the appropriate
+                dependencies on the devices (resp. on the mount points
+                of the files) they are activated from.</para>
+
+                <para>Swap units with
+                <varname>DefaultDependencies=</varname> enabled
+                implicitly acquire a conflicting dependency to
+                <filename>umount.target</filename> so that they are
+                deactivated at shutdown.</para>
         </refsect1>
 
         <refsect1>
@@ -88,6 +98,13 @@
                 <para>If a swap device or file is configured in both
                 <filename>/etc/fstab</filename> and a unit file the
                 configuration in the latter takes precedence.</para>
+
+                <para>Unless the <option>noauto</option> option is set
+                for them all swap units configured in
+                <filename>/etc/fstab</filename> are also added as
+                requirements to <filename>swap.target</filename>, so
+                that they are waited for and activated during
+                boot.</para>
         </refsect1>
 
         <refsect1>
@@ -149,7 +166,7 @@
                                 a time span value such as "5min
                                 20s". Pass 0 to disable the timeout
                                 logic. Defaults to
-                                60s.</para></listitem>
+                                90s.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
@@ -158,7 +175,6 @@
                                 processes of this swap shall be
                                 killed. One of
                                 <option>control-group</option>,
-                                <option>process-group</option>,
                                 <option>process</option>,
                                 <option>none</option>.</para>
 
@@ -176,6 +192,17 @@
                                 swap. Defaults to SIGTERM.
                                 </para></listitem>
                         </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>SendSIGKILL=</varname></term>
+                                <listitem><para>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".
+                                </para></listitem>
+                        </varlistentry>
                 </variablelist>
         </refsect1>