xref: /freebsd/usr.bin/tty/tty.1 (revision ef5d438ed4bc17ad7ece3e40fe4d1f9baf3aadf7)
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. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by the University of
18.\"	California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"	@(#)tty.1	8.1 (Berkeley) 6/6/93
36.\"
37.Dd June 6, 1993
38.Dt TTY 1
39.Os
40.Sh NAME
41.Nm tty
42.Nd return user's terminal name
43.Sh SYNOPSIS
44.Nm tty
45.Op Fl s
46.Sh DESCRIPTION
47The
48.Nm tty
49utility writes the name of the terminal attached to standard input
50to standard output.
51The name that is written is the string returned by
52.Xr ttyname 3 .
53If the standard input is not a terminal, the message ``not a tty''
54is written.
55The options are as follows:
56.Bl -tag -width Ds
57.It Fl s
58Don't write the terminal name; only the exit status is affected
59when this option is specified.
60The
61.Fl s
62option is deprecated in favor of the
63.Dq Li "test -t 0"
64command.
65.El
66.Pp
67.Nm Tty
68exits 0 if the standard input is a terminal, 1 if the standard input is
69not a terminal, and >1 if an error occurs.
70.Sh SEE ALSO
71.Xr test 1 ,
72.Xr ttyname 3
73.Sh STANDARDS
74The
75.Nm tty
76function is expected to be
77.St -p1003.2
78compatible.
79