aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorgkurz@linux.vnet.ibm.com <gkurz@linux.vnet.ibm.com>2010-04-29 10:03:59 +0200
committerDaniel Lezcano <dlezcano@fr.ibm.com>2010-04-29 10:03:59 +0200
commite4b3fe5833cf5e8cb85389ceed8a00254c87b01f (patch)
tree434a17ac300ae001f19c9df85ecd7b1f3af0ffa9 /doc
parentman update lxc.conf (diff)
downloadlxc-e4b3fe5833cf5e8cb85389ceed8a00254c87b01f.tar.gz
lxc-e4b3fe5833cf5e8cb85389ceed8a00254c87b01f.tar.bz2
lxc-e4b3fe5833cf5e8cb85389ceed8a00254c87b01f.zip
lxc: introduce lxc-kill command (v4)
lxc-kill send a signal to the process 1 of the container. 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. Signed-off-by: Greg Kurz <gkurz@fr.ibm.com> Signed-off-by: Michel Normand <normand@fr.ibm.com> Signed-off-by: Daniel Lezcano <dlezcano@fr.ibm.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am1
-rw-r--r--doc/lxc-execute.sgml.in6
-rw-r--r--doc/lxc-kill.sgml.in91
-rw-r--r--doc/see_also.sgml.in5
4 files changed, 103 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index bd96c99..54e5f22 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -20,6 +20,7 @@ man_MANS = \
lxc-ls.1 \
lxc-ps.1 \
lxc-cgroup.1 \
+ lxc-kill.1 \
\
lxc.conf.5 \
\
diff --git a/doc/lxc-execute.sgml.in b/doc/lxc-execute.sgml.in
index fe51b9b..7bd0098 100644
--- a/doc/lxc-execute.sgml.in
+++ b/doc/lxc-execute.sgml.in
@@ -86,6 +86,12 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
container, <command>lxc-init</command> has the pid 1 and the
first process of the application has the pid 2.
</para>
+ <para>
+ The above <command>lxc-init</command> is designed to forward received
+ signals to the started command.
+ So <command>lxc-kill</command> (1) sent signal is received
+ by the user specified command (pid 2 in the container).
+ </para>
</refsect1>
<refsect1>
diff --git a/doc/lxc-kill.sgml.in b/doc/lxc-kill.sgml.in
new file mode 100644
index 0000000..c3373c6
--- /dev/null
+++ b/doc/lxc-kill.sgml.in
@@ -0,0 +1,91 @@
+<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
+
+<!ENTITY copyrights SYSTEM "@builddir@/copyrights.sgml">
+<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
+<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
+
+<!ENTITY mcr "<citerefentry>
+<refentrytitle><command>mcr</command></refentrytitle>
+<manvolnum/1/</citerefentry>">
+
+]>
+
+<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 --name=<replaceable>NAME</replaceable> <replaceable>SIGNUM</replaceable></command>
+ </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>
+ 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).
+ </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>
+
+ &copyrights;
+
+ &seealso;
+
+</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:
+-->
diff --git a/doc/see_also.sgml.in b/doc/see_also.sgml.in
index 93b9344..78b99b4 100644
--- a/doc/see_also.sgml.in
+++ b/doc/see_also.sgml.in
@@ -58,6 +58,11 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</citerefentry>,
<citerefentry>
+ <refentrytitle><command>lxc-kill</command></refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry>,
+
+ <citerefentry>
<refentrytitle><command>lxc-console</command></refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,