lxc-kill.sgml.in revision 250b1eec71b074acdff1c5f6b5a1f0d7d2c20b77
<!--
lxc: linux Container library
(C) Copyright IBM Corp. 2007, 2008
Authors:
Daniel Lezcano <daniel.lezcano at free.fr>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
-->
<!DOCTYPE refentry PUBLIC @docdtd@ [
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]>
<refentry>
<docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
<refmeta>
<refentrytitle>lxc-kill</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>IBM</refmiscinfo>
</refmeta>
<refnamediv>
<refname>lxc-kill</refname>
<refpurpose>
Send a signal to the process 1 of the container.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>lxc-kill</command>
<arg choice="req">--name=<replaceable>NAME</replaceable></arg>
<arg choice="req"><replaceable>SIGNUM</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<command>lxc-kill</command> send
the <replaceable>SIGNUM</replaceable> signal to the first process of the container.
</para>
<para>
The <replaceable>SIGNUM</replaceable> is a numeric value,
the signal name is not supported.
</para>
<para>
If this command is used on an application container ran by
lxc-execute, the lxc-init will receive the signal and will forward it to
the process 2 which is the command specified in the command line. See
lxc-execute (1).
Obviously the SIGKILL and SIGSTOP signals are not able to be forwarded,
(as per the signal(7) man page).
</para>
</refsect1>
&commonoptions;
<refsect1>
<title>Examples</title>
<para>
To send the signal 26 to the process pi1 running in container
<literal>123</literal> :
</para>
<programlisting>
lxc-execute -n 123 -- pi1 -d 500000
lxc-kill --name=123 26
</programlisting>
</refsect1>
&seealso;
<refsect1>
<title>Author</title>
<para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->