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