isatty(3): mention return values and error codes
authorStathis Kamperis <ekamperi@gmail.com>
Sat, 7 Mar 2009 15:58:30 +0000 (15:58 +0000)
committerSascha Wildner <saw@online.de>
Sun, 22 Mar 2009 09:08:53 +0000 (10:08 +0100)
lib/libc/gen/ttyname.3

index eb3769d..6edcb7b 100644 (file)
@@ -83,12 +83,12 @@ function
 gets the related device name of
 a file descriptor for which
 .Fn isatty
-is true
+is true.
 .Pp
 The
 .Fn ttyname_r
 function is a thread-safe version of
-.Fn ttyname
+.Fn ttyname .
 .Pp
 The
 .Fn ttyslot
@@ -98,6 +98,12 @@ fetches the current process' control terminal number from the
 file entry.
 .Sh RETURN VALUES
 The
+.Fn isatty
+function
+returns 1 if the file descriptor refers to a valid terminal
+device and 0 otherwise.
+.Pp
+The
 .Fn ttyname
 function
 returns the null terminated name if the device is found and
@@ -117,6 +123,21 @@ the value zero is returned.
 .It Pa /dev/\(**
 .It Pa /etc/ttys
 .El
+.Sh ERRORS
+The
+.Fn isatty
+function
+may fail if:
+.Bl -tag -width Er
+.It Bq Er EBADF
+The
+.Fa fd
+is not a valid open file descriptor.
+.It Bq Er ENOTTY
+The
+.Fa fd
+is not associated with a terminal.
+.El
 .Sh SEE ALSO
 .Xr ioctl 2 ,
 .Xr ttys 5