Debian Codegraph @

doc/lxc-console.sgml.in

raw
1 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
2
3 <!DOCTYPE refentry PUBLIC @docdtd@ [
4
5 <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
6 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
7 ]>
8
9 <refentry>
10
11 <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
12
13 <refmeta>
14 <refentrytitle>lxc-console</refentrytitle>
15 <manvolnum>1</manvolnum>
16 </refmeta>
17
18 <refnamediv>
19 <refname>lxc-console</refname>
20
21 <refpurpose>
22 Launch a console for the specified container
23 </refpurpose>
24 </refnamediv>
25
26 <refsynopsisdiv>
27 <cmdsynopsis>
28 <command>lxc-console</command>
29 <arg choice="req">-n <replaceable>name</replaceable></arg>
30 <arg choice="opt">-e <replaceable>escape character</replaceable></arg>
31 <arg choice="opt">-t <replaceable>ttynum</replaceable></arg>
32 </cmdsynopsis>
33 </refsynopsisdiv>
34
35 <refsect1>
36 <title>Description</title>
37
38 <para>
39 If the tty service has been configured and is available for the
40 container specified as parameter, this command will launch a
41 console allowing to log on the container.
42 </para>
43
44 <para>
45 The available tty are free slots taken by this command. That
46 means if the container has four ttys available and the command
47 has been launched four times each taking a different tty, the
48 fifth command will fail because no console will be available.
49 </para>
50
51 <para>
52 The command will connect to a tty. If the connection is lost or
53 broken, the command can be launched again and regain the tty at
54 the state it was before the disconnection.
55 </para>
56
57 <para>
58 A <replaceable>ttynum</replaceable> of 0 may be given to attach
59 to the container's /dev/console instead of its
60 dev/tty&lt;<replaceable>ttynum</replaceable>&gt;.
61 </para>
62
63 <para>
64 A keyboard escape sequence may be used to disconnect from the tty
65 and quit lxc-console. The default escape sequence is &lt;Ctrl+a q&gt;.
66 </para>
67
68 </refsect1>
69
70 <refsect1>
71 <title>Options</title>
72 <variablelist>
73
74 <varlistentry>
75 <term>
76 <option>-e, --escape <replaceable>escape character</replaceable></option>
77 </term>
78 <listitem>
79 <para>
80 Specify the escape sequence prefix to use instead of
81 &lt;Ctrl a&gt;.
82 This may be given as '^letter' or just 'letter'. For example
83 to use &lt;Ctrl+b q&gt; as the escape sequence use -e '^b'.
84 </para>
85 </listitem>
86 </varlistentry>
87 <varlistentry>
88 <term>
89 <option>-t, --tty <replaceable>ttynum</replaceable></option>
90 </term>
91 <listitem>
92 <para>
93 Specify the tty number to connect to or 0 for the console. If not
94 specified the next available tty number will be automatically
95 chosen by the container.
96 </para>
97 </listitem>
98 </varlistentry>
99
100 </variablelist>
101
102 </refsect1>
103
104 &commonoptions;
105
106 <refsect1>
107 <title>Diagnostic</title>
108
109 <variablelist>
110
111 <varlistentry>
112 <term>tty service denied</term>
113 <listitem>
114 <para>
115 No tty is available or there is not enough privilege to
116 use the console. For example, the container belongs to
117 user "foo" and "bar" is trying to open a console to it.
118 </para>
119 </listitem>
120 </varlistentry>
121
122 </variablelist>
123
124 </refsect1>
125
126 &seealso;
127
128 </refentry>
129
130 <!-- Keep this comment at the end of the file
131 Local variables:
132 mode: sgml
133 sgml-omittag:t
134 sgml-shorttag:t
135 sgml-minimize-attributes:nil
136 sgml-always-quote-attributes:t
137 sgml-indent-step:2
138 sgml-indent-data:t
139 sgml-parent-document:nil
140 sgml-default-dtd-file:nil
141 sgml-exposed-tags:nil
142 sgml-local-catalogs:nil
143 sgml-local-ecat-files:nil
144 End:
145 -->