xref: /freebsd/usr.bin/tty/tty.1 (revision 61ba55bcf70f2340f9c943c9571113b3fd8eda69)
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.\"	@(#)tty.1	8.1 (Berkeley) 6/6/93
32.\"
33.Dd June 6, 1993
34.Dt TTY 1
35.Os
36.Sh NAME
37.Nm tty
38.Nd return user's terminal name
39.Sh SYNOPSIS
40.Nm
41.Op Fl s
42.Sh DESCRIPTION
43The
44.Nm
45utility writes the name of the terminal attached to standard input
46to standard output.
47The name that is written is the string returned by
48.Xr ttyname 3 .
49If the standard input is not a terminal, the message
50.Dq Li "not a tty"
51is written.
52The options are as follows:
53.Bl -tag -width indent
54.It Fl s
55Do not write the terminal name; only the exit status is affected
56when this option is specified.
57The
58.Fl s
59option is deprecated in favor of the
60.Dq Li "test -t 0"
61command.
62.El
63.Sh EXIT STATUS
64The
65.Nm
66utility
67exits 0 if the standard input is a terminal, 1 if the standard input is
68not a terminal, and >1 if an error occurs.
69.Sh SEE ALSO
70.Xr test 1 ,
71.Xr ttyname 3
72.Sh STANDARDS
73The
74.Nm
75utility is expected to be
76.St -p1003.2
77compatible.
78.Sh HISTORY
79A
80.Nm
81command appeared in
82.At v1 .
83