'\" -*- coding: UTF-8 -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH lxc-console 1 2023-02-19 "" ""
.SH NAME
lxc-console \- Launch a console for the specified container 
.SH SYNOPSIS
'nh
.fi
.ad l
\fBlxc-console\fR \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
{-n \fIname\fR} [-e \fIescape character\fR] [-t \fIttynum\fR]
'in \n(.iu-\nxu
.ad b
'hy
.SH DESCRIPTION
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.
.PP
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 each taking a different tty, the
fifth command will fail because no console will be available.
.PP
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.
.PP
A \fIttynum\fR of 0 may be given to attach
to the container's /dev/console instead of its
dev/tty<\fIttynum\fR>.
.PP
A keyboard escape sequence may be used to disconnect from the tty
and quit lxc-console. The default escape sequence is <Ctrl+a q>.
.SH OPTIONS
.TP 
\*(T<\fB\-e, \-\-escape \fR\*(T>\fIescape character\fR 
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'.
.TP 
\*(T<\fB\-t, \-\-tty \fR\*(T>\fIttynum\fR 
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.
.SH "COMMON OPTIONS"
These options are common to most of lxc commands.
.TP 
\*(T<\fB\-?, \-h, \-\-help\fR\*(T>
Print a longer usage message than normal.
.TP 
\*(T<\fB\-\-usage\fR\*(T>
Give the usage message
.TP 
\*(T<\fB\-q, \-\-quiet\fR\*(T>
mute on
.TP 
\*(T<\fB\-P, \-\-lxcpath=\fR\*(T>\fIPATH\fR
Use an alternate container path. The default is /var/lib/lxc.
.TP 
\*(T<\fB\-o, \-\-logfile=\fR\*(T>\fIFILE\fR
Output to an alternate log
\fIFILE\fR. The default is no log.
.TP 
\*(T<\fB\-l, \-\-logpriority=\fR\*(T>\fILEVEL\fR
Set log priority to
\fILEVEL\fR. The default log
priority is \*(T<ERROR\*(T>. Possible values are :
\*(T<FATAL\*(T>, \*(T<CRIT\*(T>,
\*(T<WARN\*(T>, \*(T<ERROR\*(T>,
\*(T<NOTICE\*(T>, \*(T<INFO\*(T>,
\*(T<DEBUG\*(T>.

Note that this option is setting the priority of the events
log in the alternate log file. It do not have effect on the
ERROR events log on stderr.
.TP 
\*(T<\fB\-n, \-\-name=\fR\*(T>\fINAME\fR
Use container identifier \fINAME\fR.
The container identifier format is an alphanumeric string.
.TP 
\*(T<\fB\-\-rcfile=\fR\*(T>\fIFILE\fR
Specify the configuration file to configure the virtualization
and isolation functionalities for the container.

This configuration file if present will be used even if there is
already a configuration file present in the previously created
container (via lxc-create).
.TP 
\*(T<\fB\-\-version\fR\*(T>
Show the version number.
.SH DIAGNOSTIC
.TP 
tty service denied
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.
.SH "SEE ALSO"
\fBlxc\fR(7),
\fBlxc-create\fR(1),
\fBlxc-copy\fR(1),
\fBlxc-destroy\fR(1),
\fBlxc-start\fR(1),
\fBlxc-stop\fR(1),
\fBlxc-execute\fR(1),
\fBlxc-console\fR(1),
\fBlxc-monitor\fR(1),
\fBlxc-wait\fR(1),
\fBlxc-cgroup\fR(1),
\fBlxc-ls\fR(1),
\fBlxc-info\fR(1),
\fBlxc-freeze\fR(1),
\fBlxc-unfreeze\fR(1),
\fBlxc-attach\fR(1),
\fBlxc.conf\fR(5)
.SH AUTHOR
Daniel Lezcano <\*(T<daniel.lezcano@free.fr\*(T>>