[unix-history] / .ref-BSD-4_3_Net_2 / usr / src / lib / libc / gen / ttyname.3

.\" Copyright (c) 1991 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)ttyname.3	6.2 (Berkeley) 4/19/91
.\"
.Dd April 19, 1991
.Dt TTYNAME 3
.Os
.Sh NAME
.Nm ttyname ,
.Nm isatty ,
.Nm ttyslot
.Nd get name of associated terminal (tty) from file descriptor
.Sh SYNOPSIS
.Fd #include <unistd.h>
.Ft char *
.Fn ttyname "int fd"
.Ft int
.Fn isatty "int fd"
.Ft int
.Fn ttyslot 
.Sh DESCRIPTION
These functions operate on the system file descriptors for terminal
type devices. These descriptors are not related to the standard
.Tn I/O
.Dv FILE
typedef, but refer to the special device files found in
.Pa /dev
and named
.Pa /dev/tty Ns Em xx
and for which an entry exists
in the initialization file
.Pa /etc/ttys.
(See
.Xr ttys 5 . )
.Pp
The
.Fn isatty
function
determines if the file descriptor
.Fa fd
refers to a valid
terminal type device.
.Pp
The
.Fn ttyname
function
gets the related device name of
a file descriptor for which
.Fn isatty
is true
.Pp
The
.Fn ttyslot
function
fetches the current process' control terminal number from the
.Xr ttys 5
file entry.
.Sh RETURN VALUES
The
.Fn ttyname
function
returns the null terminated name if the device is found and
.Fn isatty
is true; otherwise 
a
.Dv NULL
pointer is returned.
.Pp
The
.Fn ttyslot
function
returns the unit number of the device file if found; otherwise
the value zero is returned.
.Sh FILES
.Bl -tag -width /etc/ttys -compact
.It Pa /dev/\(**
.It Pa /etc/ttys
.El
.Sh SEE ALSO
.Xr ioctl 2 ,
.Xr ttys 5
.Sh HISTORY
A
.Fn isatty ,
.Fn ttyname ,
and
.Fn ttyslot
function
appeared in
.At v7 .
.Sh BUGS
The
.Fn ttyname
function leaves its result in an internal static object and returns
a pointer to that object. Subsequent calls to
.Fn ttyname
will modify the same object.
Commit	Line	Data
af359dea C	1	.\" Copyright (c) 1991 The Regents of the University of California.
af359dea C	2	.\" All rights reserved.
2264871c	3	.\"
af359dea C	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice, this list of conditions and the following disclaimer.
	9	.\" 2. Redistributions in binary form must reproduce the above copyright
	10	.\" notice, this list of conditions and the following disclaimer in the
	11	.\" documentation and/or other materials provided with the distribution.
	12	.\" 3. All advertising materials mentioning features or use of this software
	13	.\" must display the following acknowledgement:
	14	.\" This product includes software developed by the University of
	15	.\" California, Berkeley and its contributors.
	16	.\" 4. Neither the name of the University nor the names of its contributors
	17	.\" may be used to endorse or promote products derived from this software
	18	.\" without specific prior written permission.
	19	.\"
	20	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	21	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	22	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	23	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	24	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	25	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	26	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	27	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	28	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	29	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	30	.\" SUCH DAMAGE.
	31	.\"
	32	.\" @(#)ttyname.3 6.2 (Berkeley) 4/19/91
	33	.\"
	34	.Dd April 19, 1991
	35	.Dt TTYNAME 3
	36	.Os
	37	.Sh NAME
	38	.Nm ttyname ,
	39	.Nm isatty ,
	40	.Nm ttyslot
	41	.Nd get name of associated terminal (tty) from file descriptor
	42	.Sh SYNOPSIS
	43	.Fd #include <unistd.h>
	44	.Ft char *
	45	.Fn ttyname "int fd"
	46	.Ft int
	47	.Fn isatty "int fd"
	48	.Ft int
	49	.Fn ttyslot
	50	.Sh DESCRIPTION
	51	These functions operate on the system file descriptors for terminal
	52	type devices. These descriptors are not related to the standard
	53	.Tn I/O
	54	.Dv FILE
	55	typedef, but refer to the special device files found in
	56	.Pa /dev
	57	and named
	58	.Pa /dev/tty Ns Em xx
	59	and for which an entry exists
	60	in the initialization file
	61	.Pa /etc/ttys.
	62	(See
	63	.Xr ttys 5 . )
	64	.Pp
	65	The
	66	.Fn isatty
	67	function
68	determines if the file descriptor
69	.Fa fd
70	refers to a valid
71	terminal type device.
72	.Pp
73	The
74	.Fn ttyname
75	function
76	gets the related device name of
77	a file descriptor for which
78	.Fn isatty
79	is true
80	.Pp
81	The
82	.Fn ttyslot
83	function
84	fetches the current process' control terminal number from the
85	.Xr ttys 5
86	file entry.
87	.Sh RETURN VALUES
88	The
89	.Fn ttyname
90	function
91	returns the null terminated name if the device is found and
92	.Fn isatty
93	is true; otherwise
94	a
95	.Dv NULL
96	pointer is returned.
97	.Pp
98	The
99	.Fn ttyslot
100	function
101	returns the unit number of the device file if found; otherwise
102	the value zero is returned.
103	.Sh FILES
104	.Bl -tag -width /etc/ttys -compact
105	.It Pa /dev/\(**
106	.It Pa /etc/ttys
107	.El
108	.Sh SEE ALSO
109	.Xr ioctl 2 ,
110	.Xr ttys 5
111	.Sh HISTORY
112	A
113	.Fn isatty ,
114	.Fn ttyname ,
115	and
116	.Fn ttyslot
117	function
118	appeared in
119	.At v7 .
120	.Sh BUGS
121	The
122	.Fn ttyname
123	function leaves its result in an internal static object and returns
124	a pointer to that object. Subsequent calls to
125	.Fn ttyname
126	will modify the same object.