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