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$
  30 .\"
  31 .Dd June 4, 1993
  32 .Dt STTY 3
  33 .Os
  34 .Sh NAME
  35 .Nm stty ,
  36 .Nm gtty
  37 .Nd set and get terminal state (defunct)
  38 .Sh LIBRARY
  39 .Lb libcompat
  40 .Sh SYNOPSIS
  41 .In sgtty.h
  42 .Ft int
  43 .Fn stty "int fd" "struct sgttyb *buf"
  44 .Ft int
  45 .Fn gtty "int fd" "struct sgttyb *buf"
  46 .Sh DESCRIPTION
  47 .Bf -symbolic
  48 These interfaces are obsoleted by
  49 .Xr ioctl 2 .
  50 .Ef
  51 .Pp
  52 The
  53 .Fn stty
  54 function
  55 sets the state of the terminal associated with
  56 .Fa fd .
  57 The
  58 .Fn gtty
  59 function
  60 retrieves the state of the terminal associated
  61 with
  62 .Fa fd .
  63 To set the state of a terminal the call must have
  64 write permission.
  65 .Pp
  66 The
  67 .Fn stty
  68 call is actually
  69 .Ql ioctl(fd, TIOCSETP, buf) ,
  70 while
  71 the
  72 .Fn gtty
  73 call is
  74 .Ql ioctl(fd, TIOCGETP, buf) .
  75 See
  76 .Xr ioctl 2
  77 and
  78 .Xr tty 4
  79 for an explanation.
  80 .Sh DIAGNOSTICS
  81 If the call is successful 0 is returned, otherwise \-1 is
  82 returned and the global variable
  83 .Va errno
  84 contains the reason for the failure.
  85 .Sh SEE ALSO
  86 .Xr ioctl 2 ,
  87 .Xr tty 4
  88 .Sh HISTORY
  89 The
  90 .Fn stty
  91 and
  92 .Fn gtty
  93 functions appeared in
  94 .Bx 4.2 .