1 .\" Copyright (c) 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .\" @(#)tcsetattr.3 8.3 (Berkeley) 1/2/94
33 .\" $FreeBSD: src/lib/libc/gen/tcsetattr.3,v 1.6.2.4 2002/12/29 16:35:34 schweikh Exp $
34 .\" $DragonFly: src/lib/libc/gen/tcsetattr.3,v 1.5 2007/09/08 20:50:49 swildner Exp $
48 .Nd manipulating the termios structure
54 .Fn cfgetispeed "const struct termios *t"
56 .Fn cfsetispeed "struct termios *t" "speed_t speed"
58 .Fn cfgetospeed "const struct termios *t"
60 .Fn cfsetospeed "struct termios *t" "speed_t speed"
62 .Fn cfsetspeed "struct termios *t" "speed_t speed"
64 .Fn cfmakeraw "struct termios *t"
66 .Fn tcgetattr "int fd" "struct termios *t"
68 .Fn tcsetattr "int fd" "int action" "const struct termios *t"
75 functions are provided for getting and setting the termios structure.
84 functions are provided for getting and setting the baud rate values in
85 the termios structure.
86 The effects of the functions on the terminal as described below
87 do not become effective, nor are all errors detected, until the
90 Certain values for baud rates set in the termios structure and passed to
92 have special meanings.
93 These are discussed in the portion of the manual page that describes the
96 .Sh GETTING AND SETTING THE BAUD RATE
97 The input and output baud rates are found in the termios structure.
100 is typedef'd in the include file
102 The value of the integer corresponds directly to the baud rate being
103 represented, however, the following symbolic values are defined.
121 #ifndef _POSIX_SOURCE
124 #endif /*_POSIX_SOURCE */
129 function returns the input baud rate in the termios structure referenced by
134 function sets the input baud rate in the termios structure referenced by
141 function returns the output baud rate in the termios structure referenced by
146 function sets the output baud rate in the termios structure referenced by
153 function sets both the input and output baud rate in the termios structure
159 Upon successful completion, the functions
165 Otherwise, a value of -1 is returned and the global variable
167 is set to indicate the error.
168 .Sh GETTING AND SETTING THE TERMIOS STATE
169 This section describes the functions that are used to control the general
171 Unless otherwise noted for a specific command, these functions are restricted
172 from use by background processes.
173 Attempts to perform these operations shall cause the process group to be sent
177 If the calling process is blocking or ignoring
179 signals, the process is allowed to perform the operation and the
183 In all the functions, although
185 is an open file descriptor, the functions affect the underlying terminal
186 file, not just the open file description associated with the particular
191 function sets the flags stored in the termios structure to a state disabling
192 all input and output processing, giving a
194 It should be noted that there is no function to reverse this effect.
195 This is because there are a variety of processing options that could be
196 re-enabled and the correct method is for an application to snapshot the
197 current terminal state using the function
199 setting raw mode with
203 and then using another
205 with the saved state to revert to the previous terminal state.
209 function copies the parameters associated with the terminal referenced
212 in the termios structure referenced by
214 This function is allowed from a background process, however, the terminal
215 attributes may be subsequently changed by a foreground process.
219 function sets the parameters associated with the terminal from the
220 termios structure referenced by
226 the following values, as specified in the include file
228 .Bl -tag -width ".Dv TCSADRAIN"
230 The change occurs immediately.
232 The change occurs after all output written to
234 has been transmitted to the terminal.
237 should be used when changing parameters that affect output.
239 The change occurs after all output written to
241 has been transmitted to the terminal.
242 Additionally, any input that has been received but not read is discarded.
248 value, the values of the
256 The 0 baud rate is used to terminate the connection.
257 If 0 is specified as the output speed to the function
259 modem control will no longer be asserted on the terminal, disconnecting
262 If zero is specified as the input speed to the function
264 the input baud rate will be set to the same value as that specified by
265 the output baud rate.
269 is unable to make any of the requested changes, it returns -1 and
272 Otherwise, it makes all of the requested changes it can.
273 If the specified input and output baud rates differ and are a combination
274 that is not supported, neither baud rate is changed.
276 Upon successful completion, the functions
282 return -1 and the global variable
284 is set to indicate the error, as follows:
293 was not a valid file descriptor.
297 function was interrupted by a signal.
303 function was not valid, or an attempt was made to change an attribute
304 represented in the termios structure to an unsupported value.
306 The file associated with the
326 functions are expected to be compliant with the
338 function are extensions to the