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