Skip to content

Commit fd74eef

Browse files
zeeshan56656aduh95
authored andcommitted
doc: clarify tty raw mode applies to input processing only
Update the setRawMode documentation to specify that raw mode disables special processing of input characters only. Output processing, such as newline translation on Unix terminals, is not affected. Fixes: #63059 Signed-off-by: zeeshan56656 <zeeshan130710@gmail.com> PR-URL: #63438 Reviewed-By: Anna Henningsen <anna@addaleax.net>
1 parent 858496b commit fd74eef

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

‎doc/api/tty.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,11 @@ added: v0.7.7
8080
Allows configuration of `tty.ReadStream` so that it operates as a raw device.
8181

8282
When in raw mode, input is always available character-by-character, not
83-
including modifiers. Additionally, all special processing of characters by the
84-
terminal is disabled, including echoing input
83+
including modifiers. Additionally, all special processing of input characters
84+
by the terminal is disabled, including echoing input
8585
characters. <kbd>Ctrl</kbd>+<kbd>C</kbd> will no longer cause a `SIGINT` when
86-
in this mode.
86+
in this mode. This mode does not affect terminal output processing, such as
87+
newline translation on Unix terminals.
8788

8889
## Class: `tty.WriteStream`
8990

0 commit comments

Comments
 (0)