diff options
| author | jilles <jilles@FreeBSD.org> | 2015-02-08 22:29:06 +0000 |
|---|---|---|
| committer | jilles <jilles@FreeBSD.org> | 2015-02-08 22:29:06 +0000 |
| commit | 25afd7ae71e6eeb39b69c04fcc147ee043fef6fd (patch) | |
| tree | 98ab2453f85ea39522414d0d414689f199c84428 /lib | |
| parent | d13c2ab3c3ab23a5e4c42e32208902978bba3209 (diff) | |
| download | FreeBSD-src-25afd7ae71e6eeb39b69c04fcc147ee043fef6fd.zip FreeBSD-src-25afd7ae71e6eeb39b69c04fcc147ee043fef6fd.tar.gz | |
MFC r268857: ttyname(3): Fix EBADF/ENOTTY error descriptions.
Also, make sure to document the return values and errors for all three
functions in the man page.
PR: 191931
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/libc/gen/ttyname.3 | 26 |
1 files changed, 21 insertions, 5 deletions
diff --git a/lib/libc/gen/ttyname.3 b/lib/libc/gen/ttyname.3 index 9420bbe..9e8a4f0 100644 --- a/lib/libc/gen/ttyname.3 +++ b/lib/libc/gen/ttyname.3 @@ -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 |
