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 <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-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       <arg choice="opt">-W</arg>
  54       <arg choice="opt">-r</arg>
  55       <arg choice="opt">-t <replaceable>timeout</replaceable></arg>
  56       <arg choice="opt">-k</arg>
  57       <arg choice="opt">-s</arg>
  58     </cmdsynopsis>
  59   </refsynopsisdiv>
  60
  61   <refsect1>
  62     <title>Description</title>
  63
  64     <para>
  65       <command>lxc-stop</command> reboots, cleanly shuts down, or kills
  66       all the processes inside the container.  By default, it will
  67       request a clean shutdown of the container (by sending SIGPWR to
  68       the container), wait 60 seconds for the container to exit, and
  69       returns.  If the container fails to cleanly exit, then after 60
  70       seconds the container will be sent the
  71       <command>lxc.stopsignal</command> to force it to shut down.
  72     </para>
  73         <para>
  74         The <optional>-W</optional>, <optional>-r</optional>, <optional>-s</optional>
  75         and <optional>-k</optional> options specify the action to perform.
  76         <optional>-W</optional> indicates that after performing the specified
  77         action, <command>lxc-stop</command> should immediately exit, while
  78         <optional>-t TIMEOUT</optional> specifies the maximum amount of time
  79         to wait for the container to complete the shutdown or reboot.
  80         </para>
  81   </refsect1>
  82
  83   <refsect1>
  84     <title>Options</title>
  85     <variablelist>
  86
  87     <varlistentry>
  88         <term>
  89           <option>-r,--reboot </option>
  90         </term>
  91         <listitem>
  92           <para>
  93             Request a reboot of the container.
  94           </para>
  95         </listitem>
  96         </varlistentry>
  97
  98     <varlistentry>
  99         <term>
 100           <option>-s,--shutdown </option>
 101         </term>
 102         <listitem>
 103           <para>
 104             Only request a clean shutdown, do not kill the container tasks if the
 105                 clean shutdown fails.
 106           </para>
 107         </listitem>
 108         </varlistentry>
 109
 110     <varlistentry>
 111         <term>
 112           <option>-k,--kill </option>
 113         </term>
 114         <listitem>
 115           <para>
 116         Rather than requesting a clean shutdown of the container, explicitly
 117         kill all tasks in the container.  This is the legacy
 118         <command>lxc-stop</command> behavior.
 119           </para>
 120         </listitem>
 121         </varlistentry>
 122
 123     <varlistentry>
 124         <term>
 125           <option>-W,--nowait </option>
 126         </term>
 127         <listitem>
 128           <para>
 129             Simply perform the requestion action (reboot, shutdown, or hard
 130                 kill) and exit.
 131           </para>
 132         </listitem>
 133         </varlistentry>
 134
 135     <varlistentry>
 136         <term>
 137           <option>-t,--timeout <replaceable>TIMEOUT</replaceable></option>
 138         </term>
 139         <listitem>
 140           <para>
 141             Wait TIMEOUT seconds before hard-stopping the container of (in
 142                 the reboot case) returning failure.
 143           </para>
 144         </listitem>
 145         </varlistentry>
 146
 147   </variablelist>
 148   </refsect1>
 149
 150   <refsect1>
 151     <title>Diagnostic</title>
 152
 153     <variablelist>
 154
 155       <varlistentry>
 156         <term>The container is busy</term>
 157         <listitem>
 158           <para>
 159             The specified container is already running an
 160             application. You should stop it before reuse this
 161             container or create a new one.
 162           </para>
 163         </listitem>
 164       </varlistentry>
 165
 166       <varlistentry>
 167         <term>The container was not found</term>
 168         <listitem>
 169           <para>
 170             The specified container was not created before with
 171             the <command>lxc-create</command> command.
 172           </para>
 173         </listitem>
 174       </varlistentry>
 175
 176     </variablelist>
 177
 178   </refsect1>
 179
 180   &seealso;
 181
 182   <refsect1>
 183     <title>Author</title>
 184     <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 185   </refsect1>
 186
 187 </refentry>
 188
 189 <!-- Keep this comment at the end of the file
 190 Local variables:
 191 mode: sgml
 192 sgml-omittag:t
 193 sgml-shorttag:t
 194 sgml-minimize-attributes:nil
 195 sgml-always-quote-attributes:t
 196 sgml-indent-step:2
 197 sgml-indent-data:t
 198 sgml-parent-document:nil
 199 sgml-default-dtd-file:nil
 200 sgml-exposed-tags:nil
 201 sgml-local-catalogs:nil
 202 sgml-local-ecat-files:nil
 203 End:
 204 -->