share/man/man8/ttyadm.8

   1 '\" te
   2 .\" Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH TTYADM 8 "Sep 14, 1992"
   8 .SH NAME
   9 ttyadm \- format and output port monitor-specific information
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/usr/sbin/ttyadm\fR [\fB-b\fR] [\fB-c\fR] [\fB-h\fR] [\fB-I\fR] [\fB-r\fR \fIcount\fR] [\fB-i\fR \fImsg\fR]
  14      [\fB-m\fR \fImodules\fR] [\fB-p\fR \fIprompt\fR] [\fB-t\fR \fItimeout\fR] [\fB-S\fR y | n]
  15      [\fB-T\fR \fItermtype\fR] \fB-d\fR \fIdevice\fR \fB-l\fR \fIttylabel\fR \fB-s\fR \fIservice\fR
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fB/usr/sbin/ttyadm\fR \fB-V\fR
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBttyadm\fR command is an administrative command that formats
  27 \fBttymon\fR(8)-specific information and writes it to standard output. The
  28 Service Access Facility (SAF) requires each port monitor to provide such a
  29 command. Note that the port monitor administrative file is updated by the
  30 Service Access Controller's administrative commands, \fBsacadm\fR(8) and
  31 \fBpmadm\fR(8). \fBttyadm\fR provides a means of presenting formatted port
  32 monitor-specific (\fBttymon\fR-specific) data to these commands.
  33 .SH OPTIONS
  34 .sp
  35 .LP
  36 The following options are supported:
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fB-b\fR\fR
  41 .ad
  42 .RS 15n
  43 Set the ``bi-directional port'' flag. When this flag is set, the line can be
  44 used in both directions. \fBttymon\fR will allow users to connect to the
  45 service associated with the port.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fB-c\fR\fR
  52 .ad
  53 .RS 15n
  54 Set the connect-on-carrier flag for the port. If the \fB-c\fR flag is set,
  55 \fBttymon\fR will invoke the port's associated service immediately when a
  56 connect indication is received (that is, no prompt is printed and no baud-rate
  57 searching is done).
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fB-d\fR\fI device\fR\fR
  64 .ad
  65 .RS 15n
  66 \fIdevice\fR is the full pathname of the device file for the TTY port.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fB-h\fR\fR
  73 .ad
  74 .RS 15n
  75 Set the hangup flag for the port. If the \fB-h\fR flag is not set, \fBttymon\fR
  76 will force a hangup on the line by setting the speed to \fB0\fR before setting
  77 the speed to the default or specified value.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fB-i\fR\fI message\fR\fR
  84 .ad
  85 .RS 15n
  86 Specify the inactive (disabled) response message. This message will be sent to
  87 the TTY port if the port is disabled or the \fBttymon\fR monitoring the port is
  88 disabled.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fB-I\fR\fR
  95 .ad
  96 .RS 15n
  97 Initialize only.  If the \fB-I\fR option is used, \fBttymon\fR will invoke the
  98 service only once.  This can be used to configure a particular device without
  99 actually monitoring it, as with software carrier.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fB-l\fR\fI ttylabel\fR\fR
 106 .ad
 107 .RS 15n
 108 Specify which \fIttylabel\fR in the \fB/etc/ttydefs\fR file to use as the
 109 starting point when searching for the proper baud rate.
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fB-m\fR\fI modules\fR\fR
 116 .ad
 117 .RS 15n
 118 Specify a list of pushable STREAMS modules. The modules will be pushed in the
 119 order in which they are specified before the service is invoked. \fImodules\fR
 120 must be a comma-separated list of modules, with no white space included. Any
 121 modules currently on the stream will be popped before these  modules are
 122 pushed.
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fB-p\fR\fI prompt\fR\fR
 129 .ad
 130 .RS 15n
 131 Specify the prompt message, for example, ``\fBlogin:\fR''.
 132 .RE
 133
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fB-r\fR\fI count\fR\fR
 138 .ad
 139 .RS 15n
 140 When the \fB-r\fR option is invoked, \fBttymon\fR will wait until it receives
 141 data from the port before it displays a prompt. If \fIcount\fR is \fB0\fR,
 142 \fBttymon\fR will wait until it receives any character. If \fIcount\fR is
 143 greater than \fB0\fR, \fBttymon\fR will wait until \fIcount\fR newlines have
 144 been received.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fB-s\fR\fI service\fR\fR
 151 .ad
 152 .RS 15n
 153 \fIservice\fR is the full pathname of the service to be invoked when a
 154 connection request is received. If arguments are required, the command and its
 155 arguments must be enclosed in double quotes (" ").
 156 .RE
 157
 158 .sp
 159 .ne 2
 160 .na
 161 \fB\fB-S\fR \fBy|n\fR\fR
 162 .ad
 163 .RS 15n
 164 Set the software carrier value.  \fBy\fR will turn software carrier on. \fBn\fR
 165 will turn software carrier off.
 166 .RE
 167
 168 .sp
 169 .ne 2
 170 .na
 171 \fB\fB-t\fR\fI timeout\fR\fR
 172 .ad
 173 .RS 15n
 174 Specify that \fBttymon\fR should close a port if the open on the port succeeds,
 175 and no input data is received in \fItimeout\fR seconds.
 176 .RE
 177
 178 .sp
 179 .ne 2
 180 .na
 181 \fB\fB-T\fR\fI termtype\fR\fR
 182 .ad
 183 .RS 15n
 184 Set the terminal type.  The \fBTERM\fR environment variable will be set to
 185 \fItermtype\fR.
 186 .RE
 187
 188 .sp
 189 .ne 2
 190 .na
 191 \fB\fB-V\fR\fR
 192 .ad
 193 .RS 15n
 194 Display the version number of the current \fB/usr/lib/saf/ttymon\fR command.
 195 .RE
 196
 197 .SH OUTPUT
 198 .sp
 199 .LP
 200 If successful, \fBttyadm\fR will generate the requested information, write it
 201 to  standard output, and exit with a status of \fB0\fR. If \fBttyadm\fR is
 202 invoked with an invalid number of arguments or invalid arguments, or if an
 203 incomplete option is specified, an error message will be written to standard
 204 error and \fBttymon\fR will exit with a non-zero status.
 205 .SH FILES
 206 .sp
 207 .ne 2
 208 .na
 209 \fB\fB/etc/ttydefs\fR\fR
 210 .ad
 211 .RS 16n
 212
 213 .RE
 214
 215 .SH SEE ALSO
 216 .sp
 217 .LP
 218 \fBpmadm\fR(8), \fBsacadm\fR(8), \fBttymon\fR(8), \fBattributes\fR(5)
 219 .sp
 220 .LP
 221 \fI\fR