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

<?xml version='1.0'?> <!--*-nxml-*-->
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="systemd.swap">
        <refentryinfo>
                <title>systemd.swap</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>systemd.swap</refentrytitle>
                <manvolnum>5</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>systemd.swap</refname>
                <refpurpose>Swap unit configuration</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <para><filename>systemd.swap</filename></para>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para>A unit configuration file whose name ends in
                <filename>.swap</filename> encodes information about a
                swap device or file for memory paging controlled and
                supervised by systemd.</para>

                <para>This man page lists the configuration options
                specific to this unit type. See
                <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                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.</para>

                <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>
                <title><filename>fstab</filename></title>

                <para>Swap units may either be configured via unit
                files, or via <filename>/etc/fstab</filename> (see
                <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                for details). Swaps listed in
                <filename>/etc/fstab</filename> will be converted into
                native units dynamically at boot and when the
                configuration of the system manager is
                reloaded. See
                <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                for details about the conversion.</para>

                <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>
                <title>Options</title>

                <para>Swap files must include a [Swap] section, which
                carries information about the swap device it
                supervises. A number of options that may be used in
                this section are shared with other unit types. These
                options are documented in
                <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The
                options specific to the [Swap] section of swap units
                are the following:</para>

                <variablelist>

                        <varlistentry>
                                <term><varname>What=</varname></term>
                                <listitem><para>Takes an absolute path
                                of a device node or file to use for
                                paging. See
                                <citerefentry><refentrytitle>swapon</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                                for details. If this refers to a
                                device node, a dependency on the
                                respective device unit is
                                automatically created. (See
                                <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                                for more information.) If this refers
                                to a file, a dependency on the
                                respective mount unit is automatically
                                created. (See
                                <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                                for more information.) This option is
                                mandatory.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>Priority=</varname></term>

                                <listitem><para>Swap priority to use
                                when activating the swap device or
                                file. This takes an integer. This
                                setting is optional.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>TimeoutSec=</varname></term>
                                <listitem><para>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
                                <option>KillMode=</option> 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.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>KillMode=</varname></term>
                                <listitem><para>Specifies how
                                processes of this swap shall be
                                killed. One of
                                <option>control-group</option>,
                                <option>process</option>,
                                <option>none</option>.</para>

                                <para>This option is mostly equivalent
                                to the <option>KillMode=</option>
                                option of service files. See
                                <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                                for details.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>KillSignal=</varname></term>
                                <listitem><para>Specifies which signal
                                to use when killing a process of this
                                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>

        <refsect1>
                  <title>See Also</title>
                  <para>
                          <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                          <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                          <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                          <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                          <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                          <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                          <citerefentry><refentrytitle>swapon</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                          <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                  </para>
        </refsect1>

</refentry>
Commit	Line	Data
e0cabd4b LP	1	<?xml version='1.0'?> <!---nxml--->
	2	<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
	3	<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
	4	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
	5
	6	<!--
	7	This file is part of systemd.
	8
	9	Copyright 2010 Lennart Poettering
	10
	11	systemd is free software; you can redistribute it and/or modify it
5430f7f2 LP	12	under the terms of the GNU Lesser General Public License as published by
5430f7f2 LP	13	the Free Software Foundation; either version 2.1 of the License, or
e0cabd4b LP	14	(at your option) any later version.
	15
	16	systemd is distributed in the hope that it will be useful, but
	17	WITHOUT ANY WARRANTY; without even the implied warranty of
	18	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5430f7f2	19	Lesser General Public License for more details.
e0cabd4b	20
5430f7f2	21	You should have received a copy of the GNU Lesser General Public License
e0cabd4b LP	22	along with systemd; If not, see <http://www.gnu.org/licenses/>.
	23	-->
	24
	25	<refentry id="systemd.swap">
	26	<refentryinfo>
	27	<title>systemd.swap</title>
	28	<productname>systemd</productname>
	29
	30	<authorgroup>
	31	<author>
	32	<contrib>Developer</contrib>
	33	<firstname>Lennart</firstname>
	34	<surname>Poettering</surname>
	35	<email>lennart@poettering.net</email>
	36	</author>
	37	</authorgroup>
	38	</refentryinfo>
	39
	40	<refmeta>
	41	<refentrytitle>systemd.swap</refentrytitle>
	42	<manvolnum>5</manvolnum>
	43	</refmeta>
	44
	45	<refnamediv>
	46	<refname>systemd.swap</refname>
34511ca7	47	<refpurpose>Swap unit configuration</refpurpose>
e0cabd4b LP	48	</refnamediv>
	49
	50	<refsynopsisdiv>
	51	<para><filename>systemd.swap</filename></para>
	52	</refsynopsisdiv>
	53
	54	<refsect1>
	55	<title>Description</title>
	56
	57	<para>A unit configuration file whose name ends in
	58	<filename>.swap</filename> encodes information about a
	59	swap device or file for memory paging controlled and
	60	supervised by systemd.</para>
	61
	62	<para>This man page lists the configuration options
	63	specific to this unit type. See
	64	<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
	65	for the common options of all unit configuration
	66	files. The common configuration items are configured
	67	in the generic [Unit] and [Install] sections. The swap
	68	specific configuration options are configured in the
	69	[Swap] section.</para>
	70
f9276855 LP	71	<para>Swap units must be named after the devices
f9276855 LP	72	(resp. files) they control. Example: the swap device
e0cabd4b LP	73	<filename>/dev/sda5</filename> must be configured in a
	74	unit file <filename>dev-sda5.swap</filename>. For
	75	details about the escaping logic used to convert a
	76	file system path to a unit name see
	77	<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
