lib/libc/gen/ttyname.3

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)ttyname.3   8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/gen/ttyname.3,v 1.5.2.3 2001/12/14 18:33:51 ru Exp $
  34 .\" $DragonFly: src/lib/libc/gen/ttyname.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt TTYNAME 3
  38 .Os
  39 .Sh NAME
  40 .Nm ttyname ,
  41 .Nm isatty ,
  42 .Nm ttyslot
  43 .Nd get name of associated terminal (tty) from file descriptor
  44 .Sh LIBRARY
  45 .Lb libc
  46 .Sh SYNOPSIS
  47 .In unistd.h
  48 .Ft char *
  49 .Fn ttyname "int fd"
  50 .Ft int
  51 .Fn isatty "int fd"
  52 .Ft int
  53 .Fn ttyslot void
  54 .Sh DESCRIPTION
  55 These functions operate on the system file descriptors for terminal
  56 type devices.
  57 These descriptors are not related to the standard
  58 .Tn I/O
  59 .Dv FILE
  60 typedef, but refer to the special device files found in
  61 .Pa /dev
  62 and named
  63 .Pa /dev/tty Ns Em xx
  64 and for which an entry exists
  65 in the initialization file
  66 .Pa /etc/ttys .
  67 (See
  68 .Xr ttys 5 . )
  69 .Pp
  70 The
  71 .Fn isatty
  72 function
  73 determines if the file descriptor
  74 .Fa fd
  75 refers to a valid
  76 terminal type device.
  77 .Pp
  78 The
  79 .Fn ttyname
  80 function
  81 gets the related device name of
  82 a file descriptor for which
  83 .Fn isatty
  84 is true
  85 .Pp
  86 The
  87 .Fn ttyslot
  88 function
  89 fetches the current process' control terminal number from the
  90 .Xr ttys 5
  91 file entry.
  92 .Sh RETURN VALUES
  93 The
  94 .Fn ttyname
  95 function
  96 returns the null terminated name if the device is found and
  97 .Fn isatty
  98 is true; otherwise
  99 a
 100 .Dv NULL
 101 pointer is returned.
 102 .Pp
 103 The
 104 .Fn ttyslot
 105 function
 106 returns the unit number of the device file if found; otherwise
 107 the value zero is returned.
 108 .Sh FILES
 109 .Bl -tag -width /etc/ttys -compact
 110 .It Pa /dev/\(**
 111 .It Pa /etc/ttys
 112 .El
 113 .Sh SEE ALSO
 114 .Xr ioctl 2 ,
 115 .Xr ttys 5
 116 .Sh HISTORY
 117 A
 118 .Fn isatty ,
 119 .Fn ttyname ,
 120 and
 121 .Fn ttyslot
 122 function
 123 appeared in
 124 .At v7 .
 125 .Sh BUGS
 126 The
 127 .Fn ttyname
 128 function leaves its result in an internal static object and returns
 129 a pointer to that object.
 130 Subsequent calls to
 131 .Fn ttyname
 132 will modify the same object.