doc/lxc-start.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-start</refentrytitle>
  34     <manvolnum>1</manvolnum>
  35   </refmeta>
  36
  37   <refnamediv>
  38     <refname>lxc-start</refname>
  39
  40     <refpurpose>
  41       run an application inside a container.
  42     </refpurpose>
  43   </refnamediv>
  44
  45   <refsynopsisdiv>
  46     <cmdsynopsis>
  47       <command>lxc-start <replaceable>-n name</replaceable>
  48         <optional>command</optional>
  49       </command>
  50     </cmdsynopsis>
  51   </refsynopsisdiv>
  52
  53   <refsect1>
  54     <title>Description</title>
  55
  56     <para>
  57       <command>lxc-start</command> runs the specified command inside
  58       the container specified by name. It will setup the container
  59       according with the configuration defined previously with the
  60       lxc-create command and execute the command inside the
  61       container. The orphan process group and daemon are not supported
  62       by this command.
  63
  64       If no command is specified, <command>lxc-start</command> will
  65       use the default
  66       <command>"/sbin/init"</command> command to run a system
  67       container.
  68
  69     </para>
  70
  71   </refsect1>
  72
  73   <refsect1>
  74     <title>Options</title>
  75     <variablelist>
  76
  77       <varlistentry>
  78         <term>
  79           <option>-n <replaceable>name</replaceable></option>
  80         </term>
  81         <listitem>
  82           <para>
  83             Specify the container name to be started.
  84           </para>
  85         </listitem>
  86       </varlistentry>
  87
  88     </variablelist>
  89
  90   </refsect1>
  91
  92   <refsect1>
  93     <title>Diagnostic</title>
  94
  95     <variablelist>
  96
  97       <varlistentry>
  98         <term>The container is busy</term>
  99         <listitem>
 100           <para>
 101             The specified container is already running an
 102             application. You should stop it before reuse this
 103             container or create a new one.
 104           </para>
 105         </listitem>
 106       </varlistentry>
 107
 108       <varlistentry>
 109         <term>The container was not found</term>
 110         <listitem>
 111           <para>
 112             The specified container was not created before with
 113             the <command>lxc-create</command>
 114           </para>
 115         </listitem>
 116       </varlistentry>
 117
 118
 119     </variablelist>
 120
 121   </refsect1>
 122
 123   <refsect1>
 124     <title>See Also</title>
 125
 126     <simpara>
 127       <citerefentry>
 128         <refentrytitle><command>lxc-create</command></refentrytitle>
 129         <manvolnum>1</manvolnum>
 130       </citerefentry>,
 131
 132       <citerefentry>
 133         <refentrytitle><command>lxc-destroy</command></refentrytitle>
 134         <manvolnum>1</manvolnum>
 135       </citerefentry>,
 136
 137       <citerefentry>
 138         <refentrytitle><command>lxc-start</command></refentrytitle>
 139         <manvolnum>1</manvolnum>
 140       </citerefentry>,
 141
 142       <citerefentry>
 143         <refentrytitle><command>lxc-stop</command></refentrytitle>
 144         <manvolnum>1</manvolnum>
 145       </citerefentry>,
 146
 147       <citerefentry>
 148         <refentrytitle><command>lxc.conf</command></refentrytitle>
 149         <manvolnum>5</manvolnum>
 150       </citerefentry>
 151
 152     </simpara>
 153
 154
 155   </refsect1>
 156
 157   <refsect1>
 158     <title>Author</title>
 159     <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 160   </refsect1>
 161
 162 </refentry>
 163
 164 <!-- Keep this comment at the end of the file
 165 Local variables:
 166 mode: sgml
 167 sgml-omittag:t
 168 sgml-shorttag:t
 169 sgml-minimize-attributes:nil
 170 sgml-always-quote-attributes:t
 171 sgml-indent-step:2
 172 sgml-indent-data:t
 173 sgml-parent-document:nil
 174 sgml-default-dtd-file:nil
 175 sgml-exposed-tags:nil
 176 sgml-local-catalogs:nil
 177 sgml-local-ecat-files:nil
 178 End:
 179 -->