man/systemd.swap.5

   1 '\" t
   2 .\"     Title: systemd.swap
   3 .\"    Author: Lennart Poettering <lennart@poettering.net>
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 02/15/2012
   6 .\"    Manual: systemd.swap
   7 .\"    Source: systemd
   8 .\"  Language: English
   9 .\"
  10 .TH "SYSTEMD\&.SWAP" "5" "02/15/2012" "systemd" "systemd.swap"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 systemd.swap \- systemd swap configuration files
  32 .SH "SYNOPSIS"
  33 .PP
  34 systemd\&.swap
  35 .SH "DESCRIPTION"
  36 .PP
  37 A unit configuration file whose name ends in
  38 \&.swap
  39 encodes information about a swap device or file for memory paging controlled and supervised by systemd\&.
  40 .PP
  41 This man page lists the configuration options specific to this unit type\&. See
  42 \fBsystemd.unit\fR(5)
  43 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\&.
  44 .PP
  45 Swap units must be named after the devices (resp\&. files) they control\&. Example: the swap device
  46 /dev/sda5
  47 must be configured in a unit file
  48 dev\-sda5\&.swap\&. For details about the escaping logic used to convert a file system path to a unit name see
  49 \fBsystemd.unit\fR(5)\&.
  50 .PP
  51 All swap units automatically get the appropriate dependencies on the devices (resp\&. on the mount points of the files) they are activated from\&.
  52 .PP
  53 Swap units with
  54 \fIDefaultDependencies=\fR
  55 enabled implicitly acquire a conflicting dependency to
  56 umount\&.target
  57 so that they are deactivated at shutdown\&.
  58 .SH "FSTAB"
  59 .PP
  60 Swap units may either be configured via unit files, or via
  61 /etc/fstab
  62 (see
  63 \fBfstab\fR(5)
  64 for details)\&.
  65 .PP
  66 If a swap device or file is configured in both
  67 /etc/fstab
  68 and a unit file the configuration in the latter takes precedence\&.
  69 .PP
  70 Unless the
  71 \fBnoauto\fR
  72 option is set for them all swap units configured in
  73 /etc/fstab
  74 are also added as requirements to
  75 swap\&.target, so that they are waited for and activated during boot\&.
  76 .SH "OPTIONS"
  77 .PP
  78 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
  79 \fBsystemd.exec\fR(5)\&. The options specific to the [Swap] section of swap units are the following:
  80 .PP
  81 \fIWhat=\fR
  82 .RS 4
  83 Takes an absolute path of a device node or file to use for paging\&. See
  84 \fBswapon\fR(8)
  85 for details\&. If this refers to a device node, a dependency on the respective device unit is automatically created\&. (See
  86 \fBsystemd.device\fR(5)
  87 for more information\&.) If this refers to a file, a dependency on the respective mount unit is automatically created\&. (See
  88 \fBsystemd.mount\fR(5)
  89 for more information\&.) This option is mandatory\&.
  90 .RE
  91 .PP
  92 \fIPriority=\fR
  93 .RS 4
  94 Swap priority to use when activating the swap device or file\&. This takes an integer\&. This setting is optional\&.
  95 .RE
  96 .PP
  97 \fITimeoutSec=\fR
  98 .RS 4
  99 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
 100 \fBKillMode=\fR
 101 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\&.
 102 .RE
 103 .PP
 104 \fIKillMode=\fR
 105 .RS 4
 106 Specifies how processes of this swap shall be killed\&. One of
 107 \fBcontrol\-group\fR,
 108 \fBprocess\fR,
 109 \fBnone\fR\&.
 110 .sp
 111 This option is mostly equivalent to the
 112 \fBKillMode=\fR
 113 option of service files\&. See
 114 \fBsystemd.service\fR(5)
 115 for details\&.
 116 .RE
 117 .PP
 118 \fIKillSignal=\fR
 119 .RS 4
 120 Specifies which signal to use when killing a process of this swap\&. Defaults to SIGTERM\&.
 121 .RE
 122 .PP
 123 \fISendSIGKILL=\fR
 124 .RS 4
 125 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"\&.
 126 .RE
 127 .SH "SEE ALSO"
 128 .PP
 129
 130 \fBsystemd\fR(1),
 131 \fBsystemctl\fR(8),
 132 \fBsystemd.unit\fR(5),
 133 \fBsystemd.exec\fR(5),
 134 \fBsystemd.device\fR(5),
 135 \fBsystemd.mount\fR(5),
 136 \fBswapon\fR(8)
 137 .SH "AUTHOR"
 138 .PP
 139 \fBLennart Poettering\fR <\&lennart@poettering\&.net\&>
 140 .RS 4
 141 Developer
 142 .RE