doc/lxc-console.sgml.in

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