Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

ttyname(3) [netbsd man page]

TTYNAME(3)						   BSD Library Functions Manual 						TTYNAME(3)

ttyname, ttyname_r, isatty, ttyslot -- get name of associated terminal (tty) from file descriptor LIBRARY
Standard C Library (libc, -lc) SYNOPSIS
#include <unistd.h> char * ttyname(int fd); int ttyname_r(int fd, char *buf, size_t len); int isatty(int fd); #include <stdlib.h> int ttyslot(void); DESCRIPTION
These functions operate on the system file descriptors for terminal type devices. These descriptors are not related to the standard I/O FILE typedef, but refer to the special device files found in /dev and named /dev/ttyxx and for which an entry exists in the initialization file /etc/ttys (see ttys(5)), or for pseudo-terminal devices created in ptyfs and named /dev/pts/n. The isatty() function determines if the file descriptor fd refers to a valid terminal type device. The ttyname() function gets the related device name of a file descriptor for which isatty() is true. The ttyname_r() is the reentrant ver- sion of the above, and it places the results in buf. If there is not enough space to place the results (indicated by len), then it returns an error. The ttyslot() function fetches the current process' control terminal number from the ttys(5) file entry. If the terminal is a pseudo-termi- nal, and there is no special entry in the ttys(5) file for it, the slot number returned is 1 + (last slot number) + minor(tty). This will return a consistent and unique number for each pseudo-terminal device without requiring one to enumerate all of them in ttys(5). IMPLEMENTATION NOTES
As an optimisation, these functions attempt to obtain information about all devices from the /var/run/dev.cdb database, if it exists. If the database exists but is out of date, then these functions may produce incorrect results. The database should be updated using the dev_mkdb(8) command. RETURN VALUES
The ttyname() function returns the NUL-terminated name if the device is found and isatty() is true; otherwise a NULL pointer is returned and errno is set to indicate the error. The ttyname_r() functions returns 0 on success and an error code on failure. The isatty() function returns 1 if fd is associated with a terminal device; otherwise it returns 0 and errno is set to indicate the error. The ttyslot() function returns the unit number of the device file if found; otherwise the value zero is returned. FILES
/dev/* /etc/ttys ERRORS
The ttyname(), ttyname_r(), and isatty() functions will fail if: [EBADF] The fd argument is not a valid file descriptor. [ENOTTY] The fd argument does not refer to a terminal device. The ttyname_r() function will also fail if: [ENOENT] The terminal device is not found. This can happen if the device node has been removed after it was opened. [ERANGE] The buffer provided is not large enough to fit the result. SEE ALSO
ioctl(2), ttys(5), dev_mkdb(8) STANDARDS
The ttyname() and isatty() functions conform to ISO/IEC 9945-1:1990 (``POSIX.1''). HISTORY
isatty(), ttyname(), and ttyslot() functions appeared in Version 7 AT&T UNIX. BUGS
The ttyname() function leaves its result in an internal static object and returns a pointer to that object. Subsequent calls to ttyname() will modify the same object. BSD
June 1, 2012 BSD

Check Out this Related Man Page

ttyname(3)						     Library Functions Manual							ttyname(3)

ttyname, isatty, ttyname_r - Get the name of a terminal LIBRARY
Standard C Library (, libc.a) SYNOPSIS
#include <unistd.h> char *ttyname( int file-descriptor); int isatty( int file-descriptor); int ttyname_r( int file-descriptor, char *buffer, int len); STANDARDS
Interfaces documented on this reference page conform to industry standards as follows: ttyname_r(): POSIX.1c isatty(), ttyname(): XSH4.2 Refer to the standards(5) reference page for more information about industry standards and associated tags. PARAMETERS
Specifies an open file descriptor. Points to a buffer in which the terminal name is stored. Specifies the length of the buffer pointed to by the buffer parameter. DESCRIPTION
The ttyname() function gets the name of a terminal. It returns a pointer to a string containing the null-terminated pathname of the termi- nal device associated with the file-descriptor parameter. The isatty() function determines if the device associated with the file-descriptor parameter is a terminal. NOTES
The ttyname() function returns a pointer to thread-specific data. Subsequent calls to this function from the same thread overwrite this data. RETURN VALUES
Upon successful completion, the ttyname() function returns a pointer to a string identifying a terminal device. A NULL pointer is returned if the file-descriptor parameter does not describe a terminal device in the /dev directory. Upon successful completion, the isatty() function returns a value of 1 if the specified file-descriptor parameter is associated with a ter- minal. Otherwise, it returns a value of zero (0). [POSIX] Upon successful completion, the ttyname_r() function stores the terminal name as a null-terminated string in the buffer pointed to by the buffer parameter and returns a value of 0 (zero). Otherwise, it returns an error number. [Tru64 UNIX] The obsolete version of ttyname_r() functions the same way as the POSIX version, except it returns a -1 upon unsuccessful completion. ERRORS
If the isatty() function fails, errno may be set to the following value: The file associated with file-descriptor is not a terminal. If the ttyname_r() function fails, errno may be set to the following value: The buffer parameter is a null pointer or the len parameter was too short to store the string. RELATED INFORMATION
Functions: ttyslot(3) Standards: standards(5) delim off ttyname(3)
Man Page