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>Kill environment configuration</refpurpose>
  48         </refnamediv>
  49
  50         <refsynopsisdiv>
  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>
  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],
  78                 [Socket], [Mount], or [Swap] section, depending on the unit
  79                 type.</para>
  80         </refsect1>
  81
  82         <refsect1>
  83                 <title>Options</title>
  84
  85                 <variablelist class='unit-directives'>
  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
 119                                 <constant>SIGTERM</constant> (unless
 120                                 the signal to send is changed via
 121                                 <varname>KillSignal=</varname>). Optionally,
 122                                 this is immediately followed by a
 123                                 <constant>SIGHUP</constant> (if
 124                                 enabled with
 125                                 <varname>SendSIGHUP=</varname>). If
 126                                 then, after a delay (configured via the
 127                                 <varname>TimeoutStopSec=</varname> option),
 128                                 processes still remain, the
 129                                 termination request is repeated with
 130                                 the <constant>SIGKILL</constant>
 131                                 signal (unless this is disabled via
 132                                 the <varname>SendSIGKILL=</varname>
 133                                 option). See
 134                                 <citerefentry><refentrytitle>kill</refentrytitle><manvolnum>2</manvolnum></citerefentry>
 135                                 for more
 136                                 information.</para></listitem>
 137                         </varlistentry>
 138
 139                         <varlistentry>
 140                                 <term><varname>KillSignal=</varname></term>
 141                                 <listitem><para>Specifies which signal
 142                                 to use when killing a
 143                                 service. Defaults to <constant>SIGTERM</constant>.
 144                                 </para></listitem>
 145                         </varlistentry>
 146
 147                         <varlistentry>
 148                                 <term><varname>SendSIGHUP=</varname></term>
 149                                 <listitem><para>Specifies whether to
 150                                 send <constant>SIGHUP</constant> to
 151                                 remaining processes immediately after
 152                                 sending the signal configured with
 153                                 <varname>KillSignal=</varname>. This
 154                                 is useful to indicate to shells and
 155                                 shell-like programs that their
 156                                 connection has been severed. Takes a
 157                                 boolean value. Defaults to "no".
 158                                 </para></listitem>
 159                         </varlistentry>
 160
 161                         <varlistentry>
 162                                 <term><varname>SendSIGKILL=</varname></term>
 163                                 <listitem><para>Specifies whether to
 164                                 send <constant>SIGKILL</constant> to remaining processes
 165                                 after a timeout, if the normal
 166                                 shutdown procedure left processes of
 167                                 the service around. Takes a boolean
 168                                 value. Defaults to "yes".
 169                                 </para></listitem>
 170                         </varlistentry>
 171
 172                 </variablelist>
 173         </refsect1>
 174
 175         <refsect1>
 176                   <title>See Also</title>
 177                   <para>
 178                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 179                           <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 180                           <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 181                           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 182                           <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 183                           <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 184                           <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 185                           <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 186                           <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 187                           <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
 188                   </para>
 189         </refsect1>
 190
 191 </refentry>