xref: /illumos-gate/usr/src/man/man1/tty.1 (revision dd72704bd9e794056c558153663c739e2012d721)

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/.

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 are reprinted and reproduced in electronic form
in the SunOS 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 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.

This notice shall appear on any product containing this material.

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.
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 the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright 1989 AT&T
Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved.
Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.

TTY 1 "Aug 11, 2009"
NAME
tty - return user's terminal name
SYNOPSIS

/usr/bin/tty [-l] [-s]
"ksh93"

tty [ options ]
DESCRIPTION
"/usr/bin/tty"

The tty utility writes to the standard output the name of the terminal that is open as standard input. The name that is used is equivalent to the string that would be returned by the ttyname(3C) function.

"ksh93"

The ksh93 tty built-in writes the name of the terminal that is connected to standard input onto standard output. If the standard input is not a terminal, "not a tty" will be written to standard output.

OPTIONS

The following options are supported:

"/usr/bin/tty"
-l

Prints the synchronous line number to which the user's terminal is connected, if it is on an active synchronous line.

-s

Inhibits printing of the terminal path name, allowing one to test just the exit status.

"ksh93"
-l

--line-number

Write the synchronous line number of the terminal on a separate line following the terminal name line. If the standard input is not a synchronous terminal then "not on an active synchronous line" is written.

-s

--silent|quiet

Disable the terminal name line. Portable applications should use [[ -t 0 ]] instead.

ENVIRONMENT VARIABLES

See environ(7) for descriptions of the following environment variables that affect the execution of tty: LANG, LC_ALL, LC_CTYPE, LC_MESSAGES, and NLSPATH.

EXIT STATUS

The following exit values are returned: 0

Standard input is a terminal.

1

Standard input is not a terminal.

>1

An error occurred.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
CSI Enabled
Interface Stability Committed
Standard standards(7).
SEE ALSO

isatty (3C), ttyname (3C), attributes (7), environ (7), standards (7)

DIAGNOSTICS
not on an active synchronous line

The standard input is not a synchronous terminal and -l is specified.

not a tty

The standard input is not a terminal and -s is not specified.

NOTES

The -s option is useful only if the exit status is wanted. It does not rely on the ability to form a valid path name. Portable applications should use test -t.