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