share/man/man1/tty.1

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1989 AT&T
  44 .\" Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved.
  45 .\" Copyright (c) 2009, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH TTY 1 "Aug 11, 2009"
  48 .SH NAME
  49 tty \- return user's terminal name
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 \fB/usr/bin/tty\fR [\fB-l\fR] [\fB-s\fR]
  54 .fi
  55
  56 .SS "ksh93"
  57 .LP
  58 .nf
  59 \fBtty\fR [ \fIoptions\fR ]
  60 .fi
  61
  62 .SH DESCRIPTION
  63 .SS "/usr/bin/tty"
  64 .sp
  65 .LP
  66 The \fBtty\fR utility writes to the standard output the name of the terminal
  67 that is open as standard input. The name that is used is equivalent to the
  68 string that would be returned by the \fBttyname\fR(3C) function.
  69 .SS "ksh93"
  70 .sp
  71 .LP
  72 The \fBksh93\fR \fBtty\fR built-in writes the name of the terminal that is
  73 connected to standard input onto standard output. If the standard input is not
  74 a terminal, "not a tty" will be written to standard output.
  75 .SH OPTIONS
  76 .sp
  77 .LP
  78 The following options are supported:
  79 .SS "/usr/bin/tty"
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fB-l\fR\fR
  84 .ad
  85 .RS 6n
  86 Prints the synchronous line number to which the user's terminal is connected,
  87 if it is on an active synchronous line.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fB-s\fR\fR
  94 .ad
  95 .RS 6n
  96 Inhibits printing of the terminal path name, allowing one to test just the exit
  97 status.
  98 .RE
  99
 100 .SS "ksh93"
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fB-l\fR\fR
 105 .ad
 106 .br
 107 .na
 108 \fB\fB--line-number\fR\fR
 109 .ad
 110 .RS 18n
 111 Write the synchronous line number of the terminal on a separate line following
 112 the terminal name line.  If the standard input is not a synchronous terminal
 113 then "not on an active synchronous line" is written.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fB-s\fR\fR
 120 .ad
 121 .br
 122 .na
 123 \fB\fB--silent\fR|\fBquiet\fR\fR
 124 .ad
 125 .RS 18n
 126 Disable the terminal name line. Portable applications should use [[ -t 0 ]]
 127 instead.
 128 .RE
 129
 130 .SH ENVIRONMENT VARIABLES
 131 .sp
 132 .LP
 133 See \fBenviron\fR(5) for descriptions of the following environment variables
 134 that affect the execution of  \fBtty\fR: \fBLANG\fR, \fBLC_ALL\fR,
 135 \fBLC_CTYPE\fR,  \fBLC_MESSAGES\fR,  and \fBNLSPATH\fR.
 136 .SH EXIT STATUS
 137 .sp
 138 .LP
 139 The following exit values are returned:
 140 .sp
 141 .ne 2
 142 .na
 143 \fB\fB0\fR\fR
 144 .ad
 145 .RS 6n
 146 Standard input is a terminal.
 147 .RE
 148
 149 .sp
 150 .ne 2
 151 .na
 152 \fB\fB1\fR\fR
 153 .ad
 154 .RS 6n
 155 Standard input is not a terminal.
 156 .RE
 157
 158 .sp
 159 .ne 2
 160 .na
 161 \fB\fB>1\fR\fR
 162 .ad
 163 .RS 6n
 164 An error occurred.
 165 .RE
 166
 167 .SH ATTRIBUTES
 168 .sp
 169 .LP
 170 See \fBattributes\fR(5) for descriptions of the following attributes:
 171 .sp
 172
 173 .sp
 174 .TS
 175 box;
 176 c | c
 177 l | l .
 178 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 179 _
 180 CSI     Enabled
 181 _
 182 Interface Stability     Committed
 183 _
 184 Standard        \fBstandards\fR(5).
 185 .TE
 186
 187 .SH SEE ALSO
 188 .sp
 189 .LP
 190 \fBisatty\fR(3C), \fBttyname\fR(3C), \fBattributes\fR(5), \fBenviron\fR(5),
 191 \fBstandards\fR(5)
 192 .SH DIAGNOSTICS
 193 .sp
 194 .ne 2
 195 .na
 196 \fB\fBnot on an active synchronous line\fR\fR
 197 .ad
 198 .sp .6
 199 .RS 4n
 200 The standard input is not a synchronous terminal and \fB-l\fR is specified.
 201 .RE
 202
 203 .sp
 204 .ne 2
 205 .na
 206 \fB\fBnot a tty\fR\fR
 207 .ad
 208 .sp .6
 209 .RS 4n
 210 The standard input is not a terminal and \fB-s\fR is not specified.
 211 .RE
 212
 213 .SH NOTES
 214 .sp
 215 .LP
 216 The \fB-s\fR option is useful only if the exit status is wanted. It does not
 217 rely on the ability to form a valid path name. Portable applications should use
 218 \fBtest\fR \fB-t\fR.