File: lxc-checkpoint.sgml.in

package info (click to toggle)
lxc 1%3A5.0.2-1%2Bdeb12u3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 6,416 kB
  • sloc: ansic: 68,763; sh: 4,118; python: 135; makefile: 53
file content (194 lines) | stat: -rw-r--r-- 4,882 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
<!--

(C) Copyright Canonical Ltd. 2014

Authors:
Tycho Andersen <tycho.andersen@canonical.com>

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

-->

<!DOCTYPE refentry PUBLIC @docdtd@ [

<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]>

<refentry>

  <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>

  <refmeta>
    <refentrytitle>lxc-checkpoint</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>lxc-checkpoint</refname>

    <refpurpose>
      checkpoint a container
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>lxc-checkpoint</command>
      <arg choice="req">-n <replaceable>name</replaceable></arg>
      <arg choice="req">-D <replaceable>PATH</replaceable></arg>
      <arg choice="opt">-r</arg>
      <arg choice="opt">-s</arg>
      <arg choice="opt">-v</arg>
      <arg choice="opt">-d</arg>
      <arg choice="opt">-F</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>
    <para>
      <command>lxc-checkpoint</command> checkpoints and restores containers.
    </para>
  </refsect1>

  <refsect1>
    <title>Options</title>
    <variablelist>

      <varlistentry>
        <term>
          <option>-r, --restore</option>
        </term>
        <listitem>
          <para>
            Restore the checkpoint for the container, instead of dumping it.
            This option is incompatible with <option>-s</option>.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-D <replaceable>PATH</replaceable>, --checkpoint-dir=<replaceable>PATH</replaceable></option>
        </term>
        <listitem>
          <para>
            The directory to dump the checkpoint metadata.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-s, --stop</option>
        </term>
        <listitem>
          <para>
            Optionally stop the container after dumping. This option is
            incompatible with <option>-r</option>.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-v, --verbose</option>
        </term>
        <listitem>
          <para>
            Enable verbose criu logging.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-d, --daemon</option>
        </term>
        <listitem>
          <para>
            Restore the container in the background (this is the default).
            Only available when providing <option>-r</option>.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-F, --foreground</option>
        </term>
        <listitem>
          <para>
            Restore the container in the foreground. Only available when
            providing <option>-r</option>.
          </para>
        </listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  &commonoptions;

  <refsect1>
    <title>Examples</title>
    <variablelist>

      <varlistentry>
        <term>lxc-checkpoint -n foo -D /tmp/checkpoint</term>
        <listitem>
          <para>
            Checkpoint the container foo into the directory /tmp/checkpoint.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>lxc-checkpoint -r -n foo -D /tmp/checkpoint</term>
        <listitem>
          <para>
            Restore the checkpoint from the directory /tmp/checkpoint.
          </para>
        </listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  &seealso;

  <refsect1>
    <title>Author</title>
    <para>Tycho Andersen <email>tycho.andersen@canonical.com</email></para>
  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->