mirror/freebsd
1
0
Fork 0
mirror of https://git.FreeBSD.org/src.git synced 2025-01-13 14:40:22 +00:00
Code Issues Releases Activity

ttyname(3): Fix EBADF/ENOTTY error descriptions.

Browse Source 
Also, make sure to document the return values and errors for all three
functions in the man page.

PR:		191931
MFC after:	1 week
This commit is contained in:
Jilles Tjoelker 2014-07-18 21:29:59 +00:00
parent cd01c7a84f
commit becf520163
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=268857
1 changed files with 21 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
lib/libc/gen/ttyname.3
View File

@ -28,7 +28,7 @@
.\" @(#)ttyname.3 8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd May 14, 2005
.Dd July 18, 2014
.Dt TTYNAME 3
.Os
.Sh NAME
@ -76,6 +76,14 @@ function
takes a buffer and length as arguments to avoid this problem.
.Sh RETURN VALUES
The
.Fn isatty
function returns 1 if
.Fa fd
refers to a terminal type device;
otherwise, it returns 0 and may set
.Va errno
to indicate the error.
The
.Fn ttyname
function
returns the null terminated name if the device is found and
@ -89,15 +97,23 @@ The
function returns 0 if successful.
Otherwise an error number is returned.
.Sh ERRORS
The
.Fn ttyname_r
may fail and return the following error codes:
These functions may fail if:
.Bl -tag -width Er
.It Bq Er ENOTTY
.It Bq Er EBADF
The
.Fa fd
argument
is not a valid file descriptor.
.It Bq Er ENOTTY
The file associated with
.Fa fd
is not a terminal.
.El
.Pp
Additionally,
.Fn ttyname_r
may fail if:
.Bl -tag -width Er
.It Bq Er ERANGE
The
.Fa bufsize