| blob | 7023349a21f43ae0a6593aad89761f18991380ba |
1 .\"
2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 .\" permission to reproduce portions of its copyrighted documentation.
4 .\" Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
6 .\"
7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 .\" Group, have given us permission to reprint portions of their
9 .\" documentation.
10 .\"
11 .\" In the following statement, the phrase ``this text'' refers to portions
12 .\" of the system documentation.
13 .\"
14 .\" Portions of this text are reprinted and reproduced in electronic form
15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 .\" Standard for Information Technology -- Portable Operating System
17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy
20 .\" between these versions and the original IEEE and The Open Group
21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 .\" document. The original Standard can be obtained online at
23 .\" http://www.opengroup.org/unix/online.html.
24 .\"
25 .\" This notice shall appear on any product containing this material.
26 .\"
27 .\" The contents of this file are subject to the terms of the
28 .\" Common Development and Distribution License (the "License").
29 .\" You may not use this file except in compliance with the License.
30 .\"
31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 .\" or http://www.opensolaris.org/os/licensing.
33 .\" See the License for the specific language governing permissions
34 .\" and limitations under the License.
35 .\"
36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 .\" If applicable, add the following below this CDDL HEADER, with the
39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 .\"
42 .\"
43 .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
44 .\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
45 .\"
46 .TH TCSETATTR 3C "Aug 14, 2002"
47 .SH NAME
48 tcsetattr \- set the parameters associated with the terminal
49 .SH SYNOPSIS
50 .LP
51 .nf
52 #include <termios.h>
54 \fBint\fR \fBtcsetattr\fR(\fBint\fR \fIfildes\fR, \fBint\fR \fIoptional_actions\fR,
55 \fBconst struct termios *\fR\fItermios_p\fR);
56 .fi
58 .SH DESCRIPTION
59 .sp
60 .LP
61 The \fBtcsetattr()\fR function sets the parameters associated with the terminal
62 referred to by the open file descriptor \fIfildes\fR (an open file descriptor
63 associated with a terminal) from the \fBtermios\fR structure (see
64 \fBtermio\fR(7I)) referenced by \fItermios_p\fR as follows:
65 .RS +4
66 .TP
67 .ie t \(bu
68 .el o
69 If \fIoptional_actions\fR is \fBTCSANOW\fR, the change will occur immediately.
70 .RE
71 .RS +4
72 .TP
73 .ie t \(bu
74 .el o
75 If \fIoptional_actions\fR is \fBTCSADRAIN\fR, the change will occur after all
76 output written to \fIfildes\fR is transmitted. This function should be used
77 when changing parameters that affect output.
78 .RE
79 .RS +4
80 .TP
81 .ie t \(bu
82 .el o
83 If \fIoptional_actions\fR is \fBTCSAFLUSH\fR, the change will occur after all
84 output written to \fIfildes\fR is transmitted, and all input so far received
85 but not read will be discarded before the change is made.
86 .RE
87 .sp
88 .LP
89 If the output baud rate stored in the \fBtermios\fR structure pointed to by
90 \fItermios_p\fR is the zero baud rate, B0, the modem control lines will no
91 longer be asserted. Normally, this will disconnect the line.
92 .sp
93 .LP
94 If the input baud rate stored in the \fBtermios\fR structure pointed to by
95 \fItermios_p\fR is 0, the input baud rate given to the hardware will be the
96 same as the output baud rate stored in the \fBtermios\fR structure.
97 .sp
98 .LP
99 The \fBtcsetattr()\fR function will return successfully if it was able to
100 perform any of the requested actions, even if some of the requested actions
101 could not be performed. It will set all the attributes that implementation
102 supports as requested and leave all the attributes not supported by the
103 implementation unchanged. If no part of the request can be honoured, it will
104 return \fB\(mi1\fR and set \fBerrno\fR to \fBEINVAL\fR. If the input and output
105 baud rates differ and are a combination that is not supported, neither baud
106 rate is changed. A subsequent call to \fBtcgetattr\fR(3C) will return the
107 actual state of the terminal device (reflecting both the changes made and not
108 made in the previous \fBtcsetattr()\fR call). The \fBtcsetattr()\fR function
109 will not change the values in the \fBtermios\fR structure whether or not it
110 actually accepts them.
111 .sp
112 .LP
113 The effect of \fBtcsetattr()\fR is undefined if the value of the \fBtermios\fR
114 structure pointed to by \fItermios_p\fR was not derived from the result of a
115 call to \fBtcgetattr\fR(3C) on \fIfildes\fR; an application should modify only
116 fields and flags defined by this document between the call to
117 \fBtcgetattr\fR(3C) and \fBtcsetattr()\fR, leaving all other fields and flags
118 unmodified.
119 .sp
120 .LP
121 No actions defined by this document, other than a call to \fBtcsetattr()\fR or
122 a close of the last file descriptor in the system associated with this terminal
123 device, will cause any of the terminal attributes defined by this document to
124 change.
125 .sp
126 .LP
127 Attempts to use \fBtcsetattr()\fR from a process which is a member of a
128 background process group on a \fIfildes\fR associated with its controlling
129 terminal, will cause the process group to be sent a \fBSIGTTOU\fR signal. If
130 the calling process is blocking or ignoring \fBSIGTTOU\fR signals, the process
131 is allowed to perform the operation, and no signal is sent.
132 .SH USAGE
133 .sp
134 .LP
135 If trying to change baud rates, applications should call \fBtcsetattr()\fR then
136 call \fBtcgetattr\fR(3C) in order to determine what baud rates were actually
137 selected.
138 .SH RETURN VALUES
139 .sp
140 .LP
141 Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
142 returned and \fBerrno\fR is set to indicate the error.
143 .SH ERRORS
144 .sp
145 .LP
146 The \fBtcsetattr()\fR function will fail if:
147 .sp
148 .ne 2
149 .na
150 \fB\fBEBADF\fR\fR
151 .ad
152 .RS 10n
153 The \fIfildes\fR argument is not a valid file descriptor.
154 .RE
156 .sp
157 .ne 2
158 .na
159 \fB\fBEINTR\fR\fR
160 .ad
161 .RS 10n
162 A signal interrupted \fBtcsettattr()\fR.
163 .RE
165 .sp
166 .ne 2
167 .na
168 \fB\fBEINVAL\fR\fR
169 .ad
170 .RS 10n
171 The \fIoptional_actions\fR argument is not a supported value, or an attempt was
172 made to change an attribute represented in the \fBtermios\fR structure to an
173 unsupported value.
174 .RE
176 .sp
177 .ne 2
178 .na
179 \fB\fBENOTTY\fR\fR
180 .ad
181 .RS 10n
182 The file associated with \fIfildes\fR is not a terminal.
183 .RE
185 .sp
186 .LP
187 The \fBtcsetattr()\fR function may fail if:
188 .sp
189 .ne 2
190 .na
191 \fB\fBEIO\fR\fR
192 .ad
193 .RS 7n
194 The process group of the writing process is orphaned, and the writing process
195 is not ignoring or blocking \fBSIGTTOU\fR.
196 .RE
198 .SH ATTRIBUTES
199 .sp
200 .LP
201 See \fBattributes\fR(5) for descriptions of the following attributes:
202 .sp
204 .sp
205 .TS
206 box;
207 c | c
208 l | l .
209 ATTRIBUTE TYPE ATTRIBUTE VALUE
210 _
211 Interface Stability Standard
212 _
213 MT-Level MT-Safe, and Async-Signal-Safe
214 .TE
216 .SH SEE ALSO
217 .sp
218 .LP
219 \fBcfgetispeed\fR(3C), \fBtcgetattr\fR(3C), \fBattributes\fR(5),
220 \fBstandards\fR(5), \fBtermio\fR(7I)