8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man3c / termios.3c
blobb410868e6d8c1ffa40bca5e40d5081ab8a55dd5c
1 '\" te
2 .\"  Copyright 1989 AT&T  Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH TERMIOS 3C "Apr 5, 1996"
7 .SH NAME
8 termios \- general terminal interface
9 .SH SYNOPSIS
10 .LP
11 .nf
12 #include <termios.h>
14 \fBint\fR \fBtcgetattr\fR(\fBint\fR \fIfildes\fR, \fBstruct termios *\fR\fItermios_p\fR);
15 .fi
17 .LP
18 .nf
19 \fBint\fR \fBtcsetattr\fR(\fBint\fR \fIfildes\fR, \fBint\fR \fIoptional_actions\fR,
20      \fBconst struct termios *\fR\fItermios_p\fR);
21 .fi
23 .LP
24 .nf
25 \fBint\fR \fBtcsendbreak\fR(\fBint\fR \fIfildes\fR, \fBint\fR \fIduration\fR);
26 .fi
28 .LP
29 .nf
30 \fBint\fR \fBtcdrain\fR(\fBint\fR \fIfildes\fR);
31 .fi
33 .LP
34 .nf
35 \fBint\fR \fBtcflush\fR(\fBint\fR \fIfildes\fR, \fBint\fR \fIqueue_selector\fR);
36 .fi
38 .LP
39 .nf
40 \fBint\fR \fBtcflow\fR(\fBint\fR \fIfildes\fR, \fBint\fR \fIaction\fR);
41 .fi
43 .LP
44 .nf
45 \fBspeed_t\fR \fBcfgetospeed\fR(\fBconst struct termios *\fR\fItermios_p\fR);
46 .fi
48 .LP
49 .nf
50 \fBint\fR \fBcfsetospeed\fR(\fBstruct termios *\fR\fItermios_p\fR, \fBspeed_t\fR \fIspeed\fR);
51 .fi
53 .LP
54 .nf
55 \fBspeed_t\fR \fBcfgetispeed\fR(\fBconst struct termios *\fR\fItermios_p\fR);
56 .fi
58 .LP
59 .nf
60 \fBint\fR \fBcfsetispeed\fR(\fBstruct termios *\fR\fItermios_p\fR, \fBspeed_t\fR \fIspeed\fR);
61 .fi
63 .LP
64 .nf
65 #include <sys/types.h>
66 #include <termios.h>
68 \fBpid_t\fR \fBtcgetpgrp\fR(\fBint\fR \fIfildes\fR);
69 .fi
71 .LP
72 .nf
73 \fBint\fR \fBtcsetpgrp\fR(\fBint\fR \fIfildes\fR, \fBpid_t\fR \fIpgid\fR);
74 .fi
76 .LP
77 .nf
78 \fBpid_t\fR \fBtcgetsid\fR(\fBint\fR \fIfildes\fR);
79 .fi
81 .SH DESCRIPTION
82 .sp
83 .LP
84 These functions describe a general terminal interface for controlling
85 asynchronous communications ports. A more detailed overview of the terminal
86 interface can be found in \fBtermio\fR(7I), which also describes an
87 \fBioctl\fR(2) interface that provides the same functionality. However, the
88 function interface described by these functions is the preferred user
89 interface.
90 .sp
91 .LP
92 Each of these functions is now described on a separate manual page.
93 .SH SEE ALSO
94 .sp
95 .LP
96 \fBioctl\fR(2), \fBcfgetispeed\fR(3C), \fBcfgetospeed\fR(3C),
97 \fBcfsetispeed\fR(3C), \fBcfsetospeed\fR(3C), \fBtcdrain\fR(3C),
98 \fBtcflow\fR(3C), \fBtcflush\fR(3C), \fBtcgetattr\fR(3C), \fBtcgetpgrp\fR(3C),
99 \fBtcgetsid\fR(3C), \fBtcsendbreak\fR(3C), \fBtcsetattr\fR(3C),
100 \fBtcgetpgrp\fR(3C), \fBtcsendbreak\fR(3C), \fBtermio\fR(7I)