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