]>
Commit | Line | Data |
---|---|---|
d823d5b9 | 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 | ||
99e4008c MN |
26 | <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ |
27 | ||
10fba81b | 28 | <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml"> |
99e4008c MN |
29 | <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> |
30 | ]> | |
d823d5b9 | 31 | |
32 | <refentry> | |
33 | ||
34 | <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo> | |
35 | ||
36 | <refmeta> | |
37 | <refentrytitle>lxc-start</refentrytitle> | |
38 | <manvolnum>1</manvolnum> | |
39 | </refmeta> | |
40 | ||
41 | <refnamediv> | |
42 | <refname>lxc-start</refname> | |
43 | ||
44 | <refpurpose> | |
45 | run an application inside a container. | |
46 | </refpurpose> | |
47 | </refnamediv> | |
48 | ||
49 | <refsynopsisdiv> | |
6a22713f DL |
50 | <cmdsynopsis><command>lxc-start <replaceable>-n |
51 | name</replaceable> <optional>-f | |
829dd918 DL |
52 | config_file</optional> <optional>-c |
53 | console_file</optional> <optional>-d</optional> <optional>-s | |
1305dd24 | 54 | KEY=VAL</optional> <optional>-C</optional> |
33ba4ad7 | 55 | <optional>command</optional></command></cmdsynopsis> |
d823d5b9 | 56 | </refsynopsisdiv> |
57 | ||
58 | <refsect1> | |
59 | <title>Description</title> | |
60 | ||
61 | <para> | |
94b81f61 MN |
62 | <command>lxc-start</command> runs the specified |
63 | <replaceable>command</replaceable> inside the container | |
64 | specified by <replaceable>name</replaceable>. | |
65 | </para> | |
66 | <para> | |
67 | It will setup the container | |
68 | according to the configuration previously defined with the | |
69 | lxc-create command or with the configuration file parameter. | |
70 | If no configuration is | |
71 | defined, the default isolation is used. | |
72 | </para> | |
73 | <para> | |
74 | The orphan process group | |
6a22713f DL |
75 | and daemon are not supported by this command, use |
76 | the <command>lxc-execute</command> command instead. | |
94b81f61 MN |
77 | </para> |
78 | <para> | |
d823d5b9 | 79 | If no command is specified, <command>lxc-start</command> will |
80 | use the default | |
81 | <command>"/sbin/init"</command> command to run a system | |
82 | container. | |
d823d5b9 | 83 | </para> |
84 | ||
85 | </refsect1> | |
86 | ||
c36583c3 DL |
87 | <refsect1> |
88 | ||
89 | <title>Options</title> | |
90 | ||
91 | <variablelist> | |
92 | ||
93 | <varlistentry> | |
94 | <term> | |
95 | <option>-d, --daemon</option> | |
96 | </term> | |
97 | <listitem> | |
98 | <para> | |
99 | Run the container as a daemon. As the container has no | |
100 | more tty, if an error occurs nothing will be displayed, | |
101 | the log file can be used to check the error. | |
102 | </para> | |
103 | </listitem> | |
104 | </varlistentry> | |
105 | ||
0f71d073 DL |
106 | <varlistentry> |
107 | <term> | |
94b81f61 | 108 | <option>-f, --rcfile <replaceable>config_file</replaceable></option> |
0f71d073 DL |
109 | </term> |
110 | <listitem> | |
111 | <para> | |
112 | Specify the configuration file to configure the virtualization | |
113 | and isolation functionalities for the container. | |
114 | </para> | |
becc0400 MN |
115 | <para> |
116 | This configuration file if present will be used even if there is | |
117 | already a configuration file present in the previously created | |
118 | container (via lxc-create). | |
119 | </para> | |
0f71d073 DL |
120 | </listitem> |
121 | </varlistentry> | |
122 | ||
829dd918 DL |
123 | <varlistentry> |
124 | <term> | |
125 | <option>-c, | |
126 | --console <replaceable>console_file</replaceable></option> | |
127 | </term> | |
128 | <listitem> | |
129 | <para> | |
130 | Specify a file to output the container console. If the | |
131 | option is not specified the output will go the terminal | |
132 | except if the <option>-d</option> is specified. | |
133 | </para> | |
134 | </listitem> | |
135 | </varlistentry> | |
136 | ||
33ba4ad7 CLG |
137 | <varlistentry> |
138 | <term> | |
94b81f61 | 139 | <option>-s, --define <replaceable>KEY=VAL</replaceable></option> |
33ba4ad7 CLG |
140 | </term> |
141 | <listitem> | |
142 | <para> | |
143 | Assign value <replaceable>VAL</replaceable> to configuration | |
144 | variable <replaceable>KEY</replaceable>. This overrides any | |
145 | assignment done in <replaceable>config_file</replaceable>. | |
146 | </para> | |
147 | </listitem> | |
148 | </varlistentry> | |
149 | ||
1305dd24 SH |
150 | <varlistentry> |
151 | <term> | |
152 | <option>-C, | |
153 | --close-all-fds</option> | |
154 | </term> | |
155 | <listitem> | |
156 | <para> | |
157 | If any file descriptors are inherited, close them. If this option | |
158 | is not specified, then <command>lxc-start</command> will exit with | |
159 | failure instead. Note: <replaceable>--daemon</replaceable> implies | |
160 | <replaceable>--close-all-fds</replaceable>. | |
161 | </para> | |
162 | </listitem> | |
163 | </varlistentry> | |
164 | ||
c36583c3 DL |
165 | </variablelist> |
166 | ||
167 | </refsect1> | |
168 | ||
10fba81b | 169 | &commonoptions; |
d823d5b9 | 170 | |
171 | <refsect1> | |
172 | <title>Diagnostic</title> | |
173 | ||
174 | <variablelist> | |
175 | ||
176 | <varlistentry> | |
177 | <term>The container is busy</term> | |
178 | <listitem> | |
179 | <para> | |
180 | The specified container is already running an | |
181 | application. You should stop it before reuse this | |
182 | container or create a new one. | |
183 | </para> | |
184 | </listitem> | |
185 | </varlistentry> | |
186 | ||
d823d5b9 | 187 | </variablelist> |
188 | ||
189 | </refsect1> | |
190 | ||
99e4008c | 191 | &seealso; |
d823d5b9 | 192 | |
193 | <refsect1> | |
194 | <title>Author</title> | |
195 | <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para> | |
196 | </refsect1> | |
197 | ||
198 | </refentry> | |
199 | ||
200 | <!-- Keep this comment at the end of the file | |
201 | Local variables: | |
202 | mode: sgml | |
203 | sgml-omittag:t | |
204 | sgml-shorttag:t | |
205 | sgml-minimize-attributes:nil | |
206 | sgml-always-quote-attributes:t | |
207 | sgml-indent-step:2 | |
208 | sgml-indent-data:t | |
209 | sgml-parent-document:nil | |
210 | sgml-default-dtd-file:nil | |
211 | sgml-exposed-tags:nil | |
212 | sgml-local-catalogs:nil | |
213 | sgml-local-ecat-files:nil | |
214 | End: | |
215 | --> |