← Back to branch summary

~serge-hallyn/ubuntu/quantal/lxc/lxc-fixapi

« back to all changes in this revision

Viewing changes to doc/lxc-restart.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-restart.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-restart</refentrytitle>
 
38
    <manvolnum>1</manvolnum>
 
39
    <refmiscinfo>IBM</refmiscinfo>
 
40
  </refmeta>
 
41
 
 
42
  <refnamediv>
 
43
    <refname>lxc-restart</refname>
 
44
 
 
45
    <refpurpose>
 
46
      restart a container from a file (not implemented yet)
 
47
    </refpurpose>
 
48
  </refnamediv>
 
49
 
 
50
  <refsynopsisdiv>
 
51
    <cmdsynopsis>
 
52
      <command>lxc-restart <optional>-f
 
53
        config_file</optional><optional>-s KEY=VAL</optional>
 
54
        --statefile=<replaceable>FILE</replaceable>
 
55
        --statefd=<replaceable>FD</replaceable></command>
 
56
      <arg choice=req><option>--name=<replaceable>NAME</replaceable></option></arg>
 
57
    </cmdsynopsis>
 
58
  </refsynopsisdiv>
 
59
 
 
60
  <refsect1>
 
61
    <title>Description</title>
 
62
 
 
63
    <para>
 
64
      <command>lxc-restart</command> is a command
 
65
      to restart an application from the state read in the specified
 
66
      <replaceable>FILE</replaceable>, in a container with the
 
67
      identifier <replaceable>NAME</replaceable>.
 
68
      If the option <option>--pause</option>
 
69
      is specified, the application will be stopped after the
 
70
      restart just before resuming execution. The command
 
71
      <command>lxc-unfreeze</command> will be needed to resume its
 
72
      execution.
 
73
    </para>
 
74
  </refsect1>
 
75
 
 
76
  <refsect1>
 
77
    <title>Restart Options</title>
 
78
 
 
79
    <variablelist>
 
80
      <varlistentry>
 
81
        <term><option>-S, --statefile=<replaceable>FILE</replaceable></option></term>
 
82
        <listitem>
 
83
          <para>
 
84
            read the state of the container in this
 
85
            <replaceable>FILE</replaceable>.
 
86
            This option is exclusive with <option>--statefd</option> below.
 
87
          </para>
 
88
        </listitem>
 
89
      </varlistentry>
 
90
 
 
91
        <varlistentry>
 
92
        <term><option>-d, --statefd=<replaceable>FD</replaceable></option></term>
 
93
        <listitem>
 
94
          <para>
 
95
            read the state of the container in this
 
96
            <replaceable>FD</replaceable> file descriptor.
 
97
            This option is exclusive with above <option>--statefile</option>.
 
98
          </para>
 
99
        </listitem>
 
100
        </varlistentry>
 
101
 
 
102
        <varlistentry>
 
103
        <term><option>-p</option></term>
 
104
        <listitem>
 
105
          <para>
 
106
            Pause container processes after restart. The container will be
 
107
            stopped until you resume it with the lxc-unfreeze command.
 
108
          </para>
 
109
        </listitem>
 
110
        </varlistentry>
 
111
 
 
112
        <varlistentry>
 
113
        <term><option>-f, --rcfile=<replaceable>config_file</replaceable></option></term>
 
114
        <listitem>
 
115
          <para>
 
116
            Specify the configuration file to configure the
 
117
            virtualization and isolation functionalities for the
 
118
            container. This parameter should be specified if it was
 
119
            specified for the <command>lxc-execute</command>
 
120
            or <command>lxc-start</command> commands or if the
 
121
            container configuration has to be changed at restart. The
 
122
            latter may fail if the needed resources are not available
 
123
            for the restart. If the container was created and
 
124
            configured with <command>lxc-create</command>, this option
 
125
            is not needed, the configuration will be automatically
 
126
            found.
 
127
          </para>
 
128
        </listitem>
 
129
        </varlistentry>
 
130
 
 
131
        <varlistentry>
 
132
        <term>
 
133
          <option>-s <replaceable>KEY=VAL</replaceable></option>
 
134
        </term>
 
135
        <listitem>
 
136
          <para>
 
137
            Assign value <replaceable>VAL</replaceable> to configuration
 
138
            variable <replaceable>KEY</replaceable>. This overrides any
 
139
            assignment done in <replaceable>config_file</replaceable>.
 
140
          </para>
 
141
        </listitem>
 
142
      </varlistentry>
 
143
 
 
144
    </variablelist>
 
145
 
 
146
  </refsect1>
 
147
 
 
148
  &commonoptions;
 
149
 
 
150
  <refsect1>
 
151
    <title>Examples</title>
 
152
    <para>
 
153
      To start a new container <literal>123</literal> computing decimals of pi
 
154
    </para>
 
155
    <programlisting>
 
156
      lxc-execute -n 123 -- pi1 -d 500000
 
157
      lxc-execute --name=123 -- pi1 -d 500000
 
158
    </programlisting>
 
159
 
 
160
    <para>
 
161
      to checkpoint the same container in <emphasis>dump-death</emphasis>
 
162
      mode
 
163
    </para>
 
164
    <programlisting>
 
165
      lxc-checkpoint -n 123 -S /share/123/chkpt1 -k
 
166
      lxc-checkpoint --name=123 --statefile=/share/123/chkpt1 -k
 
167
    </programlisting>
 
168
 
 
169
    <para>
 
170
      and to restart the same container with a different id
 
171
    </para>
 
172
    <programlisting>
 
173
      lxc-restart -n 200 -S /share/123/chkpt1
 
174
      lxc-restart --name=200 --statefile=/share/123/chkpt1
 
175
    </programlisting>
 
176
 
 
177
   </refsect1>
 
178
 
 
179
  <refsect1>
 
180
    <Title>Notes</Title>
 
181
    <para>Actually, this command does not operate. Its description
 
182
    helps to define a CLI api for future Checkpoint / Restart
 
183
    solution</para>
 
184
  </refsect1>
 
185
 
 
186
  &seealso;
 
187
 
 
188
  <refsect1>
 
189
    <title>Author</title>
 
190
    <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 
191
  </refsect1>
 
192
 
 
193
</refentry>
 
194
 
 
195
<!-- Keep this comment at the end of the file
 
196
Local variables:
 
197
mode: sgml
 
198
sgml-omittag:t
 
199
sgml-shorttag:t
 
200
sgml-minimize-attributes:nil
 
201
sgml-always-quote-attributes:t
 
202
sgml-indent-step:2
 
203
sgml-indent-data:t
 
204
sgml-parent-document:nil
 
205
sgml-default-dtd-file:nil
 
206
sgml-exposed-tags:nil
 
207
sgml-local-catalogs:nil
 
208
sgml-local-ecat-files:nil
 
209
End:
 
210
-->