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 <!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-stop</refentrytitle>
  38     <manvolnum>1</manvolnum>
  39   </refmeta>
  40
  41   <refnamediv>
  42     <refname>lxc-stop</refname>
  43
  44     <refpurpose>
  45       stop the application running inside a container
  46     </refpurpose>
  47   </refnamediv>
  48
  49   <refsynopsisdiv>
  50     <cmdsynopsis>
  51       <command>lxc-stop</command>
  52       <arg choice="req">-n <replaceable>name</replaceable></arg>
  53     </cmdsynopsis>
  54   </refsynopsisdiv>
  55
  56   <refsect1>
  57     <title>Description</title>
  58
  59     <para>
  60       <command>lxc-stop</command> kills all the processes inside the
  61       container. This command should be used if the processes are no
  62       longer accessible and can no be exited normally.
  63     </para>
  64
  65   </refsect1>
  66
  67   &commonoptions;
  68
  69   <refsect1>
  70     <title>Diagnostic</title>
  71
  72     <variablelist>
  73
  74       <varlistentry>
  75         <term>The container is busy</term>
  76         <listitem>
  77           <para>
  78             The specified container is already running an
  79             application. You should stop it before reuse this
  80             container or create a new one.
  81           </para>
  82         </listitem>
  83       </varlistentry>
  84
  85       <varlistentry>
  86         <term>The container was not found</term>
  87         <listitem>
  88           <para>
  89             The specified container was not created before with
  90             the <command>lxc-create</command> command.
  91           </para>
  92         </listitem>
  93       </varlistentry>
  94
  95
  96     </variablelist>
  97
  98   </refsect1>
  99
 100   &seealso;
 101
 102   <refsect1>
 103     <title>Author</title>
 104     <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 105   </refsect1>
 106
 107 </refentry>
 108
 109 <!-- Keep this comment at the end of the file
 110 Local variables:
 111 mode: sgml
 112 sgml-omittag:t
 113 sgml-shorttag:t
 114 sgml-minimize-attributes:nil
 115 sgml-always-quote-attributes:t
 116 sgml-indent-step:2
 117 sgml-indent-data:t
 118 sgml-parent-document:nil
 119 sgml-default-dtd-file:nil
 120 sgml-exposed-tags:nil
 121 sgml-local-catalogs:nil
 122 sgml-local-ecat-files:nil
 123 End:
 124 -->