]>
Commit | Line | Data |
---|---|---|
b0a33c1e | 1 | <!-- |
2 | ||
3 | lxc: linux Container library | |
4 | ||
5 | (C) Copyright IBM Corp. 2007, 2008 | |
6 | ||
7 | Authors: | |
8 | Daniel Lezcano <dlezcano at fr.ibm.com> | |
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 | |
22 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
23 | ||
24 | --> | |
25 | ||
99e4008c MN |
26 | <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [ |
27 | ||
28 | <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> | |
29 | ]> | |
b0a33c1e | 30 | |
31 | <refentry> | |
32 | ||
33 | <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo> | |
34 | ||
35 | <refmeta> | |
36 | <refentrytitle>lxc-console</refentrytitle> | |
37 | <manvolnum>1</manvolnum> | |
38 | </refmeta> | |
39 | ||
40 | <refnamediv> | |
41 | <refname>lxc-console</refname> | |
42 | ||
43 | <refpurpose> | |
44 | Launch a console for the specified container | |
45 | </refpurpose> | |
46 | </refnamediv> | |
47 | ||
48 | <refsynopsisdiv> | |
49 | <cmdsynopsis> | |
50 | <command>lxc-console <replaceable>-n name</replaceable> | |
be43f17e | 51 | <optional>-t ttynum</optional> |
b0a33c1e | 52 | </command> |
53 | </cmdsynopsis> | |
54 | </refsynopsisdiv> | |
55 | ||
56 | <refsect1> | |
57 | <title>Description</title> | |
58 | ||
59 | <para> | |
60 | If the tty service has been configured and is available for the | |
61 | container specified as parameter, this command will launch a | |
be43f17e | 62 | console allowing to log on the container. |
b0a33c1e | 63 | </para> |
64 | ||
65 | <para> | |
66 | The available tty are free slots taken by this command. That | |
67 | means if the container has four ttys available and the command | |
68 | has been launched four times taking the different tty, the fifth | |
69 | command will fail because no console will be available. | |
70 | </para> | |
71 | ||
72 | <para> | |
73 | The command will connect to a tty. If the connection is lost or | |
74 | broken, the command can be launched again and regain the tty at | |
75 | the state it was before the disconnection. | |
76 | </para> | |
77 | ||
78 | </refsect1> | |
79 | ||
80 | <refsect1> | |
81 | <title>Options</title> | |
82 | <variablelist> | |
83 | ||
84 | <varlistentry> | |
85 | <term> | |
86 | <option>-n <replaceable>name</replaceable></option> | |
87 | </term> | |
88 | <listitem> | |
89 | <para> | |
90 | Specify the container name to open a console. | |
91 | </para> | |
92 | </listitem> | |
93 | </varlistentry> | |
94 | ||
95 | <varlistentry> | |
96 | <term> | |
be43f17e | 97 | <option>-t <optional>ttynum</optional></option> |
b0a33c1e | 98 | </term> |
99 | <listitem> | |
100 | <para> | |
be43f17e DL |
101 | Specify the tty number to connect, if not specified a tty |
102 | number will be automatically choosen by the container. | |
b0a33c1e | 103 | </para> |
104 | </listitem> | |
105 | </varlistentry> | |
106 | ||
107 | </variablelist> | |
108 | ||
109 | </refsect1> | |
110 | ||
111 | <refsect1> | |
112 | <title>Diagnostic</title> | |
113 | ||
114 | <variablelist> | |
115 | ||
116 | <varlistentry> | |
117 | <term>tty service denied</term> | |
118 | <listitem> | |
119 | <para> | |
120 | No tty is available or there is not enough privilege to | |
121 | use the console. For example, the container belongs to | |
122 | user "foo" and "bar" is trying to open a console to it. | |
123 | </para> | |
124 | </listitem> | |
125 | </varlistentry> | |
126 | ||
127 | </variablelist> | |
128 | ||
129 | </refsect1> | |
130 | ||
99e4008c | 131 | &seealso; |
b0a33c1e | 132 | |
133 | <refsect1> | |
134 | <title>Author</title> | |
135 | <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para> | |
136 | </refsect1> | |
137 | ||
138 | </refentry> | |
139 | ||
140 | <!-- Keep this comment at the end of the file | |
141 | Local variables: | |
142 | mode: sgml | |
143 | sgml-omittag:t | |
144 | sgml-shorttag:t | |
145 | sgml-minimize-attributes:nil | |
146 | sgml-always-quote-attributes:t | |
147 | sgml-indent-step:2 | |
148 | sgml-indent-data:t | |
149 | sgml-parent-document:nil | |
150 | sgml-default-dtd-file:nil | |
151 | sgml-exposed-tags:nil | |
152 | sgml-local-catalogs:nil | |
153 | sgml-local-ecat-files:nil | |
154 | End: | |
155 | --> |