~ubuntu-branches/ubuntu/quantal/lxc/quantal-201206191543

« back to all changes in this revision

Viewing changes to doc/lxc-execute.1

  • Committer: Package Import Robot
  • Author(s): Daniel Baumann
  • Date: 2012-03-09 13:05:03 UTC
  • mto: (3.1.38 sid)
  • mto: This revision was merged to the branch mainline in revision 94.
  • Revision ID: package-import@ubuntu.com-20120309130503-j0prgw9tsp967bbv
Tags: upstream-0.8.0~rc1
ImportĀ upstreamĀ versionĀ 0.8.0~rc1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" This manpage has been automatically generated by docbook2man 
 
2
.\" from a DocBook document.  This tool can be found at:
 
3
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 
4
.\" Please send any bug reports, improvements, comments, patches, 
 
5
.\" etc. to Steve Cheng <steve@ggi-project.org>.
 
6
.TH "LXC-EXECUTE" "1" "02 March 2012" "" ""
 
7
 
 
8
.SH NAME
 
9
lxc-execute \- run an application inside a container.
 
10
.SH SYNOPSIS
 
11
 
 
12
\fBlxc-execute \fI-n name\fB
 
13
[-f config_file] [-s KEY=VAL
 
14
]
 
15
[--]
 
16
\fIcommand\fB\fR
 
17
 
 
18
.SH "DESCRIPTION"
 
19
.PP
 
20
\fBlxc-execute\fR runs the specified
 
21
\fIcommand\fR inside the container
 
22
specified by \fIname\fR\&.
 
23
.PP
 
24
It will setup the container
 
25
according to the configuration previously defined with the
 
26
lxc-create command or with the configuration file parameter.
 
27
If no configuration is
 
28
defined, the default isolation is used.
 
29
.PP
 
30
This command is mainly used when you want to quickly launch an
 
31
application in an isolated environment.
 
32
.PP
 
33
\fBlxc-execute\fR command will run the
 
34
specified command into the container via an intermediate
 
35
process, \fBlxc-init\fR\&.
 
36
This lxc-init after launching  the specified command,
 
37
will wait for its end and all other reparented processes.
 
38
(that allows to support daemons in the container).
 
39
In other words, in the
 
40
container, \fBlxc-init\fR has the pid 1 and the
 
41
first process of the application has the pid 2.
 
42
.PP
 
43
The above \fBlxc-init\fR is designed to forward received
 
44
signals to the started command.
 
45
So \fBlxc-kill\fR (1) sent signal is received
 
46
by the user specified command (pid 2 in the container).
 
47
.SH "OPTIONS"
 
48
.TP
 
49
\fB   -f, --rcfile \fIconfig_file\fB \fR
 
50
Specify the configuration file to configure the virtualization
 
51
and isolation functionalities for the container.
 
52
 
 
53
This configuration file if present will be used even if there is
 
54
already a configuration file present in the previously created
 
55
container (via lxc-create).
 
56
.TP
 
57
\fB   -s, --define \fIKEY=VAL\fB \fR
 
58
Assign value \fIVAL\fR to configuration
 
59
variable \fIKEY\fR\&. This overrides any
 
60
assignment done in \fIconfig_file\fR\&.
 
61
.TP
 
62
\fB--\fR
 
63
Signal the end of options and disables further option
 
64
processing. Any arguments after the -- are treated as
 
65
arguments.
 
66
 
 
67
This option is useful when you want to execute, with the
 
68
command \fBlxc-execute\fR, a command line
 
69
with its own options.
 
70
.SH "COMMON OPTIONS"
 
71
.PP
 
72
These options are common to most of lxc commands.
 
73
.TP
 
74
\fB-?, -h, --help\fR
 
75
Print a longer usage message than normal.
 
76
.TP
 
77
\fB--usage\fR
 
78
Give the usage message
 
79
.TP
 
80
\fB-q, --quiet\fR
 
81
mute on
 
82
.TP
 
83
\fB-o, --logfile=\fIFILE\fB\fR
 
84
Output to an alternate log
 
85
\fIFILE\fR\&. The default is no log.
 
86
.TP
 
87
\fB-l, --logpriority=\fILEVEL\fB\fR
 
88
Set log priority to
 
89
\fILEVEL\fR\&. The default log
 
90
priority is ERROR\&. Possible values are :
 
91
FATAL, CRIT,
 
92
WARN, ERROR,
 
93
NOTICE, INFO,
 
94
DEBUG\&.
 
95
 
 
96
Note that this option is setting the priority of the events
 
97
log in the alternate log file. It do not have effect on the
 
98
ERROR events log on stderr.
 
99
.TP
 
100
\fB-n, --name=\fINAME\fB\fR
 
101
Use container identifier \fINAME\fR\&.
 
102
The container identifier format is an alphanumeric string.
 
103
.SH "DIAGNOSTIC"
 
104
.TP
 
105
\fBThe container is busy\fR
 
106
The specified container is already running an
 
107
application. You should stop it before reuse this
 
108
container or create a new one.
 
109
.SH "SEE ALSO"
 
110
.PP
 
111
\fBlxc\fR(1),
 
112
\fBlxc-create\fR(1),
 
113
\fBlxc-destroy\fR(1),
 
114
\fBlxc-start\fR(1),
 
115
\fBlxc-stop\fR(1),
 
116
\fBlxc-execute\fR(1),
 
117
\fBlxc-kill\fR(1),
 
118
\fBlxc-console\fR(1),
 
119
\fBlxc-monitor\fR(1),
 
120
\fBlxc-wait\fR(1),
 
121
\fBlxc-cgroup\fR(1),
 
122
\fBlxc-ls\fR(1),
 
123
\fBlxc-ps\fR(1),
 
124
\fBlxc-info\fR(1),
 
125
\fBlxc-freeze\fR(1),
 
126
\fBlxc-unfreeze\fR(1),
 
127
\fBlxc-attach\fR(1),
 
128
\fBlxc.conf\fR(5)
 
129
.SH "AUTHOR"
 
130
.PP
 
131
Daniel Lezcano <daniel.lezcano@free.fr>