~serge-hallyn/ubuntu/saucy/lxc/lxc-dnsmasq

« back to all changes in this revision

Viewing changes to doc/lxc-clone.sgml.in

  • Committer: Stéphane Graber
  • Date: 2013-02-18 15:20:18 UTC
  • mto: This revision was merged to the branch mainline in revision 190.
  • Revision ID: stgraber@ubuntu.com-20130218152018-ls2gi9hkqs2kuhj8
Tags: upstream-0.9.0~alpha3
Import upstream version 0.9.0~alpha3

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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
Serge Hallyn <serge.hallyn at ubuntu.com>
 
10
 
 
11
This library is free software; you can redistribute it and/or
 
12
modify it under the terms of the GNU Lesser General Public
 
13
License as published by the Free Software Foundation; either
 
14
version 2.1 of the License, or (at your option) any later version.
 
15
 
 
16
This library is distributed in the hope that it will be useful,
 
17
but WITHOUT ANY WARRANTY; without even the implied warranty of
 
18
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
19
Lesser General Public License for more details.
 
20
 
 
21
You should have received a copy of the GNU Lesser General Public
 
22
License along with this library; if not, write to the Free Software
 
23
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
24
 
 
25
-->
 
26
 
 
27
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
28
 
 
29
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
 
30
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
 
31
]>
 
32
 
 
33
<refentry>
 
34
 
 
35
  <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
 
36
 
 
37
  <refmeta>
 
38
    <refentrytitle>lxc-clone</refentrytitle>
 
39
    <manvolnum>1</manvolnum>
 
40
  </refmeta>
 
41
 
 
42
  <refnamediv>
 
43
    <refname>lxc-clone</refname>
 
44
 
 
45
    <refpurpose>
 
46
      clone a new container from an existing one.
 
47
    </refpurpose>
 
48
  </refnamediv>
 
49
 
 
50
  <refsynopsisdiv>
 
51
    <cmdsynopsis>
 
52
      <command>lxc-clone</command>
 
53
      <arg choice="req">-o <replaceable>orig</replaceable></arg>
 
54
      <arg choice="req">-n <replaceable>new</replaceable></arg>
 
55
      <arg choice="opt">-s </arg>
 
56
      <arg choice="opt">-L <replaceable>fssize</replaceable></arg>
 
57
      <arg choice="opt">-v <replaceable>vgname</replaceable></arg>
 
58
      <arg choice="opt">-p <replaceable>lxc_lv_prefix</replaceable></arg>
 
59
      <arg choice="opt">-t <replaceable>fstype</replaceable></arg>
 
60
    </cmdsynopsis>
 
61
  </refsynopsisdiv>
 
62
 
 
63
  <refsect1>
 
64
    <title>Description</title>
 
65
 
 
66
    <para>
 
67
      <command>lxc-clone</command> Creates a new container as a copy of an existing
 
68
      container.  When the original container's rootfs is an LVM block device or
 
69
      is on a btrfs filesystem, then a snapshotted clone can be created, taking up
 
70
      very little initial disk space.
 
71
    </para>
 
72
 
 
73
  </refsect1>
 
74
 
 
75
  <refsect1>
 
76
 
 
77
    <title>Options</title>
 
78
 
 
79
    <variablelist>
 
80
 
 
81
      <varlistentry>
 
82
        <term>
 
83
          <option>-o, --orig <replaceable>orig</replaceable></option>
 
84
        </term>
 
85
        <listitem>
 
86
          <para>
 
87
            The name of the original container to clone.
 
88
          </para>
 
89
        </listitem>
 
90
      </varlistentry>
 
91
 
 
92
      <varlistentry>
 
93
        <term>
 
94
          <option>-n, --new <replaceable>new</replaceable></option>
 
95
        </term>
 
96
        <listitem>
 
97
          <para>
 
98
            The name of the new container to create.
 
99
          </para>
 
100
        </listitem>
 
101
      </varlistentry>
 
102
 
 
103
      <varlistentry>
 
104
        <term>
 
105
          <option>-s, --snapshot</option>
 
106
        </term>
 
107
        <listitem>
 
108
          <para>
 
109
            The new container's rootfs should be a LVM or btrfs snapshot of the original.
 
110
          </para>
 
111
        </listitem>
 
112
      </varlistentry>
 
113
 
 
114
      <varlistentry>
 
115
        <term>
 
116
          <option>-L, --fssize <replaceable>fssize</replaceable></option>
 
117
        </term>
 
118
        <listitem>
 
119
          <para>
 
120
            In the case of a LVM-backed container, a size for the new
 
121
            block device.  By default, the new device will be made the
 
122
            same size as the original.
 
123
          </para>
 
124
        </listitem>
 
125
      </varlistentry>
 
126
 
 
127
      <varlistentry>
 
128
        <term>
 
129
          <option>-v, --vgname <replaceable>vgname</replaceable></option>
 
130
        </term>
 
131
        <listitem>
 
132
          <para>
 
133
            For an LVM-backed container, the volume group name to use.  By
 
134
            default it is 'lxc'.
 
135
          </para>
 
136
        </listitem>
 
137
      </varlistentry>
 
138
 
 
139
      <varlistentry>
 
140
        <term>
 
141
          <option>-p, --lvprefix <replaceable>lxc_lv_prefix</replaceable></option>
 
142
        </term>
 
143
        <listitem>
 
144
          <para>
 
145
            For an LVM-backed container, a string to prefix to the container name to
 
146
            form the logical volume name.  For instance, specifying
 
147
            <command>-n c1 -p lxc_</command> will cause the container rootfs to
 
148
            be on a logical volume called <replaceable>lxc_c1</replaceable>.
 
149
          </para>
 
150
        </listitem>
 
151
      </varlistentry>
 
152
 
 
153
      <varlistentry>
 
154
        <term>
 
155
          <option>-t, --fstype <replaceable>fstype</replaceable></option>
 
156
        </term>
 
157
        <listitem>
 
158
          <para>
 
159
            For a non-snapshot LVM clone, the file system to use for the new
 
160
            container.  Note this option is ignored when requesting a
 
161
            snapshotted container.
 
162
          </para>
 
163
        </listitem>
 
164
      </varlistentry>
 
165
 
 
166
    </variablelist>
 
167
 
 
168
  </refsect1>
 
169
 
 
170
  &seealso;
 
171
 
 
172
  <refsect1>
 
173
    <title>Author</title>
 
174
    <para>Serge Hallyn <email>serge.hallyn@ubuntu.com</email></para>
 
175
  </refsect1>
 
176
 
 
177
</refentry>
 
178
 
 
179
<!-- Keep this comment at the end of the file
 
180
Local variables:
 
181
mode: sgml
 
182
sgml-omittag:t
 
183
sgml-shorttag:t
 
184
sgml-minimize-attributes:nil
 
185
sgml-always-quote-attributes:t
 
186
sgml-indent-step:2
 
187
sgml-indent-data:t
 
188
sgml-parent-document:nil
 
189
sgml-default-dtd-file:nil
 
190
sgml-exposed-tags:nil
 
191
sgml-local-catalogs:nil
 
192
sgml-local-ecat-files:nil
 
193
End:
 
194
-->