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