3 lxc: linux Container library
5 (C) Copyright IBM Corp. 2007, 2008
8 Daniel Lezcano <daniel.lezcano at free.fr>
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.
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.
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
26 <!DOCTYPE refentry PUBLIC @docdtd@ [
28 <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
29 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
34 <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
37 <refentrytitle>lxc-start</refentrytitle>
38 <manvolnum>1</manvolnum>
42 <refname>lxc-start</refname>
45 run an application inside a container.
51 <command>lxc-start</command>
52 <arg choice="req">-n <replaceable>name</replaceable></arg>
53 <arg choice="opt">-f <replaceable>config_file</replaceable></arg>
54 <arg choice="opt">-c <replaceable>console_device</replaceable></arg>
55 <arg choice="opt">-L <replaceable>console_logfile</replaceable></arg>
56 <arg choice="opt">-d</arg>
57 <arg choice="opt">-p <replaceable>pid_file</replaceable></arg>
58 <arg choice="opt">-s KEY=VAL</arg>
59 <arg choice="opt">-C</arg>
60 <arg choice="opt">--share-[net|ipc|uts] <replaceable>name|pid</replaceable></arg>
61 <arg choice="opt">command</arg>
66 <title>Description</title>
69 <command>lxc-start</command> runs the specified
70 <replaceable>command</replaceable> inside the container
71 specified by <replaceable>name</replaceable>.
74 It will setup the container
75 according to the configuration previously defined with the
76 lxc-create command or with the configuration file parameter.
77 If no configuration is
78 defined, the default isolation is used.
81 If no command is specified, <command>lxc-start</command> will
83 <command>"/sbin/init"</command> command to run a system
91 <title>Options</title>
97 <option>-d, --daemon</option>
101 Run the container as a daemon. As the container has no
102 more tty, if an error occurs nothing will be displayed,
103 the log file can be used to check the error.
110 <option>-p, --pidfile <replaceable>pid_file</replaceable></option>
114 Create a file with the process id.
121 <option>-f, --rcfile <replaceable>config_file</replaceable></option>
125 Specify the configuration file to configure the virtualization
126 and isolation functionalities for the container.
129 This configuration file if present will be used even if there is
130 already a configuration file present in the previously created
131 container (via lxc-create).
139 --console <replaceable>console_device</replaceable></option>
143 Specify a device to use for the container's console, for example
144 /dev/tty8. If this option is not specified the current terminal
145 will be used unless <option>-d</option> is specified.
153 --console-log <replaceable>console_logfile</replaceable></option>
157 Specify a file to log the container's console output to.
164 <option>-s, --define <replaceable>KEY=VAL</replaceable></option>
168 Assign value <replaceable>VAL</replaceable> to configuration
169 variable <replaceable>KEY</replaceable>. This overrides any
170 assignment done in <replaceable>config_file</replaceable>.
178 --close-all-fds</option>
182 If any file descriptors are inherited, close them. If this option
183 is not specified, then <command>lxc-start</command> will exit with
184 failure instead. Note: <replaceable>--daemon</replaceable> implies
185 <replaceable>--close-all-fds</replaceable>.
192 <option>--share-net <replaceable>name|pid</replaceable></option>
196 Inherit a network namespace from
197 a <replaceable>name</replaceable> container or
198 a <replaceable>pid</replaceable>. The network namespace
199 will continue to be managed by the original owner. The
200 network configuration of the starting container is ignored
201 and the up/down scripts won't be executed.
208 <option>--share-ipc <replaceable>name|pid</replaceable></option>
212 Inherit an IPC namespace from
213 a <replaceable>name</replaceable> container or
214 a <replaceable>pid</replaceable>.
221 <option>--share-uts <replaceable>name|pid</replaceable></option>
225 Inherit a UTS namespace from
226 a <replaceable>name</replaceable> container or
227 a <replaceable>pid</replaceable>. The starting LXC will
228 not set the hostname, but the container OS may do it
241 <title>Diagnostic</title>
246 <term>The container is busy</term>
249 The specified container is already running an
250 application. You should stop it before reuse this
251 container or create a new one.
263 <title>Author</title>
264 <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
269 <!-- Keep this comment at the end of the file
274 sgml-minimize-attributes:nil
275 sgml-always-quote-attributes:t
278 sgml-parent-document:nil
279 sgml-default-dtd-file:nil
280 sgml-exposed-tags:nil
281 sgml-local-catalogs:nil
282 sgml-local-ecat-files:nil