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