man/systemd.kill.xml

   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>Process killing procedure
  48     configuration</refpurpose>
  49   </refnamediv>
  50
  51   <refsynopsisdiv>
  52     <para><filename><replaceable>service</replaceable>.service</filename>,
  53     <filename><replaceable>socket</replaceable>.socket</filename>,
  54     <filename><replaceable>mount</replaceable>.mount</filename>,
  55     <filename><replaceable>swap</replaceable>.swap</filename>,
  56     <filename><replaceable>scope</replaceable>.scope</filename></para>
  57   </refsynopsisdiv>
  58
  59   <refsect1>
  60     <title>Description</title>
  61
  62     <para>Unit configuration files for services, sockets, mount
  63     points, swap devices and scopes share a subset of configuration
  64     options which define the killing procedure of processes belonging
  65     to the unit.</para>
  66
  67     <para>This man page lists the configuration options shared by
  68     these five unit types. See
  69     <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  70     for the common options shared by all unit configuration files, and
  71     <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  72     <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  73     <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  74     <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  75     and
  76     <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  77     for more information on the configuration file options specific to
  78     each unit type.</para>
  79
  80     <para>The kill procedure configuration options are configured in
  81     the [Service], [Socket], [Mount] or [Swap] section, depending on
  82     the unit type.</para>
  83   </refsect1>
  84
  85   <refsect1>
  86     <title>Options</title>
  87
  88     <variablelist class='unit-directives'>
  89
  90       <varlistentry>
  91         <term><varname>KillMode=</varname></term>
  92         <listitem><para>Specifies how processes of this unit shall be
  93         killed. One of
  94         <option>control-group</option>,
  95         <option>process</option>,
  96         <option>mixed</option>,
  97         <option>none</option>.</para>
  98
  99         <para>If set to <option>control-group</option>, all remaining
 100         processes in the control group of this unit will be killed on
 101         unit stop (for services: after the stop command is executed,
 102         as configured with <varname>ExecStop=</varname>). If set to
 103         <option>process</option>, only the main process itself is
 104         killed. If set to <option>mixed</option>, the
 105         <constant>SIGTERM</constant> signal (see below) is sent to the
 106         main process while the subsequent <constant>SIGKILL</constant>
 107         signal (see below) is sent to all remaining processes of the
 108         unit's control group. If set to <option>none</option>, no
 109         process is killed. In this case, only the stop command will be
 110         executed on unit stop, but no process be killed otherwise.
 111         Processes remaining alive after stop are left in their control
 112         group and the control group continues to exist after stop
 113         unless it is empty.</para>
 114
 115         <para>Processes will first be terminated via
 116         <constant>SIGTERM</constant> (unless the signal to send is
 117         changed via <varname>KillSignal=</varname>). Optionally, this
 118         is immediately followed by a <constant>SIGHUP</constant> (if
 119         enabled with <varname>SendSIGHUP=</varname>). If then, after a
 120         delay (configured via the <varname>TimeoutStopSec=</varname>
 121         option), processes still remain, the termination request is
 122         repeated with the <constant>SIGKILL</constant> signal (unless
 123         this is disabled via the <varname>SendSIGKILL=</varname>
 124         option). See
 125         <citerefentry><refentrytitle>kill</refentrytitle><manvolnum>2</manvolnum></citerefentry>
 126         for more information.</para>
 127
 128         <para>Defaults to
 129         <option>control-group</option>.</para></listitem>
 130       </varlistentry>
 131
 132       <varlistentry>
 133         <term><varname>KillSignal=</varname></term>
 134         <listitem><para>Specifies which signal to use when killing a
 135         service. This controls the signal that is sent as first step
 136         of shutting down a unit (see above), and is usually followed
 137         by <constant>SIGKILL</constant> (see above and below). For a
 138         list of valid signals, see
 139         <citerefentry><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
 140         Defaults to <constant>SIGTERM</constant>. </para></listitem>
 141       </varlistentry>
 142
 143       <varlistentry>
 144         <term><varname>SendSIGHUP=</varname></term>
 145         <listitem><para>Specifies whether to send
 146         <constant>SIGHUP</constant> to remaining processes immediately
 147         after sending the signal configured with
 148         <varname>KillSignal=</varname>. This is useful to indicate to
 149         shells and shell-like programs that their connection has been
 150         severed. Takes a boolean value. Defaults to "no".
 151         </para></listitem>
 152       </varlistentry>
 153
 154       <varlistentry>
 155         <term><varname>SendSIGKILL=</varname></term>
 156         <listitem><para>Specifies whether to send
 157         <constant>SIGKILL</constant> to remaining processes after a
 158         timeout, if the normal shutdown procedure left processes of
 159         the service around. Takes a boolean value. Defaults to "yes".
 160         </para></listitem>
 161       </varlistentry>
 162
 163     </variablelist>
 164   </refsect1>
 165
 166   <refsect1>
 167       <title>See Also</title>
 168       <para>
 169         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 170         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 171         <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 172         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 173         <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 174         <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 175         <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 176         <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 177         <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 178         <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
 179         <citerefentry><refentrytitle>kill</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
 180         <citerefentry><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>
 181       </para>
 182   </refsect1>
 183
 184 </refentry>