.\" $Id: console.man,v 8.11 2012/07/06 21:03:08 ksb Exp $ .\" $Compile: Display%h .\" $Display: ${groff:-groff} -tbl -Tascii -man %f |${PAGER:-less} .\" $Display(*): ${groff:-groff} -tbl -T%s -man %f .\" $Install: %b -mDeinstall %o %f && cp %f $DESTDIR/usr/local/man/man8/console.8 .\" $Deinstall: ${rm-rm} -f $DESTDIR/usr/local/man/[cm]a[nt][18]/console.8* .TH CONSOLE 8 LOCAL .SH NAME console - console server client program .SH SYNOPSIS .ds PN "console \fI\*(PN\fP [\fB\-a\fP|\fBA\fP | \fB\-f\fP|\fBF\fP | \fB\-s\fP|\fBS\fP] [\fB\-r\fP\fBv\fP] [\fB\-e\fP\~\fIattn\fP] [\fB\-M\fP\~\fImaster\fP] \fImachine\fP .br \fI\*(PN\fP \fB\-u\fP|\fBU\fP|\fBw\fP|\fBW\fP|\fBx\fP|\fBX\fP [\fB\-v\fP] [\fB\-M\fP\~\fImaster\fP] .br \fI\*(PN\fP \fB\-q\fP|\fBQ\fP [\fB\-v\fP] [\fB\-M\fP\~\fImaster\fP] .br \fI\*(PN\fP \fB\-d\fP|\fBD\fP|\fBp\fP|\fBP\fP [\fB\-v\fP] [\fB\-M\fP\~\fImaster\fP] .br \fI\*(PN\fP \fB\-Y\fP [\fB\-v\fP] .br \fI\*(PN\fP \fB\-h\fP .br \fI\*(PN\fP \fB\-V\fP .br .SH DESCRIPTION .PP .B Console is used to manipulate console terminals remotely or poll running \fBconserver\fP(8l) daemons for status information. .PP .B Console queries the user for an access password before granting interactive access to a console (on a non-trusted system) since such a session may provide single-user access. This password may be the superuser's password or a password installed for a limited number of devices. .PP Any default (\fB\-a\fP) connection is dropped to spy mode if someone else is attached read-write. Force this spy mode connection to read write with the ``f'' command below. .PP In the non-interactive mode .B console exits after it outputs the requested information. .SH OPTIONS .TP .B \-a Access a console with a two-way connection (this is the default). The uppercase variant (\fB\-A\fP) of this option forces a replay command into the negotiated connection after it is established. .TP .B \-d Display daemon versions. The \fI\*(PN\fP client connects to each server to request its version information. The uppercase variant (\fB\-D\fP) of this option only requests only 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 \fBcat\fP(1)'s \fB\-v\fP option are accepted. The default value is ``^Ec'' (control-e lowercase-c) read as ``escape conserver''. .TP .B \-f Same as .I \-a except it will force any existing read/write connection into spy mode. Uppercase (viz. \fB\-F\fP) forces a replay command. .TP .B \-h Display a brief help message. .TP .BI \-M master The \fI\*(PN\fP client program polls \fImaster\fP as the primary server, rather than the hard coded default (``console.example.com''). .TP .B \-p The \fI\*(PN\fP client program polls all each peer console servers for their process id. The uppercase variant (\fB\-P\fP) of this option only polls the \fImaster\fP console server. .TP .B \-q The \fI\*(PN\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 variant (\fB\-Q\fP) of this option just acts on the \fImaster\fP 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 non-interactive sequences. If you think this is something you might want to try you need to get out a little more. .TP .B \-s Requests a read-only (spy mode) connection. In this mode, all the escape sequences (below) work, or report errors, but all other keyboard input is discarded. Uppercase (viz. \fB\-S\fP) still forces a replay command. .TP .B \-u The \fI\*(PN\fP client program polls each console group for a list of connected users. Uppercase (viz. \fB\-U\fP) limits the scan to groups of the \fImaster\fP server. .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 \-w Show a list of all connections to all consoles. Uppercase (viz. \fB\-W\fP) limits the scan to groups of the \fImaster\fP server. .TP .B \-x Show a list of consoles and devices. Uppercase (viz. \fB\-X\fP) limits the scan to groups of the \fImaster\fP server. .TP .B \-Y Send a restart signal to the console server on the local host. This doesn't work across the network, as it reads the process id from the network but sends the signal with \fBkill\fP(2) locally. .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 ^P chat with the power controller ^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 serial line breaks, line down, and power controller commands 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 \fB\-u\fP output, the login \fB\fP indicates no one is viewing that console, the login \fB\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 expert up ksb@w01.dspd tyro up mentor up sage up fine@cis .TE .RE .sp The \fB\fP indicates no one is viewing \fIdumb\fP nor \fImentor\fP, the \fB\fP indicates only read-only connections exist for \fItyro\fP, and other \fIlogin\fP@\fIhost\fP entries are currently attached to \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 \fI\*(PN\fP from within a console connection. In root's .profile set $CONSOLE with: .RS CONSOLE="-- hey 'do not run console from here'" .RE .PP The \fB\-r\fP option doesn't really help to explain how connections get built. .SH AUTHORS Thomas A. Fine, Ohio State Computer Science. .br Kevin Braunsdorf, NonPlayer Character Guild.org .br console at ksb.npcguild.nospam.org .SH "SEE ALSO" .hlm 0 conserver.cf(5l), conserver(8l), autologin(8l), kill(2)