Skip to content

Commit

Permalink
doc: link SIGTSTP / SIGCONT events in readline doc
Browse files Browse the repository at this point in the history
PR-URL: nodejs/node#8475
Reviewed-By: Brian White <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
  • Loading branch information
italoacasas authored and lpinca committed Sep 13, 2016
1 parent 15d72c8 commit 53178f9
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions doc/api/readline.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ The `'pause'` event is emitted when one of the following occur:

* The `input` stream is paused.
* The `input` stream is not paused and receives the `SIGCONT` event. (See
events `SIGTSTP` and `SIGCONT`)
events [`SIGTSTP`][] and [`SIGCONT`][])

The listener function is called without passing any arguments.

Expand Down Expand Up @@ -126,7 +126,7 @@ The `'SIGCONT'` event is emitted when a Node.js process previously moved into
the background using `<ctrl>-Z` (i.e. `SIGTSTP`) is then brought back to the
foreground using `fg(1)`.

If the `input` stream was paused *before* the `SIGSTP` request, this event will
If the `input` stream was paused *before* the `SIGTSTP` request, this event will
not be emitted.

The listener function is invoked without passing any arguments.
Expand Down Expand Up @@ -169,7 +169,7 @@ rl.on('SIGINT', () => {
added: v0.7.5
-->

The `'SIGTSPT'` event is emitted when the `input` stream receives a `<ctrl>-Z`
The `'SIGTSTP'` event is emitted when the `input` stream receives a `<ctrl>-Z`
input, typically known as `SIGTSTP`. If there are no `SIGTSTP` event listeners
registered when the `input` stream receives a `SIGTSTP`, the Node.js process
will be sent to the background.
Expand Down Expand Up @@ -523,3 +523,5 @@ rl.on('line', (line) => {
[Writable]: stream.html
[Readable]: stream.html
[TTY]: tty.html
[`SIGTSTP`]: readline.html#readline_event_sigtstp
[`SIGCONT`]: readline.html#readline_event_sigcont

0 comments on commit 53178f9

Please sign in to comment.