]>
Commit | Line | Data |
---|---|---|
735f2c6e TA |
1 | <!-- |
2 | ||
3 | (C) Copyright Canonical Ltd. 2014 | |
4 | ||
5 | Authors: | |
6 | Tycho Andersen <tycho.andersen@canonical.com> | |
7 | ||
8 | This library is free software; you can redistribute it and/or | |
9 | modify it under the terms of the GNU Lesser General Public | |
10 | License as published by the Free Software Foundation; either | |
11 | version 2.1 of the License, or (at your option) any later version. | |
12 | ||
13 | This library is distributed in the hope that it will be useful, | |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
16 | Lesser General Public License for more details. | |
17 | ||
18 | You should have received a copy of the GNU Lesser General Public | |
19 | License along with this library; if not, write to the Free Software | |
20 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
21 | ||
22 | --> | |
23 | ||
24 | <!DOCTYPE refentry PUBLIC @docdtd@ [ | |
25 | ||
26 | <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml"> | |
27 | <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> | |
28 | ]> | |
29 | ||
30 | <refentry> | |
31 | ||
32 | <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo> | |
33 | ||
34 | <refmeta> | |
35 | <refentrytitle>lxc-checkpoint</refentrytitle> | |
36 | <manvolnum>1</manvolnum> | |
37 | </refmeta> | |
38 | ||
39 | <refnamediv> | |
40 | <refname>lxc-checkpoint</refname> | |
41 | ||
42 | <refpurpose> | |
43 | checkpoint a container | |
44 | </refpurpose> | |
45 | </refnamediv> | |
46 | ||
47 | <refsynopsisdiv> | |
48 | <cmdsynopsis> | |
49 | <command>lxc-checkpoint</command> | |
50 | <arg choice="req">-n <replaceable>name</replaceable></arg> | |
51 | <arg choice="req">-D <replaceable>PATH</replaceable></arg> | |
52 | <arg choice="opt">-r</arg> | |
53 | <arg choice="opt">-s</arg> | |
54 | <arg choice="opt">-v</arg> | |
55 | <arg choice="opt">-d</arg> | |
56 | <arg choice="opt">-F</arg> | |
57 | </cmdsynopsis> | |
58 | </refsynopsisdiv> | |
59 | ||
60 | <refsect1> | |
61 | <title>Description</title> | |
62 | <para> | |
63 | <command>lxc-checkpoint</command> checkpoints and restores containers. | |
64 | </para> | |
65 | </refsect1> | |
66 | ||
67 | <refsect1> | |
68 | <title>Options</title> | |
69 | <variablelist> | |
70 | ||
71 | <varlistentry> | |
72 | <term> | |
73 | <option>-r, --restore</option> | |
74 | </term> | |
75 | <listitem> | |
76 | <para> | |
77 | Restore the checkpoint for the container, instead of dumping it. | |
78 | This option is incompatible with <option>-s</option>. | |
79 | </para> | |
80 | </listitem> | |
81 | </varlistentry> | |
82 | ||
83 | <varlistentry> | |
84 | <term> | |
129881b9 | 85 | <option>-D <replaceable>PATH</replaceable>, --checkpoint-dir=<replaceable>PATH</replaceable></option> |
735f2c6e TA |
86 | </term> |
87 | <listitem> | |
88 | <para> | |
89 | The directory to dump the checkpoint metadata. | |
90 | </para> | |
91 | </listitem> | |
92 | </varlistentry> | |
93 | ||
94 | <varlistentry> | |
95 | <term> | |
96 | <option>-s, --stop</option> | |
97 | </term> | |
98 | <listitem> | |
99 | <para> | |
100 | Optionally stop the container after dumping. This option is | |
101 | incompatible with <option>-r</option>. | |
102 | </para> | |
103 | </listitem> | |
104 | </varlistentry> | |
105 | ||
106 | <varlistentry> | |
107 | <term> | |
108 | <option>-v, --verbose</option> | |
109 | </term> | |
110 | <listitem> | |
111 | <para> | |
112 | Enable verbose criu logging. | |
113 | </para> | |
114 | </listitem> | |
115 | </varlistentry> | |
116 | ||
117 | <varlistentry> | |
118 | <term> | |
119 | <option>-d, --daemon</option> | |
120 | </term> | |
121 | <listitem> | |
122 | <para> | |
123 | Restore the container in the background (this is the default). | |
124 | Only available when providing <option>-r</option>. | |
125 | </para> | |
126 | </listitem> | |
127 | </varlistentry> | |
128 | ||
129 | <varlistentry> | |
130 | <term> | |
131 | <option>-F, --foreground</option> | |
132 | </term> | |
133 | <listitem> | |
134 | <para> | |
135 | Restore the container in the foreground. Only available when | |
136 | providing <option>-r</option>. | |
137 | </para> | |
138 | </listitem> | |
139 | </varlistentry> | |
140 | ||
141 | </variablelist> | |
142 | </refsect1> | |
143 | ||
144 | &commonoptions; | |
145 | ||
146 | <refsect1> | |
147 | <title>Examples</title> | |
148 | <variablelist> | |
149 | ||
150 | <varlistentry> | |
151 | <term>lxc-checkpoint -n foo -D /tmp/checkpoint</term> | |
152 | <listitem> | |
153 | <para> | |
154 | Checkpoint the container foo into the directory /tmp/checkpoint. | |
155 | </para> | |
156 | </listitem> | |
157 | </varlistentry> | |
158 | ||
159 | <varlistentry> | |
160 | <term>lxc-checkpoint -r -n foo -D /tmp/checkpoint</term> | |
161 | <listitem> | |
162 | <para> | |
163 | Restore the checkpoint from the directory /tmp/checkpoint. | |
164 | </para> | |
165 | </listitem> | |
166 | </varlistentry> | |
167 | ||
168 | </variablelist> | |
169 | </refsect1> | |
170 | ||
171 | &seealso; | |
172 | ||
173 | <refsect1> | |
174 | <title>Author</title> | |
175 | <para>Tycho Andersen <email>tycho.andersen@canonical.com</email></para> | |
176 | </refsect1> | |
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 | --> |