doc/lxc-kill.sgml.in

   1 <!--
   2
   3 lxc: linux Container library
   4
   5 (C) Copyright IBM Corp. 2007, 2008
   6
   7 Authors:
   8 Daniel Lezcano <daniel.lezcano at free.fr>
   9
  10 This library is free software; you can redistribute it and/or
  11 modify it under the terms of the GNU Lesser General Public
  12 License as published by the Free Software Foundation; either
  13 version 2.1 of the License, or (at your option) any later version.
  14
  15 This library is distributed in the hope that it will be useful,
  16 but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 Lesser General Public License for more details.
  19
  20 You should have received a copy of the GNU Lesser General Public
  21 License along with this library; if not, write to the Free Software
  22 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  23
  24 -->
  25
  26 <!DOCTYPE refentry PUBLIC @docdtd@ [
  27
  28 <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
  29 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
  30 ]>
  31
  32 <refentry>
  33
  34   <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
  35
  36   <refmeta>
  37     <refentrytitle>lxc-kill</refentrytitle>
  38     <manvolnum>1</manvolnum>
  39     <refmiscinfo>IBM</refmiscinfo>
  40   </refmeta>
  41
  42   <refnamediv>
  43     <refname>lxc-kill</refname>
  44
  45     <refpurpose>
  46       Send a signal to the process 1 of the container.
  47     </refpurpose>
  48   </refnamediv>
  49
  50   <refsynopsisdiv>
  51     <cmdsynopsis>
  52       <command>lxc-kill</command>
  53       <arg choice="req">--name=<replaceable>NAME</replaceable></arg>
  54       <arg choice="req"><replaceable>SIGNUM</replaceable></arg>
  55     </cmdsynopsis>
  56   </refsynopsisdiv>
  57
  58   <refsect1>
  59     <title>Description</title>
  60
  61     <para>
  62       <command>lxc-kill</command> send
  63       the <replaceable>SIGNUM</replaceable> signal to the first process of the container.
  64     </para>
  65     <para>
  66         The <replaceable>SIGNUM</replaceable> is a numeric value,
  67         the signal name is not supported.
  68     </para>
  69     <para>
  70         If this command is used on an application container ran by
  71         lxc-execute, the lxc-init will receive the signal and will forward it to
  72         the process 2 which is the command specified in the command line. See
  73         lxc-execute (1).
  74         Obviously the SIGKILL and SIGSTOP signals are not able to be forwarded,
  75         (as per the signal(7) man page).
  76     </para>
  77   </refsect1>
  78
  79   &commonoptions;
  80
  81   <refsect1>
  82     <title>Examples</title>
  83
  84     <para>
  85       To send the signal 26 to the process pi1 running in container
  86       <literal>123</literal> :
  87     </para>
  88
  89     <programlisting>
  90       lxc-execute -n 123 -- pi1 -d 500000
  91       lxc-kill --name=123 26
  92     </programlisting>
  93
  94   </refsect1>
  95
  96   &seealso;
  97
  98   <refsect1>
  99     <title>Author</title>
 100     <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 101   </refsect1>
 102
 103 </refentry>
 104
 105 <!-- Keep this comment at the end of the file
 106 Local variables:
 107 mode: sgml
 108 sgml-omittag:t
 109 sgml-shorttag:t
 110 sgml-minimize-attributes:nil
 111 sgml-always-quote-attributes:t
 112 sgml-indent-step:2
 113 sgml-indent-data:t
 114 sgml-parent-document:nil
 115 sgml-default-dtd-file:nil
 116 sgml-exposed-tags:nil
 117 sgml-local-catalogs:nil
 118 sgml-local-ecat-files:nil
 119 End:
 120 -->