]>
Commit | Line | Data |
---|---|---|
f79d43bb | 1 | <!-- |
d823d5b9 | 2 | |
3 | lxc: linux Container library | |
4 | ||
5 | (C) Copyright IBM Corp. 2007, 2008 | |
6 | ||
7 | Authors: | |
9afe19d6 | 8 | Daniel Lezcano <daniel.lezcano at free.fr> |
d823d5b9 | 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 | |
250b1eec | 22 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
d823d5b9 | 23 | |
24 | --> | |
25 | ||
7f951458 | 26 | <!DOCTYPE refentry PUBLIC @docdtd@ [ |
99e4008c | 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> | |
b4578c5b DE |
50 | <cmdsynopsis> |
51 | <command>lxc-start</command> | |
52 | <arg choice="req">-n <replaceable>name</replaceable></arg> | |
53 | <arg choice="opt">-f <replaceable>config_file</replaceable></arg> | |
596a818d DE |
54 | <arg choice="opt">-c <replaceable>console_device</replaceable></arg> |
55 | <arg choice="opt">-L <replaceable>console_logfile</replaceable></arg> | |
b4578c5b | 56 | <arg choice="opt">-d</arg> |
3114c982 | 57 | <arg choice="opt">-p <replaceable>pid_file</replaceable></arg> |
b4578c5b DE |
58 | <arg choice="opt">-s KEY=VAL</arg> |
59 | <arg choice="opt">-C</arg> | |
60 | <arg choice="opt">command</arg> | |
61 | </cmdsynopsis> | |
d823d5b9 | 62 | </refsynopsisdiv> |
63 | ||
64 | <refsect1> | |
65 | <title>Description</title> | |
66 | ||
67 | <para> | |
94b81f61 MN |
68 | <command>lxc-start</command> runs the specified |
69 | <replaceable>command</replaceable> inside the container | |
70 | specified by <replaceable>name</replaceable>. | |
71 | </para> | |
72 | <para> | |
73 | It will setup the container | |
74 | according to the configuration previously defined with the | |
75 | lxc-create command or with the configuration file parameter. | |
76 | If no configuration is | |
77 | defined, the default isolation is used. | |
78 | </para> | |
94b81f61 | 79 | <para> |
d823d5b9 | 80 | If no command is specified, <command>lxc-start</command> will |
81 | use the default | |
82 | <command>"/sbin/init"</command> command to run a system | |
83 | container. | |
d823d5b9 | 84 | </para> |
85 | ||
86 | </refsect1> | |
87 | ||
c36583c3 DL |
88 | <refsect1> |
89 | ||
90 | <title>Options</title> | |
91 | ||
92 | <variablelist> | |
93 | ||
94 | <varlistentry> | |
95 | <term> | |
96 | <option>-d, --daemon</option> | |
97 | </term> | |
98 | <listitem> | |
99 | <para> | |
100 | Run the container as a daemon. As the container has no | |
101 | more tty, if an error occurs nothing will be displayed, | |
102 | the log file can be used to check the error. | |
103 | </para> | |
104 | </listitem> | |
105 | </varlistentry> | |
106 | ||
3114c982 NC |
107 | <varlistentry> |
108 | <term> | |
109 | <option>-p, --pidfile <replaceable>pid_file</replaceable></option> | |
110 | </term> | |
111 | <listitem> | |
112 | <para> | |
113 | Create a file with the process id. | |
114 | </para> | |
115 | </listitem> | |
116 | </varlistentry> | |
117 | ||
0f71d073 DL |
118 | <varlistentry> |
119 | <term> | |
94b81f61 | 120 | <option>-f, --rcfile <replaceable>config_file</replaceable></option> |
0f71d073 DL |
121 | </term> |
122 | <listitem> | |
123 | <para> | |
124 | Specify the configuration file to configure the virtualization | |
125 | and isolation functionalities for the container. | |
126 | </para> | |
becc0400 MN |
127 | <para> |
128 | This configuration file if present will be used even if there is | |
129 | already a configuration file present in the previously created | |
130 | container (via lxc-create). | |
131 | </para> | |
0f71d073 DL |
132 | </listitem> |
133 | </varlistentry> | |
134 | ||
829dd918 DL |
135 | <varlistentry> |
136 | <term> | |
137 | <option>-c, | |
596a818d DE |
138 | --console <replaceable>console_device</replaceable></option> |
139 | </term> | |
140 | <listitem> | |
141 | <para> | |
142 | Specify a device to use for the container's console, for example | |
143 | /dev/tty8. If this option is not specified the current terminal | |
144 | will be used unless <option>-d</option> is specified. | |
145 | </para> | |
146 | </listitem> | |
147 | </varlistentry> | |
148 | ||
149 | <varlistentry> | |
150 | <term> | |
151 | <option>-L, | |
152 | --console-log <replaceable>console_logfile</replaceable></option> | |
829dd918 DL |
153 | </term> |
154 | <listitem> | |
155 | <para> | |
596a818d | 156 | Specify a file to log the container's console output to. |
829dd918 DL |
157 | </para> |
158 | </listitem> | |
159 | </varlistentry> | |
160 | ||
33ba4ad7 CLG |
161 | <varlistentry> |
162 | <term> | |
94b81f61 | 163 | <option>-s, --define <replaceable>KEY=VAL</replaceable></option> |
33ba4ad7 CLG |
164 | </term> |
165 | <listitem> | |
166 | <para> | |
167 | Assign value <replaceable>VAL</replaceable> to configuration | |
168 | variable <replaceable>KEY</replaceable>. This overrides any | |
169 | assignment done in <replaceable>config_file</replaceable>. | |
170 | </para> | |
171 | </listitem> | |
172 | </varlistentry> | |
173 | ||
1305dd24 SH |
174 | <varlistentry> |
175 | <term> | |
176 | <option>-C, | |
177 | --close-all-fds</option> | |
178 | </term> | |
179 | <listitem> | |
180 | <para> | |
181 | If any file descriptors are inherited, close them. If this option | |
182 | is not specified, then <command>lxc-start</command> will exit with | |
183 | failure instead. Note: <replaceable>--daemon</replaceable> implies | |
184 | <replaceable>--close-all-fds</replaceable>. | |
185 | </para> | |
186 | </listitem> | |
187 | </varlistentry> | |
188 | ||
c36583c3 DL |
189 | </variablelist> |
190 | ||
191 | </refsect1> | |
192 | ||
10fba81b | 193 | &commonoptions; |
d823d5b9 | 194 | |
195 | <refsect1> | |
196 | <title>Diagnostic</title> | |
197 | ||
198 | <variablelist> | |
199 | ||
200 | <varlistentry> | |
201 | <term>The container is busy</term> | |
202 | <listitem> | |
203 | <para> | |
204 | The specified container is already running an | |
205 | application. You should stop it before reuse this | |
206 | container or create a new one. | |
207 | </para> | |
208 | </listitem> | |
f79d43bb | 209 | </varlistentry> |
d823d5b9 | 210 | |
d823d5b9 | 211 | </variablelist> |
212 | ||
213 | </refsect1> | |
214 | ||
99e4008c | 215 | &seealso; |
d823d5b9 | 216 | |
217 | <refsect1> | |
218 | <title>Author</title> | |
219 | <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para> | |
220 | </refsect1> | |
221 | ||
222 | </refentry> | |
223 | ||
224 | <!-- Keep this comment at the end of the file | |
225 | Local variables: | |
226 | mode: sgml | |
227 | sgml-omittag:t | |
228 | sgml-shorttag:t | |
229 | sgml-minimize-attributes:nil | |
230 | sgml-always-quote-attributes:t | |
231 | sgml-indent-step:2 | |
232 | sgml-indent-data:t | |
233 | sgml-parent-document:nil | |
234 | sgml-default-dtd-file:nil | |
235 | sgml-exposed-tags:nil | |
236 | sgml-local-catalogs:nil | |
237 | sgml-local-ecat-files:nil | |
238 | End: | |
239 | --> |