xref: /freebsd/usr.bin/tty/tty.1 (revision d37eb51047221dc3322b34db1038ff3aa533883f)
1.\" Copyright (c) 1990, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" the Institute of Electrical and Electronics Engineers, Inc.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. Neither the name of the University nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.Dd June 6, 1993
32.Dt TTY 1
33.Os
34.Sh NAME
35.Nm tty
36.Nd return user's terminal name
37.Sh SYNOPSIS
38.Nm
39.Op Fl s
40.Sh DESCRIPTION
41The
42.Nm
43utility writes the name of the terminal attached to standard input
44to standard output.
45The name that is written is the string returned by
46.Xr ttyname 3 .
47If the standard input is not a terminal, the message
48.Dq Li "not a tty"
49is written.
50The options are as follows:
51.Bl -tag -width indent
52.It Fl s
53Do not write the terminal name; only the exit status is affected
54when this option is specified.
55The
56.Fl s
57option is deprecated in favor of the
58.Dq Li "test -t 0"
59command.
60.El
61.Sh EXIT STATUS
62The
63.Nm
64utility
65exits 0 if the standard input is a terminal, 1 if the standard input is
66not a terminal, and >1 if an error occurs.
67.Sh SEE ALSO
68.Xr test 1 ,
69.Xr ttyname 3
70.Sh STANDARDS
71The
72.Nm
73utility is expected to be
74.St -p1003.2
75compatible.
76.Sh HISTORY
77A
78.Nm
79command appeared in
80.At v1 .
81