← Back to branch summary

~ubuntu-branches/ubuntu/precise/lxc/precise

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Guido Trotter
  • Date: 2009-04-29 17:49:13 UTC
  • Revision ID: james.westby@ubuntu.com-20090429174913-jvahs1ykizqtodje
Tags: upstream-0.6.2
Import upstream version 0.6.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/lxc-freeze.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
<refentry>
 
29
 
 
30
  <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
 
31
 
 
32
  <refmeta>
 
33
    <refentrytitle>lxc-freeze</refentrytitle>
 
34
    <manvolnum>1</manvolnum>
 
35
  </refmeta>
 
36
 
 
37
  <refnamediv>
 
38
    <refname>lxc-freeze</refname>
 
39
 
 
40
    <refpurpose>
 
41
      freeze all the container's processes
 
42
    </refpurpose>
 
43
  </refnamediv>
 
44
 
 
45
  <refsynopsisdiv>
 
46
    <cmdsynopsis>
 
47
      <command>lxc-freeze <replaceable>-n name</replaceable>
 
48
      </command>
 
49
    </cmdsynopsis>
 
50
  </refsynopsisdiv>
 
51
 
 
52
  <refsect1>
 
53
    <title>Description</title>
 
54
 
 
55
    <para>
 
56
      <command>lxc-freeze</command> freezes all the processes running
 
57
      inside the container. The processes will be blocked until they
 
58
      are explicitly thawed by the <command>lxc-unfreeze</command>
 
59
      command. This command is useful for batch managers to schedule a
 
60
      group of processes.
 
61
    </para>
 
62
 
 
63
  </refsect1>
 
64
 
 
65
  <refsect1>
 
66
    <title>Options</title>
 
67
    <variablelist>
 
68
 
 
69
      <varlistentry>
 
70
        <term>
 
71
          <option>-n <replaceable>name</replaceable></option>
 
72
        </term>
 
73
        <listitem>
 
74
          <para>
 
75
            Specify the container name to be frozen.
 
76
          </para>
 
77
        </listitem>
 
78
      </varlistentry>
 
79
 
 
80
    </variablelist>
 
81
 
 
82
  </refsect1>
 
83
 
 
84
  <refsect1>
 
85
    <title>Diagnostic</title>
 
86
 
 
87
    <variablelist>
 
88
 
 
89
      <varlistentry>
 
90
        <term>The container was not found</term>
 
91
        <listitem>
 
92
          <para>
 
93
            The specified container was not created before with
 
94
            the <command>lxc-create</command> command.
 
95
          </para>
 
96
        </listitem>
 
97
      </varlistentry>    
 
98
 
 
99
 
 
100
    </variablelist>
 
101
 
 
102
  </refsect1>
 
103
 
 
104
  <refsect1>
 
105
    <title>See Also</title>
 
106
 
 
107
    <simpara>    
 
108
      <citerefentry>
 
109
        <refentrytitle><command>lxc-unfreeze</command></refentrytitle>
 
110
        <manvolnum>1</manvolnum>
 
111
      </citerefentry>,
 
112
    </simpara>
 
113
 
 
114
 
 
115
  </refsect1>
 
116
 
 
117
  <refsect1>
 
118
    <title>Author</title>
 
119
    <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 
120
  </refsect1>
 
121
 
 
122
</refentry>
 
123
 
 
124
<!-- Keep this comment at the end of the file
 
125
Local variables:
 
126
mode: sgml
 
127
sgml-omittag:t
 
128
sgml-shorttag:t
 
129
sgml-minimize-attributes:nil
 
130
sgml-always-quote-attributes:t
 
131
sgml-indent-step:2
 
132
sgml-indent-data:t
 
133
sgml-parent-document:nil
 
134
sgml-default-dtd-file:nil
 
135
sgml-exposed-tags:nil
 
136
sgml-local-catalogs:nil
 
137
sgml-local-ecat-files:nil
 
138
End:
 
139
-->