-<!--
+<!--
lxc: linux Container library
(C) Copyright IBM Corp. 2007, 2008
Authors:
-Daniel Lezcano <dlezcano at fr.ibm.com>
+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
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
-->
-<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
+<!DOCTYPE refentry PUBLIC @docdtd@ [
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
<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>
<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 taking the different tty, the fifth
- command will fail because no console will be available.
+ has been launched four times each taking a different tty, the
+ fifth command will fail because no console will be available.
</para>
<para>
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<<replaceable>ttynum</replaceable>>.
+ </para>
+
+ <para>
+ A keyboard escape sequence may be used to disconnect from the tty
+ and quit lxc-console. The default escape sequence is <Ctrl+a q>.
+ </para>
+
</refsect1>
<refsect1>
<varlistentry>
<term>
- <option>-t <optional><replaceable>ttynum</replaceable></optional></option>
+ <option>-e, --escape <replaceable>escape character</replaceable></option>
</term>
<listitem>
<para>
- Specify the tty number to connect, if not specified a tty
- number will be automatically choosen by the container.
+ Specify the escape sequence prefix to use instead of
+ <Ctrl a>.
+ This may be given as '^letter' or just 'letter'. For example
+ to use <Ctrl+b q> as the escape sequence use -e '^b'.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>-t, --tty <replaceable>ttynum</replaceable></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>
user "foo" and "bar" is trying to open a console to it.
</para>
</listitem>
- </varlistentry>
+ </varlistentry>
</variablelist>