Debian Codegraph @

doc/lxc-destroy.sgml.in

raw
1 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
2
3 <!DOCTYPE refentry PUBLIC @docdtd@ [
4
5 <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
6 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
7 ]>
8
9 <refentry>
10
11 <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
12
13 <refmeta>
14 <refentrytitle>lxc-destroy</refentrytitle>
15 <manvolnum>1</manvolnum>
16 </refmeta>
17
18 <refnamediv>
19 <refname>lxc-destroy</refname>
20
21 <refpurpose>
22 destroy a container.
23 </refpurpose>
24 </refnamediv>
25
26 <refsynopsisdiv>
27 <cmdsynopsis>
28 <command>lxc-destroy</command>
29 <arg choice="req">-n <replaceable>name</replaceable></arg>
30 <arg choice="opt">-f</arg>
31 <arg choice="opt">-s</arg>
32 </cmdsynopsis>
33 </refsynopsisdiv>
34
35 <refsect1>
36 <title>Description</title>
37
38 <para>
39 <command>lxc-destroy</command> destroys the system object
40 previously created by the <command>lxc-create</command> command.
41 </para>
42
43 </refsect1>
44
45 <refsect1>
46
47 <title>Options</title>
48
49 <variablelist>
50 <varlistentry>
51 <term>
52 <option>-f, --force</option>
53 </term>
54 <listitem>
55 <para>
56 If a container is running, stop it first. If this option is
57 not specified and the container is running, then
58 <command>lxc-destroy</command> will be aborted.
59 </para>
60 </listitem>
61 </varlistentry>
62 <varlistentry>
63 <term><option>-s, --snapshots</option></term>
64 <listitem>
65 <para>
66 destroy the specified container including all its snapshots.
67 </para>
68 </listitem>
69 </varlistentry>
70 </variablelist>
71
72 </refsect1>
73
74 &commonoptions;
75
76 <refsect1>
77 <title>Diagnostic</title>
78
79 <variablelist>
80
81 <varlistentry>
82 <term>The container was not found</term>
83 <listitem>
84 <para>
85 The specified container for destruction was not found. It
86 is probable it does not exists and was already
87 destroyed.You can use the <command>lxc-ls</command>
88 command to list the available containers on the system.
89 </para>
90 </listitem>
91 </varlistentry>
92
93 </variablelist>
94
95 </refsect1>
96
97 &seealso;
98
99 </refentry>
100
101 <!-- Keep this comment at the end of the file
102 Local variables:
103 mode: sgml
104 sgml-omittag:t
105 sgml-shorttag:t
106 sgml-minimize-attributes:nil
107 sgml-always-quote-attributes:t
108 sgml-indent-step:2
109 sgml-indent-data:t
110 sgml-parent-document:nil
111 sgml-default-dtd-file:nil
112 sgml-exposed-tags:nil
113 sgml-local-catalogs:nil
114 sgml-local-ecat-files:nil
115 End:
116 -->