usr/src/man/man1/tty.1

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