f9276855 LP	78
	79	<para>All swap units automatically get the appropriate
	80	dependencies on the devices (resp. on the mount points
9f7dad77	81	of the files) they are activated from.</para>
f9276855 LP	82
	83	<para>Swap units with
	84	<varname>DefaultDependencies=</varname> enabled
	85	implicitly acquire a conflicting dependency to
	86	<filename>umount.target</filename> so that they are
	87	deactivated at shutdown.</para>
e0cabd4b LP	88	</refsect1>
	89
	90	<refsect1>
	91	<title><filename>fstab</filename></title>
	92
	93	<para>Swap units may either be configured via unit
	94	files, or via <filename>/etc/fstab</filename> (see
	95	<citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
059b37cc LP	96	for details). Swaps listed in
	97	<filename>/etc/fstab</filename> will be converted into
	98	native units dynamically at boot and when the
	99	configuration of the system manager is
	100	reloaded. See
	101	<citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
	102	for details about the conversion.</para>
e0cabd4b LP	103
	104	<para>If a swap device or file is configured in both
	105	<filename>/etc/fstab</filename> and a unit file the
	106	configuration in the latter takes precedence.</para>
f9276855 LP	107
	108	<para>Unless the <option>noauto</option> option is set
	109	for them all swap units configured in
	110	<filename>/etc/fstab</filename> are also added as
	111	requirements to <filename>swap.target</filename>, so
	112	that they are waited for and activated during
	113	boot.</para>
e0cabd4b LP	114	</refsect1>
	115
	116	<refsect1>
	117	<title>Options</title>
	118
	119	<para>Swap files must include a [Swap] section, which
	120	carries information about the swap device it
2292707d LP	121	supervises. A number of options that may be used in
	122	this section are shared with other unit types. These
	123	options are documented in
	124	<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The
	125	options specific to the [Swap] section of swap units
	126	are the following:</para>
e0cabd4b LP	127
	128	<variablelist>
	129
	130	<varlistentry>
	131	<term><varname>What=</varname></term>
	132	<listitem><para>Takes an absolute path
	133	of a device node or file to use for
	134	paging. See
	135	<citerefentry><refentrytitle>swapon</refentrytitle><manvolnum>8</manvolnum></citerefentry>
	136	for details. If this refers to a
b439c6ee	137	device node, a dependency on the
e0cabd4b LP	138	respective device unit is
	139	automatically created. (See
	140	<citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>
	141	for more information.) If this refers
b439c6ee	142	to a file, a dependency on the
e0cabd4b LP	143	respective mount unit is automatically
	144	created. (See
	145	<citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
	146	for more information.) This option is
	147	mandatory.</para></listitem>
	148	</varlistentry>
	149
	150	<varlistentry>
	151	<term><varname>Priority=</varname></term>
	152
	153	<listitem><para>Swap priority to use
	154	when activating the swap device or
	155	file. This takes an integer. This
	156	setting is optional.</para></listitem>
	157	</varlistentry>
2292707d LP	158
	159	<varlistentry>
	160	<term><varname>TimeoutSec=</varname></term>
	161	<listitem><para>Configures the time to
	162	wait for the swapon command to
	163	finish. If a command does not exit
	164	within the configured time the swap
	165	will be considered failed and be shut
	166	down again. All commands still running
	167	will be terminated forcibly via
	168	SIGTERM, and after another delay of
	169	this time with SIGKILL. (See
	170	<option>KillMode=</option> below.)
	171	Takes a unit-less value in seconds, or
	172	a time span value such as "5min
	173	20s". Pass 0 to disable the timeout
	174	logic. Defaults to
ecb963cc	175	90s.</para></listitem>
2292707d LP	176	</varlistentry>
	177
	178	<varlistentry>
	179	<term><varname>KillMode=</varname></term>
	180	<listitem><para>Specifies how
	181	processes of this swap shall be
	182	killed. One of
	183	<option>control-group</option>,
2292707d LP	184	<option>process</option>,
	185	<option>none</option>.</para>
	186
	187	<para>This option is mostly equivalent
	188	to the <option>KillMode=</option>
	189	option of service files. See
	190	<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
	191	for details.</para></listitem>
	192	</varlistentry>
	193
	194	<varlistentry>
	195	<term><varname>KillSignal=</varname></term>
	196	<listitem><para>Specifies which signal
	197	to use when killing a process of this
	198	swap. Defaults to SIGTERM.
	199	</para></listitem>
	200	</varlistentry>
ba035df2 LP	201
	202	<varlistentry>
	203	<term><varname>SendSIGKILL=</varname></term>
	204	<listitem><para>Specifies whether to
	205	send SIGKILL to remaining processes
	206	after a timeout, if the normal
	207	shutdown procedure left processes of
	208	the swap around. Takes a boolean
	209	value. Defaults to "yes".
	210	</para></listitem>
	211	</varlistentry>
e0cabd4b LP	212	</variablelist>
	213	</refsect1>
	214
	215	<refsect1>
	216	<title>See Also</title>
	217	<para>
f3e219a2	218	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
e0cabd4b LP	219	<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
e0cabd4b LP	220	<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2292707d	221	<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
e0cabd4b LP	222	<citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
e0cabd4b LP	223	<citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
059b37cc LP	224	<citerefentry><refentrytitle>swapon</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
059b37cc LP	225	<citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
e0cabd4b LP	226	</para>
	227	</refsect1>
	228
	229	</refentry>