Debian Codegraph @

doc/lxc-checkpoint.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-checkpoint</refentrytitle>
15 <manvolnum>1</manvolnum>
16 </refmeta>
17
18 <refnamediv>
19 <refname>lxc-checkpoint</refname>
20
21 <refpurpose>
22 checkpoint a container
23 </refpurpose>
24 </refnamediv>
25
26 <refsynopsisdiv>
27 <cmdsynopsis>
28 <command>lxc-checkpoint</command>
29 <arg choice="req">-n <replaceable>name</replaceable></arg>
30 <arg choice="req">-D <replaceable>PATH</replaceable></arg>
31 <arg choice="opt">-r</arg>
32 <arg choice="opt">-s</arg>
33 <arg choice="opt">-v</arg>
34 <arg choice="opt">-d</arg>
35 <arg choice="opt">-F</arg>
36 </cmdsynopsis>
37 </refsynopsisdiv>
38
39 <refsect1>
40 <title>Description</title>
41 <para>
42 <command>lxc-checkpoint</command> checkpoints and restores containers.
43 </para>
44 </refsect1>
45
46 <refsect1>
47 <title>Options</title>
48 <variablelist>
49
50 <varlistentry>
51 <term>
52 <option>-r, --restore</option>
53 </term>
54 <listitem>
55 <para>
56 Restore the checkpoint for the container, instead of dumping it.
57 This option is incompatible with <option>-s</option>.
58 </para>
59 </listitem>
60 </varlistentry>
61
62 <varlistentry>
63 <term>
64 <option>-D <replaceable>PATH</replaceable>, --checkpoint-dir=<replaceable>PATH</replaceable></option>
65 </term>
66 <listitem>
67 <para>
68 The directory to dump the checkpoint metadata.
69 </para>
70 </listitem>
71 </varlistentry>
72
73 <varlistentry>
74 <term>
75 <option>-s, --stop</option>
76 </term>
77 <listitem>
78 <para>
79 Optionally stop the container after dumping. This option is
80 incompatible with <option>-r</option>.
81 </para>
82 </listitem>
83 </varlistentry>
84
85 <varlistentry>
86 <term>
87 <option>-v, --verbose</option>
88 </term>
89 <listitem>
90 <para>
91 Enable verbose criu logging.
92 </para>
93 </listitem>
94 </varlistentry>
95
96 <varlistentry>
97 <term>
98 <option>-d, --daemon</option>
99 </term>
100 <listitem>
101 <para>
102 Restore the container in the background (this is the default).
103 Only available when providing <option>-r</option>.
104 </para>
105 </listitem>
106 </varlistentry>
107
108 <varlistentry>
109 <term>
110 <option>-F, --foreground</option>
111 </term>
112 <listitem>
113 <para>
114 Restore the container in the foreground. Only available when
115 providing <option>-r</option>.
116 </para>
117 </listitem>
118 </varlistentry>
119
120 </variablelist>
121 </refsect1>
122
123 &commonoptions;
124
125 <refsect1>
126 <title>Examples</title>
127 <variablelist>
128
129 <varlistentry>
130 <term>lxc-checkpoint -n foo -D /tmp/checkpoint</term>
131 <listitem>
132 <para>
133 Checkpoint the container foo into the directory /tmp/checkpoint.
134 </para>
135 </listitem>
136 </varlistentry>
137
138 <varlistentry>
139 <term>lxc-checkpoint -r -n foo -D /tmp/checkpoint</term>
140 <listitem>
141 <para>
142 Restore the checkpoint from the directory /tmp/checkpoint.
143 </para>
144 </listitem>
145 </varlistentry>
146
147 </variablelist>
148 </refsect1>
149
150 &seealso;
151 </refentry>
152
153 <!-- Keep this comment at the end of the file
154 Local variables:
155 mode: sgml
156 sgml-omittag:t
157 sgml-shorttag:t
158 sgml-minimize-attributes:nil
159 sgml-always-quote-attributes:t
160 sgml-indent-step:2
161 sgml-indent-data:t
162 sgml-parent-document:nil
163 sgml-default-dtd-file:nil
164 sgml-exposed-tags:nil
165 sgml-local-catalogs:nil
166 sgml-local-ecat-files:nil
167 End:
168 -->