components/shell/pconsole/files/pconsole.1

   1 '\" te
   2 .\" CDDL HEADER START
   3 .\"
   4 .\" The contents of this file are subject to the terms of the
   5 .\" Common Development and Distribution License (the "License").
   6 .\" You may not use this file except in compliance with the License.
   7 .\"
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9 .\" or http://www.opensolaris.org/os/licensing.
  10 .\" See the License for the specific language governing permissions
  11 .\" and limitations under the License.
  12 .\"
  13 .\" When distributing Covered Code, include this CDDL HEADER in each
  14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15 .\" If applicable, add the following below this CDDL HEADER, with the
  16 .\" fields enclosed by brackets "[]" replaced with your own identifying
  17 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  18 .\"
  19 .\" CDDL HEADER END
  20 .\" Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved
  21 .TH pconsole 1 "24 Sep 2008" "SunOS 5.11" "User Commands"
  22 .SH NAME
  23 pconsole \- parallel console
  24 .SH SYNOPSIS
  25 .LP
  26 .nf
  27 \fBpconsole\fR \fIhost[:port] [...]\fR
  28
  29 .fi
  30
  31 .SH DESCRIPTION
  32 .sp
  33 .LP
  34 The \fppconsole\fR utility creates a host terminal window for each remote
  35 host that you specify on the command line. The utility also opens a central,
  36 or master, console window that propagates what you input there to each of the
  37 connections that you open.
  38
  39 The \fppconsole\fR utility is best run from within X Windows, although it is
  40 possible to employ it without X (in console mode) as well.
  41
  42 You only need to install pconsole on one machine in the cluster. This machine
  43 would usually be your central administrative node.
  44
  45 If you have a serial-port multiplexer that allows you to connect to
  46 specific port numbers on the IP address of the multiplexer,
  47 you can specify the port number in addition to the hostname or IP
  48 address as \fImuxIP\fR:\fIportnumber\fR.
  49
  50 .TP
  51 NOTE:
  52 This program must be either run as root or by a user granted
  53 the "Parallel Console Access" rights profile:
  54 .PP
  55 .RS
  56 .nf
  57 \fB# usermod -P "Parallel Console Access" login-name\fR
  58 .fi
  59
  60 .SH COMMANDS
  61 \fppconsole\fR supports the following commands in the central console
  62 window:
  63 .IP "? or help"
  64 Prints a list of available commands.
  65 .IP "Ctrl-A"
  66 Enters command mode.
  67 .IP "attach"
  68 Attaches to a tty device.
  69 .IP "connect"
  70 Leaves command mode.
  71 .IP "detach"
  72 Detaches from a tty device.
  73 .IP "echo"
  74 Turns echo on or off.
  75 .IP "exit"
  76 Exits \fppconsole\fR. This is the same as quit.
  77 .IP "list"
  78 Shows devices currently attached to.
  79 .IP "quit"
  80 Exits \fppconsole\fR. This is the same as exit.
  81 .IP "version"
  82 Displays version information.
  83
  84 .SH EXIT STATUS
  85 .sp
  86 .LP
  87 The following exit values are returned:
  88 .sp
  89 .ne 2
  90 .mk
  91 .na
  92 \fB\fB0\fR\fR
  93 .ad
  94 .RS 6n
  95 .rt
  96 Successful completion.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .mk
 102 .na
 103 \fB\fB1\fR\fR
 104 .ad
 105 .RS 6n
 106 .rt
 107 An error occurred.
 108 .RE
 109
 110 .SH ENVIRONMENT VARIABLES
 111 .sp
 112 .ne 2
 113 .mk
 114 .na
 115 \fB\fBP_TERM\fR\fR
 116 .ad
 117 .RS 16n
 118 .rt
 119 By default, \fBpconsole\fR uses \fBxterm\fR(1) to create a window to the
 120 remote system.
 121 You can specify another command by setting the environment
 122 variable \fBP_TERM\fR to the chosen command.
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .mk
 128 .na
 129 \fB\fBP_TERM_OPTIONS\fR\fR
 130 .ad
 131 .RS 16n
 132 .rt
 133 By default, \fBpconsole\fR uses the options "-geometry 80x24 -fn 10x20"
 134 to pass to the command that is specified by \fBP_TERM\fR, or to \fBxterm\fR(1)
 135 if \fBP_TERM\fR is unspecified.
 136 You can specify different options by setting the environment
 137 variable \fBP_TERM_OPTIONS\fR to the chosen options.
 138 .RE
 139
 140 .sp
 141 .ne 2
 142 .mk
 143 .na
 144 \fB\fBP_CONNECT_CMD\fR\fR
 145 .ad
 146 .RS 16n
 147 .rt
 148 By default, \fBpconsole\fR uses \fBssh\fR(1) to make connections.
 149 You can use a different command, such as \fBrlogin\fR(1), by setting the environment
 150 variable \fBP_CONNECT_CMD\fR to the chosen command.
 151 .RE
 152
 153 .SH SEE ALSO
 154 .sp
 155 .LP
 156 \fBrlogin\fR(1), \fBssh\fR(1), \fBxterm\fR(1)