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