]> git.proxmox.com Git - systemd.git/blob - man/systemd.kill.5
Imported Upstream version 218
[systemd.git] / man / systemd.kill.5
1 '\" t
2 .TH "SYSTEMD\&.KILL" "5" "" "systemd 218" "systemd.kill"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 systemd.kill \- Process killing procedure configuration
24 .SH "SYNOPSIS"
25 .PP
26 \fIservice\fR\&.service,
27 \fIsocket\fR\&.socket,
28 \fImount\fR\&.mount,
29 \fIswap\fR\&.swap,
30 \fIscope\fR\&.scope
31 .SH "DESCRIPTION"
32 .PP
33 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\&.
34 .PP
35 This man page lists the configuration options shared by these five unit types\&. See
36 \fBsystemd.unit\fR(5)
37 for the common options shared by all unit configuration files, and
38 \fBsystemd.service\fR(5),
39 \fBsystemd.socket\fR(5),
40 \fBsystemd.swap\fR(5),
41 \fBsystemd.mount\fR(5)
42 and
43 \fBsystemd.scope\fR(5)
44 for more information on the configuration file options specific to each unit type\&.
45 .PP
46 The kill procedure configuration options are configured in the [Service], [Socket], [Mount] or [Swap] section, depending on the unit type\&.
47 .SH "OPTIONS"
48 .PP
49 \fIKillMode=\fR
50 .RS 4
51 Specifies how processes of this unit shall be killed\&. One of
52 \fBcontrol\-group\fR,
53 \fBprocess\fR,
54 \fBmixed\fR,
55 \fBnone\fR\&.
56 .sp
57 If set to
58 \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
59 \fIExecStop=\fR)\&. If set to
60 \fBprocess\fR, only the main process itself is killed\&. If set to
61 \fBmixed\fR, the
62 \fBSIGTERM\fR
63 signal (see below) is sent to the main process while the subsequent
64 \fBSIGKILL\fR
65 signal (see below) is sent to all remaining processes of the unit\*(Aqs control group\&. If set to
66 \fBnone\fR, no process is killed\&. In this case, only the stop command will be executed on unit stop, but no process be killed otherwise\&. Processes remaining alive after stop are left in their control group and the control group continues to exist after stop unless it is empty\&.
67 .sp
68 Processes will first be terminated via
69 \fBSIGTERM\fR
70 (unless the signal to send is changed via
71 \fIKillSignal=\fR)\&. Optionally, this is immediately followed by a
72 \fBSIGHUP\fR
73 (if enabled with
74 \fISendSIGHUP=\fR)\&. If then, after a delay (configured via the
75 \fITimeoutStopSec=\fR
76 option), processes still remain, the termination request is repeated with the
77 \fBSIGKILL\fR
78 signal (unless this is disabled via the
79 \fISendSIGKILL=\fR
80 option)\&. See
81 \fBkill\fR(2)
82 for more information\&.
83 .sp
84 Defaults to
85 \fBcontrol\-group\fR\&.
86 .RE
87 .PP
88 \fIKillSignal=\fR
89 .RS 4
90 Specifies which signal to use when killing a service\&. This controls the signal that is sent as first step of shutting down a unit (see above), and is usually followed by
91 \fBSIGKILL\fR
92 (see above and below)\&. For a list of valid signals, see
93 \fBsignal\fR(7)\&. Defaults to
94 \fBSIGTERM\fR\&.
95 .RE
96 .PP
97 \fISendSIGHUP=\fR
98 .RS 4
99 Specifies whether to send
100 \fBSIGHUP\fR
101 to remaining processes immediately after sending the signal configured with
102 \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"\&.
103 .RE
104 .PP
105 \fISendSIGKILL=\fR
106 .RS 4
107 Specifies whether to send
108 \fBSIGKILL\fR
109 to remaining processes after a timeout, if the normal shutdown procedure left processes of the service around\&. Takes a boolean value\&. Defaults to "yes"\&.
110 .RE
111 .SH "SEE ALSO"
112 .PP
113 \fBsystemd\fR(1),
114 \fBsystemctl\fR(1),
115 \fBjournalctl\fR(8),
116 \fBsystemd.unit\fR(5),
117 \fBsystemd.service\fR(5),
118 \fBsystemd.socket\fR(5),
119 \fBsystemd.swap\fR(5),
120 \fBsystemd.mount\fR(5),
121 \fBsystemd.exec\fR(5),
122 \fBsystemd.directives\fR(7),
123 \fBkill\fR(2),
124 \fBsignal\fR(7)