path: root/man/stty.1

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.5.
.TH STTY "1" "August 2023" "GNU coreutils 9.4" "User Commands"
.SH NAME
stty \- change and print terminal line settings
.SH SYNOPSIS
.B stty
[\fI\,-F DEVICE | --file=DEVICE\/\fR] [\fI\,SETTING\/\fR]...
.br
.B stty
[\fI\,-F DEVICE | --file=DEVICE\/\fR] [\fI\,-a|--all\/\fR]
.br
.B stty
[\fI\,-F DEVICE | --file=DEVICE\/\fR] [\fI\,-g|--save\/\fR]
.SH DESCRIPTION
.\" Add any additional description here
.PP
Print or change terminal characteristics.
.PP
Mandatory arguments to long options are mandatory for short options too.
.TP
\fB\-a\fR, \fB\-\-all\fR
print all current settings in human\-readable form
.TP
\fB\-g\fR, \fB\-\-save\fR
print all current settings in a stty\-readable form
.TP
\fB\-F\fR, \fB\-\-file\fR=\fI\,DEVICE\/\fR
open and use the specified DEVICE instead of stdin
.TP
\fB\-\-help\fR
display this help and exit
.TP
\fB\-\-version\fR
output version information and exit
.PP
Optional \- before SETTING indicates negation.  An * marks non\-POSIX
settings.  The underlying system defines which settings are available.
.SS "Special characters:"
.TP
* discard CHAR
CHAR will toggle discarding of output
.TP
eof CHAR
CHAR will send an end of file (terminate the input)
.TP
eol CHAR
CHAR will end the line
.TP
* eol2 CHAR
alternate CHAR for ending the line
.TP
erase CHAR
CHAR will erase the last character typed
.TP
intr CHAR
CHAR will send an interrupt signal
.TP
kill CHAR
CHAR will erase the current line
.TP
* lnext CHAR
CHAR will enter the next character quoted
.TP
quit CHAR
CHAR will send a quit signal
.TP
* rprnt CHAR
CHAR will redraw the current line
.TP
start CHAR
CHAR will restart the output after stopping it
.TP
stop CHAR
CHAR will stop the output
.TP
susp CHAR
CHAR will send a terminal stop signal
.TP
* swtch CHAR
CHAR will switch to a different shell layer
.TP
* werase CHAR
CHAR will erase the last word typed
.SS "Special settings:"
.TP
N
set the input and output speeds to N bauds
.TP
* cols N
tell the kernel that the terminal has N columns
.TP
* columns N
same as cols N
.TP
* [\-]drain
wait for transmission before applying settings (on by default)
.TP
ispeed N
set the input speed to N
.TP
* line N
use line discipline N
.TP
min N
with \fB\-icanon\fR, set N characters minimum for a completed read
.TP
ospeed N
set the output speed to N
.TP
* rows N
tell the kernel that the terminal has N rows
.TP
* size
print the number of rows and columns according to the kernel
.TP
speed
print the terminal speed
.TP
time N
with \fB\-icanon\fR, set read timeout of N tenths of a second
.SS "Control settings:"
.TP
[\-]clocal
disable modem control signals
.TP
[\-]cread
allow input to be received
.TP
* [\-]crtscts
enable RTS/CTS handshaking
.TP
csN
set character size to N bits, N in [5..8]
.TP
[\-]cstopb
use two stop bits per character (one with '\-')
.TP
[\-]hup
send a hangup signal when the last process closes the tty
.TP
[\-]hupcl
same as [\-]hup
.TP
[\-]parenb
generate parity bit in output and expect parity bit in input
.TP
[\-]parodd
set odd parity (or even parity with '\-')
.TP
* [\-]cmspar
use "stick" (mark/space) parity
.SS "Input settings:"
.TP
[\-]brkint
breaks cause an interrupt signal
.TP
[\-]icrnl
translate carriage return to newline
.TP
[\-]ignbrk
ignore break characters
.TP
[\-]igncr
ignore carriage return
.TP
[\-]ignpar
ignore characters with parity errors
.TP
* [\-]imaxbel
beep and do not flush a full input buffer on a character
.TP
[\-]inlcr
translate newline to carriage return
.TP
[\-]inpck
enable input parity checking
.TP
[\-]istrip
clear high (8th) bit of input characters
.TP
* [\-]iutf8
assume input characters are UTF\-8 encoded
.TP
* [\-]iuclc
translate uppercase characters to lowercase
.TP
* [\-]ixany
let any character restart output, not only start character
.TP
[\-]ixoff
enable sending of start/stop characters
.TP
[\-]ixon
enable XON/XOFF flow control
.TP
[\-]parmrk
mark parity errors (with a 255\-0\-character sequence)
.TP
[\-]tandem
same as [\-]ixoff
.SS "Output settings:"
.TP
* bsN
backspace delay style, N in [0..1]
.TP
* crN
carriage return delay style, N in [0..3]
.TP
* ffN
form feed delay style, N in [0..1]
.TP
* nlN
newline delay style, N in [0..1]
.TP
* [\-]ocrnl
translate carriage return to newline
.TP
* [\-]ofdel
use delete characters for fill instead of NUL characters
.TP
* [\-]ofill
use fill (padding) characters instead of timing for delays
.TP
* [\-]olcuc
translate lowercase characters to uppercase
.TP
* [\-]onlcr
translate newline to carriage return\-newline
.TP
* [\-]onlret
newline performs a carriage return
.TP
* [\-]onocr
do not print carriage returns in the first column
.TP
[\-]opost
postprocess output
.TP
* tabN
horizontal tab delay style, N in [0..3]
.TP
* tabs
same as tab0
.TP
* \fB\-tabs\fR
same as tab3
.TP
* vtN
vertical tab delay style, N in [0..1]
.SS "Local settings:"
.TP
[\-]crterase
echo erase characters as backspace\-space\-backspace
.TP
* crtkill
kill all line by obeying the echoprt and echoe settings
.TP
* \fB\-crtkill\fR
kill all line by obeying the echoctl and echok settings
.TP
* [\-]ctlecho
echo control characters in hat notation ('^c')
.TP
[\-]echo
echo input characters
.TP
* [\-]echoctl
same as [\-]ctlecho
.TP
[\-]echoe
same as [\-]crterase
.TP
[\-]echok
echo a newline after a kill character
.TP
* [\-]echoke
same as [\-]crtkill
.TP
[\-]echonl
echo newline even if not echoing other characters
.TP
* [\-]echoprt
echo erased characters backward, between '\e' and '/'
.TP
* [\-]extproc
enable "LINEMODE"; useful with high latency links
.TP
* [\-]flusho
discard output
.TP
[\-]icanon
enable special characters: erase, kill, werase, rprnt
.TP
[\-]iexten
enable non\-POSIX special characters
.TP
[\-]isig
enable interrupt, quit, and suspend special characters
.TP
[\-]noflsh
disable flushing after interrupt and quit special characters
.TP
* [\-]prterase
same as [\-]echoprt
.TP
* [\-]tostop
stop background jobs that try to write to the terminal
.TP
* [\-]xcase
with icanon, escape with '\e' for uppercase characters
.SS "Combination settings:"
.TP
* [\-]LCASE
same as [\-]lcase
.TP
cbreak
same as \fB\-icanon\fR
.TP
\fB\-cbreak\fR
same as icanon
.TP
cooked
same as brkint ignpar istrip icrnl ixon opost isig
icanon, eof and eol characters to their default values
.TP
\fB\-cooked\fR
same as raw
.TP
crt
same as echoe echoctl echoke
.TP
dec
same as echoe echoctl echoke \fB\-ixany\fR intr ^c erase 0177
kill ^u
.TP
* [\-]decctlq
same as [\-]ixany
.TP
ek
erase and kill characters to their default values
.TP
evenp
same as parenb \fB\-parodd\fR cs7
.TP
\fB\-evenp\fR
same as \fB\-parenb\fR cs8
.TP
* [\-]lcase
same as xcase iuclc olcuc
.TP
litout
same as \fB\-parenb\fR \fB\-istrip\fR \fB\-opost\fR cs8
.TP
\fB\-litout\fR
same as parenb istrip opost cs7
.TP
nl
same as \fB\-icrnl\fR \fB\-onlcr\fR
.TP
\fB\-nl\fR
same as icrnl \fB\-inlcr\fR \fB\-igncr\fR onlcr \fB\-ocrnl\fR \fB\-onlret\fR
.TP
oddp
same as parenb parodd cs7
.TP
\fB\-oddp\fR
same as \fB\-parenb\fR cs8
.TP
[\-]parity
same as [\-]evenp
.TP
pass8
same as \fB\-parenb\fR \fB\-istrip\fR cs8
.TP
\fB\-pass8\fR
same as parenb istrip cs7
.TP
raw
same as \fB\-ignbrk\fR \fB\-brkint\fR \fB\-ignpar\fR \fB\-parmrk\fR \fB\-inpck\fR \fB\-istrip\fR
\fB\-inlcr\fR \fB\-igncr\fR \fB\-icrnl\fR \fB\-ixon\fR \fB\-ixoff\fR \fB\-icanon\fR \fB\-opost\fR
\fB\-isig\fR \fB\-iuclc\fR \fB\-ixany\fR \fB\-imaxbel\fR \fB\-xcase\fR min 1 time 0
.TP
\fB\-raw\fR
same as cooked
.TP
sane
same as cread \fB\-ignbrk\fR brkint \fB\-inlcr\fR \fB\-igncr\fR icrnl
icanon iexten echo echoe echok \fB\-echonl\fR \fB\-noflsh\fR
\fB\-ixoff\fR \fB\-iutf8\fR \fB\-iuclc\fR \fB\-ixany\fR imaxbel \fB\-xcase\fR \fB\-olcuc\fR \fB\-ocrnl\fR
opost \fB\-ofill\fR onlcr \fB\-onocr\fR \fB\-onlret\fR nl0 cr0 tab0 bs0 vt0 ff0
isig \fB\-tostop\fR \fB\-ofdel\fR \fB\-echoprt\fR echoctl echoke \fB\-extproc\fR \fB\-flusho\fR,
all special characters to their default values
.PP
Handle the tty line connected to standard input.  Without arguments,
prints baud rate, line discipline, and deviations from stty sane.  In
settings, CHAR is taken literally, or coded as in ^c, 0x37, 0177 or
127; special values ^\- or undef used to disable special characters.
.SH AUTHOR
Written by David MacKenzie.
.SH "REPORTING BUGS"
GNU coreutils online help: <https://www.gnu.org/software/coreutils/>
.br
Report any translation bugs to <https://translationproject.org/team/>
.SH COPYRIGHT
Copyright \(co 2023 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
Full documentation <https://www.gnu.org/software/coreutils/stty>
.br
or available locally via: info \(aq(coreutils) stty invocation\(aq