1 .\" Copyright (c) 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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 .\" 4. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)ttyname.3 8.1 (Berkeley) 6/4/93
29 .\" $FreeBSD: src/lib/libc/gen/ttyname.3,v 1.14 2007/01/09 00:27:55 imp Exp $
30 .\" $DragonFly: src/lib/libc/gen/ttyname.3,v 1.3 2005/11/19 22:32:53 swildner Exp $
40 .Nd get name of associated terminal (tty) from file descriptor
48 .Fn ttyname_r "int fd" "char *buf" "size_t len"
54 These functions operate on the system file descriptors for terminal
56 These descriptors are not related to the standard
59 typedef, but refer to the special device files found in
63 and for which an entry exists
64 in the initialization file
72 determines if the file descriptor
80 gets the related device name of
81 a file descriptor for which
88 returns the name stored in a static buffer which will be overwritten
93 takes a buffer and length as arguments to avoid this problem.
98 fetches the current process' control terminal number from the
105 returns 1 if the file descriptor refers to a valid terminal
106 device and 0 otherwise.
111 returns the null terminated name if the device is found and
119 function returns 0 if successful.
120 Otherwise an error number is returned.
125 returns the unit number of the device file if found; otherwise
126 the value zero is returned.
128 .Bl -tag -width ".Pa /etc/ttys" -compact
139 may fail and return the following error codes:
144 is not a valid open file descriptor.
148 is not associated with a terminal.
153 is smaller than the length of the string to be returned.