f79d43bbe70a01454049b77d6f15f6369744959eStéphane Graber<!--
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanolxc: linux Container library
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano(C) Copyright IBM Corp. 2007, 2008
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanoAuthors:
9afe19d634946d50eab30e3b90cb5cebcde39eeaDaniel LezcanoDaniel Lezcano <daniel.lezcano at free.fr>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanoThis library is free software; you can redistribute it and/or
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanomodify it under the terms of the GNU Lesser General Public
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanoLicense as published by the Free Software Foundation; either
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanoversion 2.1 of the License, or (at your option) any later version.
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanoThis library is distributed in the hope that it will be useful,
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanobut WITHOUT ANY WARRANTY; without even the implied warranty of
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanoMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanoLesser General Public License for more details.
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanoYou should have received a copy of the GNU Lesser General Public
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanoLicense along with this library; if not, write to the Free Software
250b1eec71b074acdff1c5f6b5a1f0d7d2c20b77Stéphane GraberFoundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano-->
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
7f95145833bb24f54e037f73ecc37444d6635697Dwight Engen<!DOCTYPE refentry PUBLIC @docdtd@ [
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand
10fba81b9d0221b8e47aa1e0b43236413b7d28dfMichel Normand<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand]>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano<refentry>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <refmeta>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <refentrytitle>lxc-console</refentrytitle>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <manvolnum>1</manvolnum>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </refmeta>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <refnamediv>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <refname>lxc-console</refname>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <refpurpose>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano Launch a console for the specified container
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </refpurpose>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </refnamediv>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <refsynopsisdiv>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <cmdsynopsis>
b4578c5b380130a41a69b5b49c970157acaf1dbbDwight Engen <command>lxc-console</command>
b4578c5b380130a41a69b5b49c970157acaf1dbbDwight Engen <arg choice="req">-n <replaceable>name</replaceable></arg>
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen <arg choice="opt">-e <replaceable>escape character</replaceable></arg>
b4578c5b380130a41a69b5b49c970157acaf1dbbDwight Engen <arg choice="opt">-t <replaceable>ttynum</replaceable></arg>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </cmdsynopsis>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </refsynopsisdiv>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <refsect1>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <title>Description</title>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <para>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano If the tty service has been configured and is available for the
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano container specified as parameter, this command will launch a
be43f17e5863a532cfe1647dcd077a3712243d6bDaniel Lezcano console allowing to log on the container.
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </para>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <para>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano The available tty are free slots taken by this command. That
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano means if the container has four ttys available and the command
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen has been launched four times each taking a different tty, the
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen fifth command will fail because no console will be available.
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </para>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <para>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano The command will connect to a tty. If the connection is lost or
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano broken, the command can be launched again and regain the tty at
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano the state it was before the disconnection.
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </para>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b515981702133b9aaea1aff378493f054c14d46cDwight Engen <para>
b515981702133b9aaea1aff378493f054c14d46cDwight Engen A <replaceable>ttynum</replaceable> of 0 may be given to attach
b515981702133b9aaea1aff378493f054c14d46cDwight Engen to the container's /dev/console instead of its
b515981702133b9aaea1aff378493f054c14d46cDwight Engen dev/tty&lt;<replaceable>ttynum</replaceable>&gt;.
b515981702133b9aaea1aff378493f054c14d46cDwight Engen </para>
b515981702133b9aaea1aff378493f054c14d46cDwight Engen
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen <para>
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen A keyboard escape sequence may be used to disconnect from the tty
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen and quit lxc-console. The default escape sequence is &lt;Ctrl+a q&gt;.
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen </para>
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </refsect1>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <refsect1>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <title>Options</title>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <variablelist>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen <varlistentry>
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen <term>
1bc07a5b8dbaef4b6eb6d30a260e9c2153ed368bKATOH Yasufumi <option>-e, --escape <replaceable>escape character</replaceable></option>
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen </term>
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen <listitem>
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen <para>
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen Specify the escape sequence prefix to use instead of
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen &lt;Ctrl a&gt;.
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen This may be given as '^letter' or just 'letter'. For example
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen to use &lt;Ctrl+b q&gt; as the escape sequence use -e '^b'.
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen </para>
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen </listitem>
768487891f16c539954f871ef2e36ebd5556ccb2Dwight Engen </varlistentry>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <varlistentry>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <term>
1bc07a5b8dbaef4b6eb6d30a260e9c2153ed368bKATOH Yasufumi <option>-t, --tty <replaceable>ttynum</replaceable></option>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </term>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <listitem>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <para>
b515981702133b9aaea1aff378493f054c14d46cDwight Engen Specify the tty number to connect to or 0 for the console. If not
b515981702133b9aaea1aff378493f054c14d46cDwight Engen specified the next available tty number will be automatically
36b33520f67cd1a83be8031fccc3c2d7d7255e06Stéphane Graber chosen by the container.
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </para>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </listitem>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </varlistentry>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </variablelist>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </refsect1>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
10fba81b9d0221b8e47aa1e0b43236413b7d28dfMichel Normand &commonoptions;
10fba81b9d0221b8e47aa1e0b43236413b7d28dfMichel Normand
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <refsect1>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <title>Diagnostic</title>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <variablelist>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <varlistentry>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <term>tty service denied</term>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <listitem>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <para>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano No tty is available or there is not enough privilege to
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano use the console. For example, the container belongs to
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano user "foo" and "bar" is trying to open a console to it.
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </para>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </listitem>
f79d43bbe70a01454049b77d6f15f6369744959eStéphane Graber </varlistentry>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </variablelist>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </refsect1>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
99e4008cad9e959b683c6f48411fcf15a92be3b5Michel Normand &seealso;
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <refsect1>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <title>Author</title>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano </refsect1>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano</refentry>
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano<!-- Keep this comment at the end of the file
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanoLocal variables:
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanomode: sgml
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanosgml-omittag:t
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanosgml-shorttag:t
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanosgml-minimize-attributes:nil
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanosgml-always-quote-attributes:t
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanosgml-indent-step:2
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanosgml-indent-data:t
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanosgml-parent-document:nil
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanosgml-default-dtd-file:nil
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanosgml-exposed-tags:nil
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanosgml-local-catalogs:nil
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanosgml-local-ecat-files:nil
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcanoEnd:
b0a33c1eb65d2c87e886c740a0dadd8ad5f8d87ddlezcano-->