conserver/console/console.man

.\" $Id: console.man,v 5.0 92/01/13 14:44:36 ksb Exp $
.TH CONSOLE 8L "Local"
.SH NAME
console \- console server client program
.SH SYNOPSIS
\fBconsole\fP [\-\fBrv\fP] [\-\fBAFSafs\fP] [\-\fBe\fP \fIesc\fP] [\-\fBM\fP \fIserver\fP] \fIhost\fP
.br
\fBconsole\fP [\-\fBdDqQ\fP] [\-\fBv\fP] [\-\fBM\fP \fIserver\fP] \fIhost\fP
.br
\fBconsole\fP [\-\fBv\fP] [\-\fBhuVwx\fP]
.SH DESCRIPTION
.B Console
is used to manipulate console terminals remotely or poll running
\fIconserver\fP(8L) daemons for status information.
.PP
.B Console
queries the user for the root passwd before
granting interactive access to a console (on a non-trusted system)
since such a session may provide single-user access.
.PP
In the non-interactive mode
.B console
outputs only the requested information.
.SH OPTIONS
.TP
.B \-a
Access a console with a two-way connection (this is the default).
.TP
.B \-d
Display daemon versions.  The \fIconsole\fP client connects to each
server to request its version information.  The uppercase varient of
this option only requests the primary server's version.
.TP
.BI \-e esc
Set the initial two character escape sequence to
those represented by \fIesc\fP.
Any of the forms output by \fIcat\fP(1)'s \-\fBv\fP option
are accepted.  The default value is ``^Ec''.
.TP
.B \-f
Same as
.I \-a
except it will force any existing connection into spy mode.
.TP
.B \-h
Display a brief help message.
.TP
.BI \-M server
The \fIconsole\fP client program polls \fIserver\fP as the primary server,
rather than the hard coded default (``console.cc.purdue.edu'').
.TP
.B \-q
The \fIconsole\fP client requests the server daemon quit (shutdown).
A password is sent in the protocol stream, if none is required for
the local host to shutdown the server just press return.  The uppercase
varient of this command just acts on the primary server.
.TP
.B \-r
Request a raw connection to the group control virtual console,
this is only useful for learning the protocol used by the
interactive sequence.
.TP
.B \-s
Requests a read-only (spy mode) connection.
If this mode all the escape sequences (below) work, or report errors,
but all other keyboard input is discarded.
.TP
.B \-V
Output the version of the console client program.
.TP
.B \-v
Be more verbose during when building the connection(s).
Use this option in combination with any of `show' options (below)
for added benefit.
.TP
.B \-u
Show a list of consoles and the users on each.
.TP
.B \-w
Show a list of all connections to all consoles.
.TP
.B \-x
Show a list of consoles and devices.
.PP
The \-\fBA\fP, \-\fBF\fP, or \-\fBS\fP options have the same effect as
their lower case variants.
In addition they each request the last 20 lines of the console output after
making the connection.
.PP
Any default (\-\fBa\fP) connection is dropped to spy mode if
someone else is attached read-write.
.SH "ESCAPE SEQUENCES"
The connection can be controlled by a two character escape sequence, followed
by a command.  The default escape sequence is ``control-E c''
(octal 005 143).  Commands are:
.sp
.TS
c l.
a	switch to attach mode
c	toggle flow control (don't do this)
d	down the current console
e	change the escape sequence to the next two characters
f	force a switch to attach mode
l1	send a 3 second serial line break (might halt a Sun)
o	reopen the line to clear errors (silo overflows)
r	replay the last 20 lines of output
s	switch to spy mode
u	show other users on this port
v	show the version of the group server
w	who is using this console
x	examine this group's devices and modes.
z	suspend this connection
?	display list of commands
^I	toggle tab expansion
^J	continue, ignore the escape sequence
^R	replay the last line only
\.	disconnect
;	provide a new login or shift to a new console
+(-)	be more (less) free with newlines
.TE
.sp
.PP
If any other character is hit after the escape sequence, all three characters
will be discarded.
Note that a line break or a down command
can only be sent from a full two-way attachment.
To send the escape sequence through the connection one must redefine
the outer escape sequence.
.PP
In the \-u output, the login \fB<none>\fP indicates no one is
viewing that console, the login \fB<spies>\fP indicates that
no one has a full two-way attachment.  When no one is attached to
a console its output is cloned to the stdout of the server process.
.SH EXAMPLES
.TP
console \-u
Outputs something like:
.sp
.RS
.TS
l18 l l.
dumb	up	<none>
expert	up	ksb@mentor
tyro	up	<spies>
mentor	up	<none>
sage	up	fine@cis
.TE
.RE
.sp
The \fB<none>\fP indicates no one is viewing \fIdumb\fP or \fImentor\fP,
the \fB<spies>\fP indicates only read-only connections exist for \fItyro\fP,
other \fIlogin\fP@\fIhost\fP entries are the currently attached
\fIsage\fP and \fIexpert\fP.
.TP
console \-w
Outputs something like:
.sp
.RS
.TS
l l l.
ksb@extra	on expert	Fri Feb 15 16:40:36 1991
file@cis	on sage	Thu Feb 14  1:04:10 1991
dmr@alice	spy tyro	Thu Feb  7 10:09:59 1991
.TE
.RE
.sp
.TP
console \-e \*(lq^[1\*(rq lv426
Requests a connection to the host ``lv426'' with the escape characters
set to ``escape one''.
.SH BUGS
Connections suspended under Dynix sometimes break the kernel when
resumed.  Suspended connections are a poor idea in general, just
disconnect instead.
.PP
It is possible to create a loop of console connections, with ugly results.
Never run \fIconsole\fP from within a console connection.
.PP
The \-\fBr\fP option doesn't help to explain how connections get built.
.SH AUTHORS
Thomas A. Fine, Ohio State Computer Science.
.br
Kevin Braunsdorf, Purdue University Computing Center
.SH "SEE ALSO"
conserver.cf(5L), conserver(8L)