TCSETATTR(3) BSD Programmer's Manual TCSETATTR(3)
c
\bcf
\bfg
\bge
\bet
\bti
\bis
\bsp
\bpe
\bee
\bed
\bd, c
\bcf
\bfs
\bse
\bet
\bti
\bis
\bsp
\bpe
\bee
\bed
\bd, c
\bcf
\bfg
\bge
\bet
\bto
\bos
\bsp
\bpe
\bee
\bed
\bd, c
\bcf
\bfs
\bse
\bet
\bto
\bos
\bsp
\bpe
\bee
\bed
\bd, c
\bcf
\bfs
\bse
\bet
\bts
\bsp
\bpe
\bee
\bed
\bd,
c
\bcf
\bfm
\bma
\bak
\bke
\ber
\bra
\baw
\bw, t
\btc
\bcg
\bge
\bet
\bta
\bat
\btt
\btr
\br, t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br - manipulating the termios structure
S
\bSY
\bYN
\bNO
\bOP
\bPS
\bSI
\bIS
\bS
#
\b#i
\bin
\bnc
\bcl
\blu
\bud
\bde
\be <
\b<t
\bte
\ber
\brm
\bmi
\bio
\bos
\bs.
\b.h
\bh>
\b>
_
\bs_
\bp_
\be_
\be_
\bd_
\b__
\bt
c
\bcf
\bfg
\bge
\bet
\bti
\bis
\bsp
\bpe
\bee
\bed
\bd(_
\bs_
\bt_
\br_
\bu_
\bc_
\bt _
\bt_
\be_
\br_
\bm_
\bi_
\bo_
\bs _
\b*_
\bt);
c
\bcf
\bfs
\bse
\bet
\bti
\bis
\bsp
\bpe
\bee
\bed
\bd(_
\bs_
\bt_
\br_
\bu_
\bc_
\bt _
\bt_
\be_
\br_
\bm_
\bi_
\bo_
\bs _
\b*_
\bt, _
\bs_
\bp_
\be_
\be_
\bd_
\b__
\bt _
\bs_
\bp_
\be_
\be_
\bd);
_
\bs_
\bp_
\be_
\be_
\bd_
\b__
\bt
c
\bcf
\bfg
\bge
\bet
\bto
\bos
\bsp
\bpe
\bee
\bed
\bd(_
\bs_
\bt_
\br_
\bu_
\bc_
\bt _
\bt_
\be_
\br_
\bm_
\bi_
\bo_
\bs _
\b*_
\bt);
c
\bcf
\bfs
\bse
\bet
\bto
\bos
\bsp
\bpe
\bee
\bed
\bd(_
\bs_
\bt_
\br_
\bu_
\bc_
\bt _
\bt_
\be_
\br_
\bm_
\bi_
\bo_
\bs _
\b*_
\bt, _
\bs_
\bp_
\be_
\be_
\bd_
\b__
\bt _
\bs_
\bp_
\be_
\be_
\bd);
c
\bcf
\bfs
\bse
\bet
\bts
\bsp
\bpe
\bee
\bed
\bd(_
\bs_
\bt_
\br_
\bu_
\bc_
\bt _
\bt_
\be_
\br_
\bm_
\bi_
\bo_
\bs _
\b*_
\bt, _
\bs_
\bp_
\be_
\be_
\bd_
\b__
\bt _
\bs_
\bp_
\be_
\be_
\bd);
c
\bcf
\bfm
\bma
\bak
\bke
\ber
\bra
\baw
\bw(_
\bs_
\bt_
\br_
\bu_
\bc_
\bt _
\bt_
\be_
\br_
\bm_
\bi_
\bo_
\bs _
\b*_
\bt);
t
\btc
\bcg
\bge
\bet
\bta
\bat
\btt
\btr
\br(_
\bi_
\bn_
\bt _
\bf_
\bd, _
\bs_
\bt_
\br_
\bu_
\bc_
\bt _
\bt_
\be_
\br_
\bm_
\bi_
\bo_
\bs _
\b*_
\bt);
t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br(_
\bi_
\bn_
\bt _
\bf_
\bd, _
\bi_
\bn_
\bt _
\ba_
\bc_
\bt_
\bi_
\bo_
\bn, _
\bs_
\bt_
\br_
\bu_
\bc_
\bt _
\bt_
\be_
\br_
\bm_
\bi_
\bo_
\bs _
\b*_
\bt);
D
\bDE
\bES
\bSC
\bCR
\bRI
\bIP
\bPT
\bTI
\bIO
\bON
\bN
The c
\bcf
\bfm
\bma
\bak
\bke
\ber
\bra
\baw
\bw, t
\btc
\bcg
\bge
\bet
\bta
\bat
\btt
\btr
\br and t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br functions are provided for getting
and setting the termios structure.
The c
\bcf
\bfg
\bge
\bet
\bti
\bis
\bsp
\bpe
\bee
\bed
\bd, c
\bcf
\bfs
\bse
\bet
\bti
\bis
\bsp
\bpe
\bee
\bed
\bd, c
\bcf
\bfg
\bge
\bet
\bto
\bos
\bsp
\bpe
\bee
\bed
\bd, c
\bcf
\bfs
\bse
\bet
\bto
\bos
\bsp
\bpe
\bee
\bed
\bd and c
\bcf
\bfs
\bse
\bet
\bts
\bsp
\bpe
\bee
\bed
\bd
functions are provided for getting and setting the baud rate values in
the termios structure. The effects of the functions on the terminal as
described below do not become effective, nor are all errors detected, un-
til the t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br function is called. Certain values for baud rates set
in the termios structure and passed to t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br have special meanings.
These are discussed in the portion of the manual page that describes the
t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br function.
G
\bGE
\bET
\bTT
\bTI
\bIN
\bNG
\bG A
\bAN
\bND
\bD S
\bSE
\bET
\bTT
\bTI
\bIN
\bNG
\bG T
\bTH
\bHE
\bE B
\bBA
\bAU
\bUD
\bD R
\bRA
\bAT
\bTE
\bE
The input and output baud rates are found in the termios structure. The
unsigned integer speed_t is typdef'd in the include file <_
\bt_
\be_
\br_
\bm_
\bi_
\bo_
\bs_
\b._
\bh>. The
value of the integer corresponds directly to the baud rate being repre-
sented, however, the following symbolic values are defined.
#endif /*_POSIX_SOURCE */
The c
\bcf
\bfg
\bge
\bet
\bti
\bis
\bsp
\bpe
\bee
\bed
\bd function returns the input baud rate in the termios
structure referenced by _
\bt_
\bp.
The c
\bcf
\bfs
\bse
\bet
\bti
\bis
\bsp
\bpe
\bee
\bed
\bd function sets the input baud rate in the termios struc-
ture referenced by _
\bt_
\bp to _
\bs_
\bp_
\be_
\be_
\bd.
The c
\bcf
\bfg
\bge
\bet
\bto
\bos
\bsp
\bpe
\bee
\bed
\bd function returns the output baud rate in the termios
structure referenced by _
\bt_
\bp.
The c
\bcf
\bfs
\bse
\bet
\bto
\bos
\bsp
\bpe
\bee
\bed
\bd function sets the output baud rate in the termios struc-
ture referenced by _
\bt_
\bp to _
\bs_
\bp_
\be_
\be_
\bd.
The c
\bcf
\bfs
\bse
\bet
\bts
\bsp
\bpe
\bee
\bed
\bd function sets both the input and output baud rate in the
termios structure referenced by _
\bt_
\bp to _
\bs_
\bp_
\be_
\be_
\bd.
Upon successful completion, the functions c
\bcf
\bfs
\bse
\bet
\bti
\bis
\bsp
\bpe
\bee
\bed
\bd, c
\bcf
\bfs
\bse
\bet
\bto
\bos
\bsp
\bpe
\bee
\bed
\bd, and
c
\bcf
\bfs
\bse
\bet
\bts
\bsp
\bpe
\bee
\bed
\bd return a value of 0. Otherwise, a value of -1 is returned and
the global variable _
\be_
\br_
\br_
\bn_
\bo is set to indicate the error.
G
\bGE
\bET
\bTT
\bTI
\bIN
\bNG
\bG A
\bAN
\bND
\bD S
\bSE
\bET
\bTT
\bTI
\bIN
\bNG
\bG T
\bTH
\bHE
\bE T
\bTE
\bER
\bRM
\bMI
\bIO
\bOS
\bS S
\bST
\bTA
\bAT
\bTE
\bE
This section describes the functions that are used to control the general
terminal interface. Unless otherwise noted for a specific command, these
functions are restricted from use by background processes. Attempts to
perform these operations shall cause the process group to be sent a SIGT-
TOU signal. If the calling process is blocking or ignoring SIGTTOU sig-
nals, the process is allowed to perform the operation and the SIGTTOU
In all the functions, although _
\bf_
\bd is an open file descriptor, the func-
tions affect the underlying terminal file, not just the open file de-
scription associated with the particular file descriptor.
The c
\bcf
\bfm
\bma
\bak
\bke
\ber
\bra
\baw
\bw function sets the flags stored in the termios structure to
a state disabling all input and output processing, giving a ``raw I/O
path.'' It should be noted that there is no function to reverse this ef-
fect. This is because there are a variety of processing options that
could be re-enabled and the correct method is for an application to snap-
shot the current terminal state using the function t
\btc
\bcg
\bge
\bet
\bta
\bat
\btt
\btr
\br, setting raw
mode with c
\bcf
\bfm
\bma
\bak
\bke
\ber
\bra
\baw
\bw and the subsequent t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br, and then using another
t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br with the saved state to revert to the previous terminal state.
The t
\btc
\bcg
\bge
\bet
\bta
\bat
\btt
\btr
\br function copies the parameters associated with the terminal
referenced by _
\bf_
\bd in the termios structure referenced by _
\bt_
\bp. This function
is allowed from a background process, however, the terminal attributes
may be subsequently changed by a foreground process.
The t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br function sets the parameters associated with the terminal
from the termios structure referenced by _
\bt_
\bp. The _
\ba_
\bc_
\bt_
\bi_
\bo_
\bn field is created
by _
\bo_
\br'ing the following values, as specified in the include file
<_
\bt_
\be_
\br_
\bm_
\bi_
\bo_
\bs_
\b._
\bh>.
_
\bT_
\bC_
\bS_
\bA_
\bN_
\bO_
\bW The change occurs immediately.
_
\bT_
\bC_
\bS_
\bA_
\bD_
\bR_
\bA_
\bI_
\bN The change occurs after all output written to _
\bf_
\bd has been
transmitted to the terminal. This value of _
\ba_
\bc_
\bt_
\bi_
\bo_
\bn should be
used when changing parameters that affect output.
_
\bT_
\bC_
\bS_
\bA_
\bF_
\bL_
\bU_
\bS_
\bH The change occurs after all output written to _
\bf_
\bd has been
transmitted to the terminal Additionally, any input that has
been received but not read is discarded.
_
\bT_
\bC_
\bS_
\bA_
\bS_
\bO_
\bF_
\bT If this value is _
\bo_
\br'ed into the _
\ba_
\bc_
\bt_
\bi_
\bo_
\bn value, the values of
the _
\bc_
\b__
\bc_
\bf_
\bl_
\ba_
\bg, _
\bc_
\b__
\bi_
\bs_
\bp_
\be_
\be_
\bd, and _
\bc_
\b__
\bo_
\bs_
\bp_
\be_
\be_
\bd fields are ignored.
The 0 baud rate is used to terminate the connection. If 0 is specified
as the output speed to the function t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br, modem control will no
longer be asserted on the terminal, disconnecting the terminal.
If zero is specified as the input speed to the function t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br, the
input baud rate will be set to the same value as that specified by the
If t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br is unable able to make any of the requested changes, it re-
turns -1 and sets errno. Otherwise, it makes all of the requested
changes it can. If the specified input and output baud rates differ and
are a combination that is not supported, neither baud rate is changed.
Upon successful completion, the functions t
\btc
\bcg
\bge
\bet
\bta
\bat
\btt
\btr
\br and t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br return
a value of 0. Otherwise, they return -1 and the global variable _
\be_
\br_
\br_
\bn_
\bo is
set to indicate the error, as follows:
[EBADF] The _
\bf_
\bd argument to t
\btc
\bcg
\bge
\bet
\bta
\bat
\btt
\btr
\br or t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br was not a valid
[EINTR] The t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br function was interrupted by a signal.
[EINVAL] The _
\ba_
\bc_
\bt_
\bi_
\bo_
\bn argument to the t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br function was not
valid, or an attempt was made to change an attribute repre-
sented in the termios structure to an unsupported value.
[ENOTTY] The file associated with the _
\bf_
\bd argument to t
\btc
\bcg
\bge
\bet
\bta
\bat
\btt
\btr
\br or
t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br is not a terminal.
S
\bSE
\bEE
\bE A
\bAL
\bLS
\bSO
\bO
tcsendbreak(3), termios(4)
S
\bST
\bTA
\bAN
\bND
\bDA
\bAR
\bRD
\bDS
\bS
The c
\bcf
\bfg
\bge
\bet
\bti
\bis
\bsp
\bpe
\bee
\bed
\bd, c
\bcf
\bfs
\bse
\bet
\bti
\bis
\bsp
\bpe
\bee
\bed
\bd, c
\bcf
\bfg
\bge
\bet
\bto
\bos
\bsp
\bpe
\bee
\bed
\bd, c
\bcf
\bfs
\bse
\bet
\bto
\bos
\bsp
\bpe
\bee
\bed
\bd, t
\btc
\bcg
\bge
\bet
\bta
\bat
\btt
\btr
\br and
t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br functions are expected to be compliant with the IEEE
Std1003.1-1988 (``POSIX'') specification. The c
\bcf
\bfm
\bma
\bak
\bke
\ber
\bra
\baw
\bw and c
\bcf
\bfs
\bse
\bet
\bts
\bsp
\bpe
\bee
\bed
\bd
functions, as well as the TCSASOFT option to the t
\btc
\bcs
\bse
\bet
\bta
\bat
\btt
\btr
\br function are
extensions to the IEEE Std1003.1-1988 (``POSIX'') specification.
projects / unix-history / blob