lib/libcompat/4.1/stty.3

   1 .\" Copyright (c) 1983, 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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)stty.3      8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libcompat/4.1/stty.3,v 1.4.2.4 2001/12/17 10:08:28 ru Exp $
  30 .\" $DragonFly: src/lib/libcompat/4.1/stty.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
  31 .\"
  32 .Dd June 4, 1993
  33 .Dt STTY 3
  34 .Os
  35 .Sh NAME
  36 .Nm stty ,
  37 .Nm gtty
  38 .Nd set and get terminal state (defunct)
  39 .Sh LIBRARY
  40 .Lb libcompat
  41 .Sh SYNOPSIS
  42 .In sgtty.h
  43 .Ft int
  44 .Fn stty "int fd" "struct sgttyb *buf"
  45 .Ft int
  46 .Fn gtty "int fd" "struct sgttyb *buf"
  47 .Sh DESCRIPTION
  48 .Bf -symbolic
  49 These interfaces are obsoleted by
  50 .Xr ioctl 2 .
  51 .Ef
  52 .Pp
  53 The
  54 .Fn stty
  55 function
  56 sets the state of the terminal associated with
  57 .Fa fd .
  58 The
  59 .Fn gtty
  60 function
  61 retrieves the state of the terminal associated
  62 with
  63 .Fa fd .
  64 To set the state of a terminal the call must have
  65 write permission.
  66 .Pp
  67 The
  68 .Fn stty
  69 call is actually
  70 .Ql ioctl(fd, TIOCSETP, buf) ,
  71 while
  72 the
  73 .Fn gtty
  74 call is
  75 .Ql ioctl(fd, TIOCGETP, buf) .
  76 See
  77 .Xr ioctl 2
  78 and
  79 .Xr tty 4
  80 for an explanation.
  81 .Sh DIAGNOSTICS
  82 If the call is successful 0 is returned, otherwise \-1 is
  83 returned and the global variable
  84 .Va errno
  85 contains the reason for the failure.
  86 .Sh SEE ALSO
  87 .Xr ioctl 2 ,
  88 .Xr tty 4
  89 .Sh HISTORY
  90 The
  91 .Fn stty
  92 and
  93 .Fn gtty
  94 functions appeared in
  95 .Bx 4.2 .