xref: /netbsd/lib/libcompat/4.1/stty.3 (revision bf9ec67e)
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.\"     from: @(#)stty.3	8.1 (Berkeley) 6/4/93
33.\"	$NetBSD: stty.3,v 1.7 2002/02/07 07:00:35 ross Exp $
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.Fd #include \*[Lt]sgtty.h\*[Gt]
46.Fn stty "int fd" "struct sgttyb *buf"
47.Fn gtty "int fd" "struct sgttyb *buf"
48.Sh DESCRIPTION
49.Bf -symbolic
50These interfaces are obsoleted by
51.Xr ioctl 2 .
52They are available from the compatibility library, libcompat.
53.Ef
54.Pp
55The
56.Fn stty
57function
58sets the state of the terminal associated with
59.Fa fd .
60The
61.Fn gtty
62function
63retrieves the state of the terminal associated
64with
65.Fa fd .
66To set the state of a terminal the call must have
67write permission.
68.Pp
69The
70.Fn stty
71call is actually
72.Ql ioctl(fd, TIOCSETP, buf) ,
73while
74the
75.Fn gtty
76call is
77.Ql ioctl(fd, TIOCGETP, buf) .
78See
79.Xr ioctl 2
80and
81.Xr tty 4
82for an explanation.
83.Sh DIAGNOSTICS
84If the call is successful 0 is returned, otherwise \-1 is
85returned and the global variable
86.Va errno
87contains the reason for the failure.
88.Sh SEE ALSO
89.Xr ioctl 2 ,
90.Xr tty 4
91.Sh HISTORY
92The
93.Fn stty
94and
95.Fn gtty
96functions appeared in
97.Bx 4.2 .
98