doc/lxc-stop.sgml.in

   1 <!--
   2
   3 lxc: linux Container library
   4
   5 (C) Copyright IBM Corp. 2007, 2008
   6
   7 Authors:
   8 Daniel Lezcano <dlezcano at fr.ibm.com>
   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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  23
  24 -->
  25
  26 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN">
  27
  28 <refentry>
  29
  30   <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
  31
  32   <refmeta>
  33     <refentrytitle>lxc-stop</refentrytitle>
  34     <manvolnum>1</manvolnum>
  35   </refmeta>
  36
  37   <refnamediv>
  38     <refname>lxc-stop</refname>
  39
  40     <refpurpose>
  41       stop the application running inside a container
  42     </refpurpose>
  43   </refnamediv>
  44
  45   <refsynopsisdiv>
  46     <cmdsynopsis>
  47       <command>lxc-stop <replaceable>-n name</replaceable>
  48       </command>
  49     </cmdsynopsis>
  50   </refsynopsisdiv>
  51
  52   <refsect1>
  53     <title>Description</title>
  54
  55     <para>
  56       <command>lxc-stop</command> kills all the processes inside the
  57       container. This command should be used if the processes are no
  58       longer accessible and can no be exited normally.
  59     </para>
  60
  61   </refsect1>
  62
  63   <refsect1>
  64     <title>Options</title>
  65     <variablelist>
  66
  67       <varlistentry>
  68         <term>
  69           <option>-n <replaceable>name</replaceable></option>
  70         </term>
  71         <listitem>
  72           <para>
  73             Specify the container name to be stopped.
  74           </para>
  75         </listitem>
  76       </varlistentry>
  77
  78     </variablelist>
  79
  80   </refsect1>
  81
  82   <refsect1>
  83     <title>Diagnostic</title>
  84
  85     <variablelist>
  86
  87       <varlistentry>
  88         <term>The container is busy</term>
  89         <listitem>
  90           <para>
  91             The specified container is already running an
  92             application. You should stop it before reuse this
  93             container or create a new one.
  94           </para>
  95         </listitem>
  96       </varlistentry>
  97
  98       <varlistentry>
  99         <term>The container was not found</term>
 100         <listitem>
 101           <para>
 102             The specified container was not created before with
 103             the <command>lxc-create</command> command.
 104           </para>
 105         </listitem>
 106       </varlistentry>
 107
 108
 109     </variablelist>
 110
 111   </refsect1>
 112
 113   <refsect1>
 114     <title>See Also</title>
 115
 116     <simpara>
 117       <citerefentry>
 118         <refentrytitle><command>lxc-start</command></refentrytitle>
 119         <manvolnum>1</manvolnum>
 120       </citerefentry>,
 121     </simpara>
 122
 123
 124   </refsect1>
 125
 126   <refsect1>
 127     <title>Author</title>
 128     <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 129   </refsect1>
 130
 131 </refentry>
 132
 133 <!-- Keep this comment at the end of the file
 134 Local variables:
 135 mode: sgml
 136 sgml-omittag:t
 137 sgml-shorttag:t
 138 sgml-minimize-attributes:nil
 139 sgml-always-quote-attributes:t
 140 sgml-indent-step:2
 141 sgml-indent-data:t
 142 sgml-parent-document:nil
 143 sgml-default-dtd-file:nil
 144 sgml-exposed-tags:nil
 145 sgml-local-catalogs:nil
 146 sgml-local-ecat-files:nil
 147 End:
 148 -->