<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!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">-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 taking the 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>

</refsect1>

<refsect1>

<title>Options</title>

<variablelist>

<varlistentry>

<term>

<option>-t <optional><replaceable>ttynum</replaceable></optional></option>

</term>

<listitem>

<para>

Specify the tty number to connect, if not specified a tty

number will be automatically choosen 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>