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