File: lxc-console.sgml.in

package info (click to toggle)
lxc 1%3A1.0.6-6
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 4,800 kB
  • sloc: ansic: 33,735; sh: 11,868; python: 1,223; makefile: 734
file content (173 lines) | stat: -rw-r--r-- 4,609 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<!--

lxc: linux Container library

(C) Copyright IBM Corp. 2007, 2008

Authors:
Daniel Lezcano <daniel.lezcano at free.fr>

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

-->

<!DOCTYPE refentry PUBLIC @docdtd@ [

<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]>

<refentry>

  <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>

  <refmeta>
    <refentrytitle>lxc-console</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>lxc-console</refname>

    <refpurpose>
      Launch a console for the specified container
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>lxc-console</command>
      <arg choice="req">-n <replaceable>name</replaceable></arg>
      <arg choice="opt">-e <replaceable>escape character</replaceable></arg>
      <arg choice="opt">-t <replaceable>ttynum</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para>
      If the tty service has been configured and is available for the
      container specified as parameter, this command will launch a
      console allowing to log on the container.
    </para>

    <para>
      The available tty are free slots taken by this command. That
      means if the container has four ttys available and the command
      has been launched four times each taking a different tty, the
      fifth command will fail because no console will be available.
    </para>

    <para>
      The command will connect to a tty. If the connection is lost or
      broken, the command can be launched again and regain the tty at
      the state it was before the disconnection.
    </para>

    <para>
      A <replaceable>ttynum</replaceable> of 0 may be given to attach
      to the container's /dev/console instead of its
      dev/tty&lt;<replaceable>ttynum</replaceable>&gt;.
    </para>

    <para>
      A keyboard escape sequence may be used to disconnect from the tty
      and quit lxc-console. The default escape sequence is &lt;Ctrl+a q&gt;.
    </para>

  </refsect1>

  <refsect1>
    <title>Options</title>
    <variablelist>

      <varlistentry>
	<term>
	  <option>-e <optional><replaceable>escape character</replaceable></optional></option>
	</term>
	<listitem>
	  <para>
	    Specify the escape sequence prefix to use instead of
            &lt;Ctrl a&gt;.
            This may be given as '^letter' or just 'letter'. For example
            to use &lt;Ctrl+b q&gt; as the escape sequence use -e '^b'.
	  </para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
	  <option>-t <optional><replaceable>ttynum</replaceable></optional></option>
	</term>
	<listitem>
	  <para>
	    Specify the tty number to connect to or 0 for the console. If not
	    specified the next available tty number will be automatically
	    chosen by the container.
	  </para>
	</listitem>
      </varlistentry>

    </variablelist>

  </refsect1>

  &commonoptions;

  <refsect1>
    <title>Diagnostic</title>

    <variablelist>

      <varlistentry>
        <term>tty service denied</term>
        <listitem>
          <para>
	    No tty is available or there is not enough privilege to
	    use the console. For example, the container belongs to
	    user "foo" and "bar" is trying to open a console to it.
          </para>
        </listitem>
      </varlistentry>

    </variablelist>

  </refsect1>

  &seealso;

  <refsect1>
    <title>Author</title>
    <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
  </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->