]>
Commit | Line | Data |
---|---|---|
4819ff03 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 2012 Lennart Poettering | |
10 | ||
11 | systemd is free software; you can redistribute it and/or modify it | |
12 | under the terms of the GNU Lesser General Public License as published by | |
13 | the Free Software Foundation; either version 2.1 of the License, or | |
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 | |
19 | Lesser General Public License for more details. | |
20 | ||
21 | You should have received a copy of the GNU Lesser General Public License | |
22 | along with systemd; If not, see <http://www.gnu.org/licenses/>. | |
23 | --> | |
24 | ||
25 | <refentry id="systemd.kill"> | |
26 | <refentryinfo> | |
27 | <title>systemd.kill</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.kill</refentrytitle> | |
42 | <manvolnum>5</manvolnum> | |
43 | </refmeta> | |
44 | ||
45 | <refnamediv> | |
46 | <refname>systemd.kill</refname> | |
47 | <refpurpose>Kill environment configuration</refpurpose> | |
48 | </refnamediv> | |
49 | ||
50 | <refsynopsisdiv> | |
e670b166 ZJS |
51 | <para><filename><replaceable>service</replaceable>.service</filename>, |
52 | <filename><replaceable>socket</replaceable>.socket</filename>, | |
53 | <filename><replaceable>mount</replaceable>.mount</filename>, | |
54 | <filename><replaceable>swap</replaceable>.swap</filename></para> | |
4819ff03 LP |
55 | </refsynopsisdiv> |
56 | ||
57 | <refsect1> | |
58 | <title>Description</title> | |
59 | ||
60 | <para>Unit configuration files for services, sockets, | |
61 | mount points and swap devices share a subset of | |
62 | configuration options which define the process killing | |
63 | parameters of spawned processes.</para> | |
64 | ||
65 | <para>This man page lists the configuration options | |
66 | shared by these four unit types. See | |
67 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
68 | for the common options of all unit configuration | |
69 | files, and | |
70 | <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
71 | <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
72 | <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
73 | and | |
74 | <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
75 | for more information on the specific unit | |
76 | configuration files. The execution specific | |
77 | configuration options are configured in the [Service], | |
16dad32e | 78 | [Socket], [Mount], or [Swap] section, depending on the unit |
4819ff03 LP |
79 | type.</para> |
80 | </refsect1> | |
81 | ||
82 | <refsect1> | |
83 | <title>Options</title> | |
84 | ||
ccc9a4f9 | 85 | <variablelist class='unit-directives'> |
4819ff03 LP |
86 | |
87 | <varlistentry> | |
88 | <term><varname>KillMode=</varname></term> | |
89 | <listitem><para>Specifies how | |
90 | processes of this service shall be | |
91 | killed. One of | |
92 | <option>control-group</option>, | |
93 | <option>process</option>, | |
94 | <option>none</option>.</para> | |
95 | ||
96 | <para>If set to | |
97 | <option>control-group</option> all | |
98 | remaining processes in the control | |
99 | group of this unit will be terminated | |
100 | on unit stop (for services: after the | |
101 | stop command is executed, as | |
102 | configured with | |
103 | <varname>ExecStop=</varname>). If set | |
104 | to <option>process</option> only the | |
105 | main process itself is killed. If set | |
106 | to <option>none</option> no process is | |
107 | killed. In this case only the stop | |
108 | command will be executed on unit | |
109 | stop, but no process be killed | |
110 | otherwise. Processes remaining alive | |
111 | after stop are left in their control | |
112 | group and the control group continues | |
113 | to exist after stop unless it is | |
114 | empty. Defaults to | |
115 | <option>control-group</option>.</para> | |
116 | ||
117 | <para>Processes will first be | |
118 | terminated via SIGTERM (unless the | |
119 | signal to send is changed via | |
120 | <varname>KillSignal=</varname>). If | |
121 | then after a delay (configured via the | |
122 | <varname>TimeoutSec=</varname> option) | |
123 | processes still remain, the | |
124 | termination request is repeated with | |
125 | the SIGKILL signal (unless this is | |
126 | disabled via the | |
127 | <varname>SendSIGKILL=</varname> | |
128 | option). See | |
129 | <citerefentry><refentrytitle>kill</refentrytitle><manvolnum>2</manvolnum></citerefentry> | |
130 | for more | |
131 | information.</para></listitem> | |
132 | </varlistentry> | |
133 | ||
134 | <varlistentry> | |
135 | <term><varname>KillSignal=</varname></term> | |
136 | <listitem><para>Specifies which signal | |
137 | to use when killing a | |
138 | service. Defaults to SIGTERM. | |
139 | </para></listitem> | |
140 | </varlistentry> | |
141 | ||
142 | <varlistentry> | |
143 | <term><varname>SendSIGKILL=</varname></term> | |
144 | <listitem><para>Specifies whether to | |
145 | send SIGKILL to remaining processes | |
146 | after a timeout, if the normal | |
147 | shutdown procedure left processes of | |
148 | the service around. Takes a boolean | |
149 | value. Defaults to "yes". | |
150 | </para></listitem> | |
151 | </varlistentry> | |
152 | </variablelist> | |
153 | </refsect1> | |
154 | ||
155 | <refsect1> | |
156 | <title>See Also</title> | |
157 | <para> | |
158 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
159 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
160 | <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
161 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
162 | <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
163 | <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
164 | <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
165 | <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
9cc2c8b7 ZJS |
166 | <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
167 | <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> | |
4819ff03 LP |
168 | </para> |
169 | </refsect1> | |
170 | ||
171 | </refentry> |