From a0a6ff2ea5afc93c5d6b592ebecc17ff5b4ffa6a Mon Sep 17 00:00:00 2001 From: Jeremiah Senkpiel Date: Tue, 6 Dec 2016 11:24:26 -0500 Subject: doc: add some info on `tty#setRawMode()` Partially taken from https://linux.die.net/man/3/cfmakeraw A very simple test script: ``` if (process.argv[2] === 'raw') process.stdin.setRawMode(true) process.stdin.on('data', (chunk) => { console.log(chunk) console.log(chunk.toString()) }) ``` Refs: https://github.com/nodejs/node/pull/10037 PR-URL: https://github.com/nodejs/node/pull/10147 Reviewed-By: James M Snell Reviewed-By: Colin Ihrig Reviewed-By: Anna Henningsen --- doc/api/tty.md | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'doc/api/tty.md') diff --git a/doc/api/tty.md b/doc/api/tty.md index f9be1fc4ff..8f250e45d6 100644 --- a/doc/api/tty.md +++ b/doc/api/tty.md @@ -50,6 +50,13 @@ raw device. Defaults to `false`. added: v0.7.7 --> +Allows configuration of `tty.ReadStream` so that it operates as a raw device. + +When in raw mode, input is always available character-by-character, not +including modifiers. Additionally, all special processing of characters by the +terminal is disabled, including echoing input characters. +Note that `CTRL`+`C` will no longer cause a `SIGINT` when in this mode. + * `mode` {boolean} If `true`, configures the `tty.ReadStream` to operate as a raw device. If `false`, configures the `tty.ReadStream` to operate in its default mode. The `readStream.isRaw` property will be set to the resulting -- cgit v1.2.3