← Back to branch summary

~ubuntu-branches/ubuntu/quantal/lxc/quantal-201208301614

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Guido Trotter
  • Date: 2010-06-28 10:15:48 UTC
  • mto: (1.1.4 upstream) (3.1.5 sid)
  • mto: This revision was merged to the branch mainline in revision 7.
  • Revision ID: james.westby@ubuntu.com-20100628101548-vexhggdo6x9cpwtk
Import upstream version 0.7.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/lxc-checkpoint.sgml.in
 
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
 
 
10
This library is free software; you can redistribute it and/or
 
11
modify it under the terms of the GNU Lesser General Public
 
12
License as published by the Free Software Foundation; either
 
13
version 2.1 of the License, or (at your option) any later version.
 
14
 
 
15
This library is distributed in the hope that it will be useful,
 
16
but WITHOUT ANY WARRANTY; without even the implied warranty of
 
17
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
18
Lesser General Public License for more details.
 
19
 
 
20
You should have received a copy of the GNU Lesser General Public
 
21
License along with this library; if not, write to the Free Software
 
22
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
23
 
 
24
-->
 
25
 
 
26
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
 
27
 
 
28
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
 
29
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
 
30
]>
 
31
 
 
32
<refentry>
 
33
 
 
34
  <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
 
35
 
 
36
  <refmeta>
 
37
    <refentrytitle>lxc-checkpoint</refentrytitle>
 
38
    <manvolnum>1</manvolnum>
 
39
    <refmiscinfo>IBM</refmiscinfo>
 
40
  </refmeta>
 
41
 
 
42
  <refnamediv>
 
43
    <refname>lxc-checkpoint</refname>
 
44
 
 
45
    <refpurpose>
 
46
      checkpoint a running container (not implemented yet)
 
47
    </refpurpose>
 
48
  </refnamediv>
 
49
 
 
50
  <refsynopsisdiv>
 
51
    <cmdsynopsis>
 
52
      <command>lxc-checkpoint
 
53
        --statefile=<replaceable>FILE</replaceable>
 
54
        --statefd=<replaceable>FD</replaceable>
 
55
        --name=<replaceable>NAME</replaceable> </command>
 
56
      <arg><option>-k</option>|<option>-p</option></arg>
 
57
    </cmdsynopsis>
 
58
  </refsynopsisdiv>
 
59
 
 
60
  <refsect1>
 
61
    <title>Description</title>
 
62
 
 
63
    <para>
 
64
      <command>lxc-checkpoint</command> is a command
 
65
      to checkpoint the specified container
 
66
      <replaceable>NAME</replaceable> and dumps its state into the file
 
67
      <replaceable>FILE</replaceable>. If the
 
68
      option <option>--kill</option> is specified, the application
 
69
      running in the container will terminate after the checkpoint
 
70
      just before resuming its execution. If the
 
71
      option <option>--pause</option> is specified, the application
 
72
      will be stopped after the checkpoint just before resuming
 
73
      execution. The command <command>lxc-unfreeze</command> will
 
74
      resume its execution.
 
75
    </para>
 
76
 
 
77
  </refsect1>
 
78
 
 
79
  <refsect1>
 
80
    <title>Checkpoint Options</title>
 
81
 
 
82
    <variablelist>
 
83
 
 
84
      <varlistentry>
 
85
        <term><option>-S, --statefile=<replaceable>FILE</replaceable></option></term>
 
86
        <listitem>
 
87
          <para>
 
88
            write the state of the container in this
 
89
            <replaceable>FILE</replaceable>.
 
90
            This option is exclusive with <option>--statefd</option> below.
 
91
          </para>
 
92
        </listitem>
 
93
      </varlistentry>
 
94
 
 
95
      <varlistentry>
 
96
        <term><option>-d, --statefd=<replaceable>FD</replaceable></option></term>
 
97
        <listitem>
 
98
          <para>
 
99
            write the state of the container in this
 
100
            <replaceable>FD</replaceable> file descriptor.
 
101
            This option is exclusive with above <option>--statefile</option>.
 
102
          </para>
 
103
        </listitem>
 
104
      </varlistentry>
 
105
 
 
106
      <varlistentry>
 
107
        <term><option>-k,--kill</option></term>
 
108
        <listitem>
 
109
          <para>
 
110
            Kill container processes after checkpoint. the processes are sent
 
111
            a <literal>SIGKILL</literal> signal.
 
112
          </para>
 
113
          <para>
 
114
            This option is mutually exclusive with the following
 
115
            <option>--pause</option> option.
 
116
          </para>
 
117
        </listitem>
 
118
      </varlistentry>
 
119
 
 
120
      <varlistentry>
 
121
        <term><option>-p,--pause</option></term>
 
122
        <listitem>
 
123
          <para>
 
124
            Pause container processes after checkpoint. The container
 
125
            will be stopped until you resume it. This option is
 
126
            mutually exclusive with previously mentionned
 
127
            <option>--kill</option> option.
 
128
          </para>
 
129
        </listitem>
 
130
      </varlistentry>
 
131
 
 
132
    </variablelist>
 
133
 
 
134
  </refsect1>
 
135
 
 
136
  &commonoptions;
 
137
 
 
138
  <refsect1>
 
139
    <title>Examples</title>
 
140
    <para>
 
141
      To start a new container <literal>123</literal> computing decimals of pi
 
142
    </para>
 
143
    <programlisting>
 
144
      lxc-execute -n 123 -- pi1 -d 500000
 
145
      lxc-execute --name=123 -- pi1 -d 500000
 
146
    </programlisting>
 
147
 
 
148
    <para>
 
149
      to checkpoint the same container in <emphasis>dump-death</emphasis>
 
150
      mode
 
151
    </para>
 
152
    <programlisting>
 
153
      lxc-checkpoint -n 123 -S /share/123/chkpt1 -k
 
154
      lxc-checkpoint --name=123 -S /share/123/chkpt1 -k
 
155
    </programlisting>
 
156
 
 
157
    <para>
 
158
      to checkpoint the same container and <emphasis>pause</emphasis> it
 
159
    </para>
 
160
    <programlisting>
 
161
      lxc-checkpoint -n 123 -S /share/123/chkpt1 -p
 
162
      lxc-checkpoint --name=123 -S /share/123/chkpt1 -p
 
163
    </programlisting>
 
164
 
 
165
  </refsect1>
 
166
 
 
167
  <refsect1>
 
168
    <Title>Notes</Title>
 
169
    <para>Actually, this command does not operate. Its description
 
170
    helps to define a CLI api for future Checkpoint / Restart
 
171
    solution</para>
 
172
  </refsect1>
 
173
 
 
174
  &seealso;
 
175
 
 
176
  <refsect1>
 
177
    <title>Author</title>
 
178
    <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 
179
  </refsect1>
 
180
 
 
181
</refentry>
 
182
 
 
183
<!-- Keep this comment at the end of the file
 
184
Local variables:
 
185
mode: sgml
 
186
sgml-omittag:t
 
187
sgml-shorttag:t
 
188
sgml-minimize-attributes:nil
 
189
sgml-always-quote-attributes:t
 
190
sgml-indent-step:2
 
191
sgml-indent-data:t
 
192
sgml-parent-document:nil
 
193
sgml-default-dtd-file:nil
 
194
sgml-exposed-tags:nil
 
195
sgml-local-catalogs:nil
 
196
sgml-local-ecat-files:nil
 
197
End:
 
198
-->