Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: needs clarification: "terminal raw mode" (signal handling) #32065

Closed
jgehrcke opened this issue Mar 3, 2020 · 1 comment
Closed

docs: needs clarification: "terminal raw mode" (signal handling) #32065

jgehrcke opened this issue Mar 3, 2020 · 1 comment
Labels
doc Issues and PRs related to the documentations. process Issues and PRs related to the process subsystem. tty Issues and PRs related to the tty subsystem.

Comments

@jgehrcke
Copy link
Contributor

jgehrcke commented Mar 3, 2020

About the SIGINT event on process it is said in the docs that

It is not generated when terminal raw mode is enabled.

https://github.com/nodejs/node/blame/3ec4b21b1c438255df6f1652377011080dc28052/doc/api/process.md#L504

In the example program I play around with the SIGINT handler was not firing. I assumed that I was testing with the "terminal raw mode", so I was looking into understanding what that is and how to disable it.

A web search for nodejs "terminal raw mode" didn't yield anything useful, though. I also explored node --help and didn't see anything obvious.

I think we should clarify in docs what "terminal raw mode" is and then cross-link to that place from the SIGINT doc I linked above.

@Fishrock123 Fishrock123 added tty Issues and PRs related to the tty subsystem. process Issues and PRs related to the process subsystem. doc Issues and PRs related to the documentations. labels Mar 3, 2020
@Fishrock123
Copy link
Contributor

There is some documentation under the TTY docs: https://nodejs.org/dist/latest-v13.x/docs/api/tty.html#tty_readstream_setrawmode_mode

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. CTRL+C will no longer cause a SIGINT when in this mode.

I agree it should be linked to.

addaleax added a commit to addaleax/node that referenced this issue Mar 4, 2020
MylesBorins pushed a commit that referenced this issue Mar 9, 2020
Fixes: #32065

PR-URL: #32088
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
codebytere pushed a commit that referenced this issue Mar 17, 2020
Fixes: #32065

PR-URL: #32088
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
codebytere pushed a commit that referenced this issue Mar 23, 2020
Fixes: #32065

PR-URL: #32088
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
codebytere pushed a commit that referenced this issue Mar 30, 2020
Fixes: #32065

PR-URL: #32088
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. process Issues and PRs related to the process subsystem. tty Issues and PRs related to the tty subsystem.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants