[systemd.git] / man / systemd.kill.html

<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>systemd.kill</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><style>
    a.headerlink {
      color: #c60f0f;
      font-size: 0.8em;
      padding: 0 4px 0 4px;
      text-decoration: none;
      visibility: hidden;
    }

    a.headerlink:hover {
      background-color: #c60f0f;
      color: white;
    }

    h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, dt:hover > a.headerlink {
      visibility: visible;
    }
  </style><a href="index.html">Index </a>·
  <a href="systemd.directives.html">Directives </a>·
  <a href="../python-systemd/index.html">Python </a>·
  <a href="../libudev/index.html">libudev </a>·
  <a href="../libudev/index.html">gudev </a><span style="float:right">systemd 208</span><hr><div class="refentry"><a name="systemd.kill"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>systemd.kill — Kill environment configuration</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><p><code class="filename"><em class="replaceable"><code>service</code></em>.service</code>,
                <code class="filename"><em class="replaceable"><code>socket</code></em>.socket</code>,
                <code class="filename"><em class="replaceable"><code>mount</code></em>.mount</code>,
                <code class="filename"><em class="replaceable"><code>swap</code></em>.swap</code></p></div><div class="refsect1"><a name="idm274703190640"></a><h2 id="Description">Description<a class="headerlink" title="Permalink to this headline" href="#Description">¶</a></h2><p>Unit configuration files for services, sockets,
                mount points and swap devices share a subset of
                configuration options which define the process killing
                parameters of spawned processes.</p><p>This man page lists the configuration options
                shared by these four unit types. See
                <a href="systemd.unit.html"><span class="citerefentry"><span class="refentrytitle">systemd.unit</span>(5)</span></a>
                for the common options of all unit configuration
                files, and
                <a href="systemd.service.html"><span class="citerefentry"><span class="refentrytitle">systemd.service</span>(5)</span></a>,
                <a href="systemd.socket.html"><span class="citerefentry"><span class="refentrytitle">systemd.socket</span>(5)</span></a>,
                <a href="systemd.swap.html"><span class="citerefentry"><span class="refentrytitle">systemd.swap</span>(5)</span></a>
                and
                <a href="systemd.mount.html"><span class="citerefentry"><span class="refentrytitle">systemd.mount</span>(5)</span></a>
                for more information on the specific unit
                configuration files. The execution specific
                configuration options are configured in the [Service],
                [Socket], [Mount], or [Swap] section, depending on the unit
                type.</p></div><div class="refsect1"><a name="idm274703062000"></a><h2 id="Options">Options<a class="headerlink" title="Permalink to this headline" href="#Options">¶</a></h2><div class="variablelist"><dl class="variablelist"><dt id="KillMode="><span class="term"><code class="varname">KillMode=</code></span><a class="headerlink" title="Permalink to this term" href="#KillMode=">¶</a></dt><dd><p>Specifies how
                                processes of this service shall be
                                killed. One of
                                <code class="option">control-group</code>,
                                <code class="option">process</code>,
                                <code class="option">none</code>.</p><p>If set to
                                <code class="option">control-group</code>, all
                                remaining processes in the control
                                group of this unit will be terminated
                                on unit stop (for services: after the
                                stop command is executed, as
                                configured with
                                <code class="varname">ExecStop=</code>). If set
                                to <code class="option">process</code>, only the
                                main process itself is killed. If set
                                to <code class="option">none</code>, 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. Defaults to
                                <code class="option">control-group</code>.</p><p>Processes will first be
                                terminated via
                                <code class="constant">SIGTERM</code> (unless
                                the signal to send is changed via
                                <code class="varname">KillSignal=</code>). Optionally,
                                this is immediately followed by a
                                <code class="constant">SIGHUP</code> (if
                                enabled with
                                <code class="varname">SendSIGHUP=</code>). If
                                then, after a delay (configured via the
                                <code class="varname">TimeoutStopSec=</code> option),
                                processes still remain, the
                                termination request is repeated with
                                the <code class="constant">SIGKILL</code>
                                signal (unless this is disabled via
                                the <code class="varname">SendSIGKILL=</code>
                                option). See
                                <a href="kill.html"><span class="citerefentry"><span class="refentrytitle">kill</span>(2)</span></a>
                                for more
                                information.</p></dd><dt id="KillSignal="><span class="term"><code class="varname">KillSignal=</code></span><a class="headerlink" title="Permalink to this term" href="#KillSignal=">¶</a></dt><dd><p>Specifies which signal
                                to use when killing a
                                service. Defaults to <code class="constant">SIGTERM</code>.
                                </p></dd><dt id="SendSIGHUP="><span class="term"><code class="varname">SendSIGHUP=</code></span><a class="headerlink" title="Permalink to this term" href="#SendSIGHUP=">¶</a></dt><dd><p>Specifies whether to
                                send <code class="constant">SIGHUP</code> to
                                remaining processes immediately after
                                sending the signal configured with
                                <code class="varname">KillSignal=</code>. This
                                is useful to indicate to shells and
                                shell-like programs that their
                                connection has been severed. Takes a
                                boolean value. Defaults to "no".
                                </p></dd><dt id="SendSIGKILL="><span class="term"><code class="varname">SendSIGKILL=</code></span><a class="headerlink" title="Permalink to this term" href="#SendSIGKILL=">¶</a></dt><dd><p>Specifies whether to
                                send <code class="constant">SIGKILL</code> to remaining processes
                                after a timeout, if the normal
                                shutdown procedure left processes of
                                the service around. Takes a boolean
                                value. Defaults to "yes".
                                </p></dd></dl></div></div><div class="refsect1"><a name="idm274703240528"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also">¶</a></h2><p>
                          <a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>,
                          <a href="systemctl.html"><span class="citerefentry"><span class="refentrytitle">systemctl</span>(8)</span></a>,
                          <a href="journalctl.html"><span class="citerefentry"><span class="refentrytitle">journalctl</span>(8)</span></a>,
                          <a href="systemd.unit.html"><span class="citerefentry"><span class="refentrytitle">systemd.unit</span>(5)</span></a>,
                          <a href="systemd.service.html"><span class="citerefentry"><span class="refentrytitle">systemd.service</span>(5)</span></a>,
                          <a href="systemd.socket.html"><span class="citerefentry"><span class="refentrytitle">systemd.socket</span>(5)</span></a>,
                          <a href="systemd.swap.html"><span class="citerefentry"><span class="refentrytitle">systemd.swap</span>(5)</span></a>,
                          <a href="systemd.mount.html"><span class="citerefentry"><span class="refentrytitle">systemd.mount</span>(5)</span></a>,
                          <a href="systemd.exec.html"><span class="citerefentry"><span class="refentrytitle">systemd.exec</span>(5)</span></a>,
                          <a href="systemd.directives.html"><span class="citerefentry"><span class="refentrytitle">systemd.directives</span>(7)</span></a>
                  </p></div></div></body></html>
Commit	Line	Data
663996b3 MS	1	<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>systemd.kill</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><style>
	2	a.headerlink {
	3	color: #c60f0f;
	4	font-size: 0.8em;
	5	padding: 0 4px 0 4px;
	6	text-decoration: none;
	7	visibility: hidden;
	8	}
	9
	10	a.headerlink:hover {
	11	background-color: #c60f0f;
	12	color: white;
	13	}
	14
	15	h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, dt:hover > a.headerlink {
	16	visibility: visible;
	17	}
	18	</style><a href="index.html">Index </a>·
	19	<a href="systemd.directives.html">Directives </a>·
	20	<a href="../python-systemd/index.html">Python </a>·
	21	<a href="../libudev/index.html">libudev </a>·
14228c0d	22	<a href="../libudev/index.html">gudev </a><span style="float:right">systemd 208</span><hr><div class="refentry"><a name="systemd.kill"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>systemd.kill — Kill environment configuration</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><p><code class="filename"><em class="replaceable"><code>service</code></em>.service</code>,
663996b3 MS	23	<code class="filename"><em class="replaceable"><code>socket</code></em>.socket</code>,
663996b3 MS	24	<code class="filename"><em class="replaceable"><code>mount</code></em>.mount</code>,
14228c0d	25	<code class="filename"><em class="replaceable"><code>swap</code></em>.swap</code></p></div><div class="refsect1"><a name="idm274703190640"></a><h2 id="Description">Description<a class="headerlink" title="Permalink to this headline" href="#Description">¶</a></h2><p>Unit configuration files for services, sockets,
663996b3 MS	26	mount points and swap devices share a subset of
	27	configuration options which define the process killing
	28	parameters of spawned processes.</p><p>This man page lists the configuration options
	29	shared by these four unit types. See
	30	<a href="systemd.unit.html"><span class="citerefentry"><span class="refentrytitle">systemd.unit</span>(5)</span></a>
	31	for the common options of all unit configuration
	32	files, and
	33	<a href="systemd.service.html"><span class="citerefentry"><span class="refentrytitle">systemd.service</span>(5)</span></a>,
	34	<a href="systemd.socket.html"><span class="citerefentry"><span class="refentrytitle">systemd.socket</span>(5)</span></a>,
	35	<a href="systemd.swap.html"><span class="citerefentry"><span class="refentrytitle">systemd.swap</span>(5)</span></a>
	36	and
	37	<a href="systemd.mount.html"><span class="citerefentry"><span class="refentrytitle">systemd.mount</span>(5)</span></a>
	38	for more information on the specific unit
	39	configuration files. The execution specific
	40	configuration options are configured in the [Service],
	41	[Socket], [Mount], or [Swap] section, depending on the unit
