doc/lxc-destroy.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-destroy</refentrytitle>
  38     <manvolnum>1</manvolnum>
  39   </refmeta>
  40
  41   <refnamediv>
  42     <refname>lxc-destroy</refname>
  43
  44     <refpurpose>
  45       destroy a container.
  46     </refpurpose>
  47   </refnamediv>
  48
  49   <refsynopsisdiv>
  50     <cmdsynopsis>
  51       <command>lxc-destroy</command>
  52       <arg choice="req">-n <replaceable>name</replaceable></arg>
  53       <arg choice="opt">-f</arg>
  54       <arg choice="opt">-s</arg>
  55     </cmdsynopsis>
  56   </refsynopsisdiv>
  57
  58   <refsect1>
  59     <title>Description</title>
  60
  61     <para>
  62       <command>lxc-destroy</command> destroys the system object
  63       previously created by the <command>lxc-create</command> command.
  64     </para>
  65
  66   </refsect1>
  67
  68   <refsect1>
  69
  70     <title>Options</title>
  71
  72     <variablelist>
  73       <varlistentry>
  74         <term>
  75           <option>-f, --force</option>
  76         </term>
  77         <listitem>
  78           <para>
  79             If a container is running, stop it first.  If this option is
  80             not specified and the container is running, then
  81             <command>lxc-destroy</command> will be aborted.
  82           </para>
  83         </listitem>
  84       </varlistentry>
  85       <varlistentry>
  86         <term><option>-s, --snapshots</option></term>
  87         <listitem>
  88           <para>
  89             destroy the specified container including all its snapshots.
  90           </para>
  91         </listitem>
  92       </varlistentry>
  93     </variablelist>
  94
  95   </refsect1>
  96
  97   &commonoptions;
  98
  99   <refsect1>
 100     <title>Diagnostic</title>
 101
 102     <variablelist>
 103
 104       <varlistentry>
 105         <term>The container was not found</term>
 106         <listitem>
 107           <para>
 108             The specified container for destruction was not found. It
 109             is probable it does not exists and was already
 110             destroyed.You can use the <command>lxc-ls</command>
 111             command to list the available containers on the system.
 112           </para>
 113         </listitem>
 114       </varlistentry>
 115
 116     </variablelist>
 117
 118   </refsect1>
 119
 120   &seealso;
 121
 122   <refsect1>
 123     <title>Author</title>
 124     <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 125   </refsect1>
 126
 127 </refentry>
 128
 129 <!-- Keep this comment at the end of the file
 130 Local variables:
 131 mode: sgml
 132 sgml-omittag:t
 133 sgml-shorttag:t
 134 sgml-minimize-attributes:nil
 135 sgml-always-quote-attributes:t
 136 sgml-indent-step:2
 137 sgml-indent-data:t
 138 sgml-parent-document:nil
 139 sgml-default-dtd-file:nil
 140 sgml-exposed-tags:nil
 141 sgml-local-catalogs:nil
 142 sgml-local-ecat-files:nil
 143 End:
 144 -->