usr/src/man/man3c/isatty.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH ISATTY 3C "Jul 24, 2002"
  47 .SH NAME
  48 isatty \- test for a terminal device
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <unistd.h>
  53
  54 \fBint\fR \fBisatty\fR(\fBint\fR \fIfildes\fR);
  55 .fi
  56
  57 .SH DESCRIPTION
  58 .sp
  59 .LP
  60 The \fBisatty()\fR function tests whether \fIfildes\fR, an open file
  61 descriptor, is associated with a terminal device.
  62 .SH RETURN VALUES
  63 .sp
  64 .LP
  65 The \fBisatty()\fR function returns \fB1\fR if \fIfildes\fR is associated with
  66 a terminal; otherwise it returns \fB0\fR and may set \fBerrno\fR to indicate
  67 the error.
  68 .SH ERRORS
  69 .sp
  70 .LP
  71 The \fBisatty()\fR function may fail if:
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBEBADF\fR\fR
  76 .ad
  77 .RS 10n
  78 The \fIfildes\fR argument is not a valid open file descriptor.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBENOTTY\fR\fR
  85 .ad
  86 .RS 10n
  87 The \fIfildes\fR argument is not associated with a terminal.
  88 .RE
  89
  90 .SH USAGE
  91 .sp
  92 .LP
  93 The \fBisatty()\fR function does not necessarily indicate that a human being is
  94 available for interaction via \fIfildes\fR. It is quite possible that
  95 non-terminal devices are connected to the communications line.
  96 .SH ATTRIBUTES
  97 .sp
  98 .LP
  99 See \fBattributes\fR(5) for descriptions of the following attributes:
 100 .sp
 101
 102 .sp
 103 .TS
 104 box;
 105 c | c
 106 l | l .
 107 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 108 _
 109 Interface Stability     Standard
 110 _
 111 MT-Level        MT-Safe
 112 .TE
 113
 114 .SH SEE ALSO
 115 .sp
 116 .LP
 117 \fBttyname\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)