14228c0d	42	type.</p></div><div class="refsect1"><a name="idm274703062000"></a><h2 id="Options">Options<a class="headerlink" title="Permalink to this headline" href="#Options">¶</a></h2><div class="variablelist"><dl class="variablelist"><dt id="KillMode="><span class="term"><code class="varname">KillMode=</code></span><a class="headerlink" title="Permalink to this term" href="#KillMode=">¶</a></dt><dd><p>Specifies how
663996b3 MS	43	processes of this service shall be
	44	killed. One of
	45	<code class="option">control-group</code>,
	46	<code class="option">process</code>,
	47	<code class="option">none</code>.</p><p>If set to
14228c0d	48	<code class="option">control-group</code>, all
663996b3 MS	49	remaining processes in the control
	50	group of this unit will be terminated
	51	on unit stop (for services: after the
	52	stop command is executed, as
	53	configured with
	54	<code class="varname">ExecStop=</code>). If set
14228c0d	55	to <code class="option">process</code>, only the
663996b3	56	main process itself is killed. If set
14228c0d	57	to <code class="option">none</code>, no process is
663996b3 MS	58	killed. In this case only the stop
	59	command will be executed on unit
	60	stop, but no process be killed
	61	otherwise. Processes remaining alive
	62	after stop are left in their control
	63	group and the control group continues
	64	to exist after stop unless it is
	65	empty. Defaults to
	66	<code class="option">control-group</code>.</p><p>Processes will first be
14228c0d MB	67	terminated via
	68	<code class="constant">SIGTERM</code> (unless
	69	the signal to send is changed via
	70	<code class="varname">KillSignal=</code>). Optionally,
	71	this is immediately followed by a
	72	<code class="constant">SIGHUP</code> (if
	73	enabled with
	74	<code class="varname">SendSIGHUP=</code>). If
	75	then, after a delay (configured via the
	76	<code class="varname">TimeoutStopSec=</code> option),
663996b3 MS	77	processes still remain, the
663996b3 MS	78	termination request is repeated with
14228c0d MB	79	the <code class="constant">SIGKILL</code>
	80	signal (unless this is disabled via
	81	the <code class="varname">SendSIGKILL=</code>
663996b3 MS	82	option). See
	83	<a href="kill.html"><span class="citerefentry"><span class="refentrytitle">kill</span>(2)</span></a>
	84	for more
	85	information.</p></dd><dt id="KillSignal="><span class="term"><code class="varname">KillSignal=</code></span><a class="headerlink" title="Permalink to this term" href="#KillSignal=">¶</a></dt><dd><p>Specifies which signal
	86	to use when killing a
14228c0d MB	87	service. Defaults to <code class="constant">SIGTERM</code>.
	88	</p></dd><dt id="SendSIGHUP="><span class="term"><code class="varname">SendSIGHUP=</code></span><a class="headerlink" title="Permalink to this term" href="#SendSIGHUP=">¶</a></dt><dd><p>Specifies whether to
	89	send <code class="constant">SIGHUP</code> to
	90	remaining processes immediately after
	91	sending the signal configured with
	92	<code class="varname">KillSignal=</code>. This
	93	is useful to indicate to shells and
	94	shell-like programs that their
	95	connection has been severed. Takes a
	96	boolean value. Defaults to "no".
663996b3	97	</p></dd><dt id="SendSIGKILL="><span class="term"><code class="varname">SendSIGKILL=</code></span><a class="headerlink" title="Permalink to this term" href="#SendSIGKILL=">¶</a></dt><dd><p>Specifies whether to
14228c0d	98	send <code class="constant">SIGKILL</code> to remaining processes
663996b3 MS	99	after a timeout, if the normal
	100	shutdown procedure left processes of
	101	the service around. Takes a boolean
	102	value. Defaults to "yes".
14228c0d	103	</p></dd></dl></div></div><div class="refsect1"><a name="idm274703240528"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also">¶</a></h2><p>
663996b3 MS	104	<a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>,
	105	<a href="systemctl.html"><span class="citerefentry"><span class="refentrytitle">systemctl</span>(8)</span></a>,
	106	<a href="journalctl.html"><span class="citerefentry"><span class="refentrytitle">journalctl</span>(8)</span></a>,
	107	<a href="systemd.unit.html"><span class="citerefentry"><span class="refentrytitle">systemd.unit</span>(5)</span></a>,
	108	<a href="systemd.service.html"><span class="citerefentry"><span class="refentrytitle">systemd.service</span>(5)</span></a>,
	109	<a href="systemd.socket.html"><span class="citerefentry"><span class="refentrytitle">systemd.socket</span>(5)</span></a>,
	110	<a href="systemd.swap.html"><span class="citerefentry"><span class="refentrytitle">systemd.swap</span>(5)</span></a>,
	111	<a href="systemd.mount.html"><span class="citerefentry"><span class="refentrytitle">systemd.mount</span>(5)</span></a>,
	112	<a href="systemd.exec.html"><span class="citerefentry"><span class="refentrytitle">systemd.exec</span>(5)</span></a>,
	113	<a href="systemd.directives.html"><span class="citerefentry"><span class="refentrytitle">systemd.directives</span>(7)</span></a>
	114	</p></div></div></body></html>