X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.swap.xml;h=1155758e28d86aeed6b095278edaab8a80412917;hp=aaf77f8396554e2dfafc280f8d18589fd6366ad2;hb=9b15b7846d4de01bb5d9700a24077787e984e8ab;hpb=34511ca7b166b0e89d08ff9870b0cf2624a7815f diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml index aaf77f839..1155758e2 100644 --- a/man/systemd.swap.xml +++ b/man/systemd.swap.xml @@ -48,14 +48,14 @@ - systemd.swap + swap.swap Description A 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 activated from. + dependencies on the devices or on the mount points + of the files they are activated from. Swap units with DefaultDependencies= enabled @@ -102,15 +114,43 @@ 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. Option + has the opposite meaning and + is the default. + + + @@ -121,11 +161,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= @@ -156,73 +198,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 Also systemd1, - systemctl8, + systemctl1, systemd.unit5, systemd.exec5, + systemd.kill5, + systemd.resource-control5, systemd.device5, systemd.mount5, swapon8, - systemd-fstab-generator8 + systemd-fstab-generator8, + systemd.directives7