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 <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
  26 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
  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 <replaceable>-n name</replaceable>
  52         <optional>-t ttynum</optional>
  53       </command>
  54     </cmdsynopsis>
  55   </refsynopsisdiv>
  56
  57   <refsect1>
  58     <title>Description</title>
  59
  60     <para>
  61       If the tty service has been configured and is available for the
  62       container specified as parameter, this command will launch a
  63       console allowing to log on the container.
  64     </para>
  65
  66     <para>
  67       The available tty are free slots taken by this command. That
  68       means if the container has four ttys available and the command
  69       has been launched four times taking the different tty, the fifth
  70       command will fail because no console will be available.
  71     </para>
  72
  73     <para>
  74       The command will connect to a tty. If the connection is lost or
  75       broken, the command can be launched again and regain the tty at
  76       the state it was before the disconnection.
  77     </para>
  78
  79   </refsect1>
  80
  81   <refsect1>
  82     <title>Options</title>
  83     <variablelist>
  84
  85       <varlistentry>
  86         <term>
  87           <option>-t <optional>ttynum</optional></option>
  88         </term>
  89         <listitem>
  90           <para>
  91             Specify the tty number to connect, if not specified a tty
  92             number will be automatically choosen by the container.
  93           </para>
  94         </listitem>
  95       </varlistentry>
  96
  97     </variablelist>
  98
  99   </refsect1>
 100
 101   &commonoptions;
 102
 103   <refsect1>
 104     <title>Diagnostic</title>
 105
 106     <variablelist>
 107
 108       <varlistentry>
 109         <term>tty service denied</term>
 110         <listitem>
 111           <para>
 112             No tty is available or there is not enough privilege to
 113             use the console. For example, the container belongs to
 114             user "foo" and "bar" is trying to open a console to it.
 115           </para>
 116         </listitem>
 117       </varlistentry>
 118
 119     </variablelist>
 120
 121   </refsect1>
 122
 123   &seealso;
 124
 125   <refsect1>
 126     <title>Author</title>
 127     <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 128   </refsect1>
 129
 130 </refentry>
 131
 132 <!-- Keep this comment at the end of the file
 133 Local variables:
 134 mode: sgml
 135 sgml-omittag:t
 136 sgml-shorttag:t
 137 sgml-minimize-attributes:nil
 138 sgml-always-quote-attributes:t
 139 sgml-indent-step:2
 140 sgml-indent-data:t
 141 sgml-parent-document:nil
 142 sgml-default-dtd-file:nil
 143 sgml-exposed-tags:nil
 144 sgml-local-catalogs:nil
 145 sgml-local-ecat-files:nil
 146 End:
 147 -->