diff options
Diffstat (limited to 'upstream/mageia-cauldron/man5/systemd.kill.5')
-rw-r--r-- | upstream/mageia-cauldron/man5/systemd.kill.5 | 225 |
1 files changed, 225 insertions, 0 deletions
diff --git a/upstream/mageia-cauldron/man5/systemd.kill.5 b/upstream/mageia-cauldron/man5/systemd.kill.5 new file mode 100644 index 00000000..f8379e5f --- /dev/null +++ b/upstream/mageia-cauldron/man5/systemd.kill.5 @@ -0,0 +1,225 @@ +'\" t +.TH "SYSTEMD\&.KILL" "5" "" "systemd 255" "systemd.kill" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +systemd.kill \- Process killing procedure configuration +.SH "SYNOPSIS" +.PP +\fIservice\fR\&.service, +\fIsocket\fR\&.socket, +\fImount\fR\&.mount, +\fIswap\fR\&.swap, +\fIscope\fR\&.scope +.SH "DESCRIPTION" +.PP +Unit configuration files for services, sockets, mount points, swap devices and scopes share a subset of configuration options which define the killing procedure of processes belonging to the unit\&. +.PP +This man page lists the configuration options shared by these five unit types\&. See +\fBsystemd.unit\fR(5) +for the common options shared by all unit configuration files, and +\fBsystemd.service\fR(5), +\fBsystemd.socket\fR(5), +\fBsystemd.swap\fR(5), +\fBsystemd.mount\fR(5) +and +\fBsystemd.scope\fR(5) +for more information on the configuration file options specific to each unit type\&. +.PP +The kill procedure configuration options are configured in the [Service], [Socket], [Mount] or [Swap] section, depending on the unit type\&. +.SH "OPTIONS" +.PP +\fIKillMode=\fR +.RS 4 +Specifies how processes of this unit shall be killed\&. One of +\fBcontrol\-group\fR, +\fBmixed\fR, +\fBprocess\fR, +\fBnone\fR\&. +.sp +If set to +\fBcontrol\-group\fR, all remaining processes in the control group of this unit will be killed on unit stop (for services: after the stop command is executed, as configured with +\fIExecStop=\fR)\&. If set to +\fBmixed\fR, the +\fBSIGTERM\fR +signal (see below) is sent to the main process while the subsequent +\fBSIGKILL\fR +signal (see below) is sent to all remaining processes of the unit\*(Aqs control group\&. If set to +\fBprocess\fR, only the main process itself is killed (not recommended!)\&. If set to +\fBnone\fR, no process is killed (strongly recommended against!)\&. In this case, only the stop command will be executed on unit stop, but no process will be killed otherwise\&. Processes remaining alive after stop are left in their control group and the control group continues to exist after stop unless empty\&. +.sp +Note that it is not recommended to set +\fIKillMode=\fR +to +\fBprocess\fR +or even +\fBnone\fR, as this allows processes to escape the service manager\*(Aqs lifecycle and resource management, and to remain running even while their service is considered stopped and is assumed to not consume any resources\&. +.sp +Processes will first be terminated via +\fBSIGTERM\fR +(unless the signal to send is changed via +\fIKillSignal=\fR +or +\fIRestartKillSignal=\fR)\&. Optionally, this is immediately followed by a +\fBSIGHUP\fR +(if enabled with +\fISendSIGHUP=\fR)\&. If processes still remain after: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +the main process of a unit has exited (applies to +\fIKillMode=\fR: +\fBmixed\fR) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +the delay configured via the +\fITimeoutStopSec=\fR +has passed (applies to +\fIKillMode=\fR: +\fBcontrol\-group\fR, +\fBmixed\fR, +\fBprocess\fR) +.RE +.sp +the termination request is repeated with the +\fBSIGKILL\fR +signal or the signal specified via +\fIFinalKillSignal=\fR +(unless this is disabled via the +\fISendSIGKILL=\fR +option)\&. See +\fBkill\fR(2) +for more information\&. +.sp +Defaults to +\fBcontrol\-group\fR\&. +.sp +Added in version 187\&. +.RE +.PP +\fIKillSignal=\fR +.RS 4 +Specifies which signal to use when stopping a service\&. This controls the signal that is sent as first step of shutting down a unit (see above), and is usually followed by +\fBSIGKILL\fR +(see above and below)\&. For a list of valid signals, see +\fBsignal\fR(7)\&. Defaults to +\fBSIGTERM\fR\&. +.sp +Note that, right after sending the signal specified in this setting, systemd will always send +\fBSIGCONT\fR, to ensure that even suspended tasks can be terminated cleanly\&. +.sp +Added in version 187\&. +.RE +.PP +\fIRestartKillSignal=\fR +.RS 4 +Specifies which signal to use when restarting a service\&. The same as +\fIKillSignal=\fR +described above, with the exception that this setting is used in a restart job\&. Not set by default, and the value of +\fIKillSignal=\fR +is used\&. +.sp +Added in version 244\&. +.RE +.PP +\fISendSIGHUP=\fR +.RS 4 +Specifies whether to send +\fBSIGHUP\fR +to remaining processes immediately after sending the signal configured with +\fIKillSignal=\fR\&. This is useful to indicate to shells and shell\-like programs that their connection has been severed\&. Takes a boolean value\&. Defaults to +"no"\&. +.sp +Added in version 207\&. +.RE +.PP +\fISendSIGKILL=\fR +.RS 4 +Specifies whether to send +\fBSIGKILL\fR +(or the signal specified by +\fIFinalKillSignal=\fR) to remaining processes after a timeout, if the normal shutdown procedure left processes of the service around\&. When disabled, a +\fIKillMode=\fR +of +\fBcontrol\-group\fR +or +\fBmixed\fR +service will not restart if processes from prior services exist within the control group\&. Takes a boolean value\&. Defaults to +"yes"\&. +.sp +Added in version 187\&. +.RE +.PP +\fIFinalKillSignal=\fR +.RS 4 +Specifies which signal to send to remaining processes after a timeout if +\fISendSIGKILL=\fR +is enabled\&. The signal configured here should be one that is not typically caught and processed by services (\fBSIGTERM\fR +is not suitable)\&. Developers can find it useful to use this to generate a coredump to troubleshoot why a service did not terminate upon receiving the initial +\fBSIGTERM\fR +signal\&. This can be achieved by configuring +\fILimitCORE=\fR +and setting +\fIFinalKillSignal=\fR +to either +\fBSIGQUIT\fR +or +\fBSIGABRT\fR\&. Defaults to +\fBSIGKILL\fR\&. +.sp +Added in version 240\&. +.RE +.PP +\fIWatchdogSignal=\fR +.RS 4 +Specifies which signal to use to terminate the service when the watchdog timeout expires (enabled through +\fIWatchdogSec=\fR)\&. Defaults to +\fBSIGABRT\fR\&. +.sp +Added in version 240\&. +.RE +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemctl\fR(1), +\fBjournalctl\fR(1), +\fBsystemd.unit\fR(5), +\fBsystemd.service\fR(5), +\fBsystemd.socket\fR(5), +\fBsystemd.swap\fR(5), +\fBsystemd.mount\fR(5), +\fBsystemd.exec\fR(5), +\fBsystemd.directives\fR(7), +\fBkill\fR(2), +\fBsignal\fR(7) |