← Back to branch summary

~xnox/ubuntu/saucy/lxc/dep8

« back to all changes in this revision

Viewing changes to doc/lxc-start.sgml.in

  • Committer: Stéphane Graber
  • Date: 2013-02-18 15:20:18 UTC
  • mto: This revision was merged to the branch mainline in revision 190.
  • Revision ID: stgraber@ubuntu.com-20130218152018-ls2gi9hkqs2kuhj8
Tags: upstream-0.9.0~alpha3
Import upstream version 0.9.0~alpha3

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/lxc-start.sgml.in
1
 
<!-- 
 
1
<!--
2
2
 
3
3
lxc: linux Container library
4
4
 
23
23
 
24
24
-->
25
25
 
26
 
<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
 
26
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
27
27
 
28
28
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
29
29
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
47
47
  </refnamediv>
48
48
 
49
49
  <refsynopsisdiv>
50
 
    <cmdsynopsis><command>lxc-start <replaceable>-n
51
 
    name</replaceable> <optional>-f
52
 
    config_file</optional> <optional>-c
53
 
    console_file</optional> <optional>-d</optional> <optional>-s
54
 
    KEY=VAL</optional>
55
 
    <optional>command</optional></command></cmdsynopsis>
 
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>
 
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">command</arg>
 
61
    </cmdsynopsis>
56
62
  </refsynopsisdiv>
57
63
 
58
64
  <refsect1>
71
77
      defined, the default isolation is used.
72
78
    </para>
73
79
    <para>
74
 
      The orphan process group
75
 
      and daemon are not supported by this command, use
76
 
      the <command>lxc-execute</command> command instead.
77
 
    </para>
78
 
    <para>
79
80
      If no command is specified, <command>lxc-start</command> will
80
81
      use the default
81
82
      <command>"/sbin/init"</command> command to run a system
105
106
 
106
107
      <varlistentry>
107
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
 
 
118
      <varlistentry>
 
119
        <term>
108
120
          <option>-f, --rcfile <replaceable>config_file</replaceable></option>
109
121
        </term>
110
122
        <listitem>
123
135
      <varlistentry>
124
136
        <term>
125
137
          <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.
 
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>
 
153
        </term>
 
154
        <listitem>
 
155
          <para>
 
156
            Specify a file to log the container's console output to.
133
157
          </para>
134
158
        </listitem>
135
159
      </varlistentry>
147
171
        </listitem>
148
172
      </varlistentry>
149
173
 
 
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
 
150
189
    </variablelist>
151
190
 
152
191
  </refsect1>
167
206
            container or create a new one.
168
207
          </para>
169
208
        </listitem>
170
 
      </varlistentry>    
 
209
      </varlistentry>
171
210
 
172
211
    </variablelist>
173
212