lxc-snapshot.sgml.in revision 6127da6b3f5815028bee187ac98840cd94313841
0N/A<!--
0N/A
0N/Alxc: linux Container library
0N/A
0N/A(C) Copyright Canonical Inc. 2007, 2008
0N/A
0N/AAuthors:
0N/ASerge Hallyn <serge.hallyn at ubuntu.com>
0N/A
0N/AThis library is free software; you can redistribute it and/or
0N/Amodify it under the terms of the GNU Lesser General Public
0N/ALicense as published by the Free Software Foundation; either
0N/Aversion 2.1 of the License, or (at your option) any later version.
0N/A
0N/AThis library is distributed in the hope that it will be useful,
0N/Abut WITHOUT ANY WARRANTY; without even the implied warranty of
0N/AMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0N/ALesser General Public License for more details.
0N/A
0N/AYou should have received a copy of the GNU Lesser General Public
0N/ALicense along with this library; if not, write to the Free Software
0N/AFoundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
0N/A
0N/A-->
0N/A
0N/A<!DOCTYPE refentry PUBLIC @docdtd@ [
0N/A
0N/A<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
0N/A<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
0N/A]>
58N/A
0N/A<refentry>
0N/A
0N/A <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
0N/A
0N/A <refmeta>
0N/A <refentrytitle>lxc-snapshot</refentrytitle>
0N/A <manvolnum>1</manvolnum>
0N/A </refmeta>
58N/A
99N/A <refnamediv>
99N/A <refname>lxc-snapshot</refname>
99N/A
0N/A <refpurpose>
0N/A Snapshot an existing container.
0N/A </refpurpose>
0N/A </refnamediv>
0N/A
0N/A <refsynopsisdiv>
0N/A <cmdsynopsis>
0N/A <command>lxc-snapshot</command>
0N/A <arg choice="req">-n, --name <replaceable>name</replaceable></arg>
0N/A <arg choice="opt">-c, --comment <replaceable>file</replaceable></arg>
0N/A </cmdsynopsis>
0N/A <cmdsynopsis>
58N/A <command>lxc-snapshot</command>
58N/A <arg choice="req">-n, --name <replaceable>name</replaceable></arg>
58N/A <arg choice="req">-L, --list </arg>
58N/A <arg choice="opt">-C, --showcomments </arg>
98N/A </cmdsynopsis>
98N/A <cmdsynopsis>
98N/A <command>lxc-snapshot</command>
98N/A <arg choice="req">-n, --name <replaceable>name</replaceable></arg>
98N/A <arg choice="req">-r, -restore <replaceable>snapshot-name</replaceable></arg>
98N/A <arg choice="opt"> <replaceable> newname</replaceable></arg>
98N/A </cmdsynopsis>
98N/A </refsynopsisdiv>
98N/A
98N/A <refsect1>
98N/A <title>Description</title>
98N/A
98N/A <para>
98N/A <command>lxc-snapshot</command> creates, lists, and restores
98N/A container snapshots.
98N/A </para>
98N/A <para>
98N/A Snapshots are stored as snapshotted containers under a private configuration path. For instance, if the container's configuration path is <filename>/var/lib/lxc</filename> and the container is <filename>c1</filename>, then the first snapshot will be stored as container <filename>snap0</filename> under configuration path <filename>/var/lib/lxcsnaps/c1</filename>.
98N/A </para>
98N/A </refsect1>
98N/A
98N/A <refsect1>
98N/A
98N/A <title>Options</title>
98N/A
98N/A <variablelist>
98N/A
98N/A <varlistentry>
98N/A <term> <option>-c,--comment <replaceable>comment_file</replaceable></option> </term>
98N/A <listitem>
58N/A <para> Associate the comment in <replaceable>comment_file</replaceable> with the newly created snapshot.</para>
0N/A </listitem>
0N/A </varlistentry>
0N/A
0N/A <varlistentry>
0N/A <term> <option>-L,--list </option> </term>
0N/A <listitem>
0N/A <para> List existing snapshots. </para>
0N/A </listitem>
73N/A </varlistentry>
0N/A
0N/A <varlistentry>
0N/A <term> <option>-C,--showcomments </option> </term>
0N/A <listitem>
0N/A <para> Show snapshot comments in the snapshots listings. </para>
0N/A </listitem>
0N/A </varlistentry>
0N/A
0N/A <varlistentry>
0N/A <term> <option>-r,--restore snapshot-name</option> </term>
0N/A <listitem>
0N/A <para> Restore the named snapshot, meaning a full new container is created which is a copy of the snapshot.</para>
0N/A </listitem>
0N/A </varlistentry>
58N/A
0N/A <varlistentry>
0N/A <term> <option>newname</option> </term>
0N/A <listitem>
0N/A <para> When restoring a snapshot, the last optional argument is the name to use for the restored container. If no name is given, then the original container will be destroyed and the restored container will take its place. Note that deleting the original snapshot is not possible in the case of overlayfs or zfs backed snapshots.</para>
0N/A </listitem>
0N/A </varlistentry>
0N/A
0N/A </variablelist>
0N/A
0N/A </refsect1>
0N/A
0N/A &commonoptions;
0N/A
0N/A &seealso;
0N/A
0N/A <refsect1>
0N/A <title>Author</title>
58N/A <para>Serge Hallyn <email>serge.hallyn@ubuntu.com </email></para>
58N/A </refsect1>
58N/A
58N/A</refentry>
58N/A
58N/A<!-- Keep this comment at the end of the file
58N/ALocal variables:
58N/Amode: sgml
58N/Asgml-omittag:t
58N/Asgml-shorttag:t
58N/Asgml-minimize-attributes:nil
58N/Asgml-always-quote-attributes:t
58N/Asgml-indent-step:2
58N/Asgml-indent-data:t
58N/Asgml-parent-document:nil
58N/Asgml-default-dtd-file:nil
58N/Asgml-exposed-tags:nil
58N/Asgml-local-catalogs:nil
58N/Asgml-local-ecat-files:nil
58N/AEnd:
58N/A-->
58N/A