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 <daniel.lezcano at free.fr>
   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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  23
  24 -->
  25
  26 <!DOCTYPE refentry PUBLIC @docdtd@ [
  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-freeze</refentrytitle>
  38     <manvolnum>1</manvolnum>
  39   </refmeta>
  40
  41   <refnamediv>
  42     <refname>lxc-freeze</refname>
  43
  44     <refpurpose>
  45       freeze all the container's processes
  46     </refpurpose>
  47   </refnamediv>
  48
  49   <refsynopsisdiv>
  50     <cmdsynopsis>
  51       <command>lxc-freeze</command>
  52       <arg choice="req">-n <replaceable>name</replaceable></arg>
  53     </cmdsynopsis>
  54   </refsynopsisdiv>
  55
  56   <refsect1>
  57     <title>Description</title>
  58
  59     <para>
  60       <command>lxc-freeze</command> freezes all the processes running
  61       inside the container. The processes will be blocked until they
  62       are explicitly thawed by the <command>lxc-unfreeze</command>
  63       command. This command is useful for batch managers to schedule a
  64       group of processes.
  65     </para>
  66
  67   </refsect1>
  68
  69   &commonoptions;
  70
  71   <refsect1>
  72     <title>Diagnostic</title>
  73
  74     <variablelist>
  75
  76       <varlistentry>
  77         <term>The container was not found</term>
  78         <listitem>
  79           <para>
  80             The specified container was not created before with
  81             the <command>lxc-create</command> command.
  82           </para>
  83         </listitem>
  84       </varlistentry>
  85
  86
  87     </variablelist>
  88
  89   </refsect1>
  90
  91   &seealso;
  92
  93   <refsect1>
  94     <title>Author</title>
  95     <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
  96   </refsect1>
  97
  98 </refentry>
  99
 100 <!-- Keep this comment at the end of the file
 101 Local variables:
 102 mode: sgml
 103 sgml-omittag:t
 104 sgml-shorttag:t
 105 sgml-minimize-attributes:nil
 106 sgml-always-quote-attributes:t
 107 sgml-indent-step:2
 108 sgml-indent-data:t
 109 sgml-parent-document:nil
 110 sgml-default-dtd-file:nil
 111 sgml-exposed-tags:nil
 112 sgml-local-catalogs:nil
 113 sgml-local-ecat-files:nil
 114 End:
 115 -->