Skip to content

Commit 60165b7

Browse files
shobhitchittorashobhitchittora
committed
doc: add the keybindings to readline doc. Also -
1. Adds ref in repl doc 2. Removes ref from tty doc Closes: nodejs#20814
1 parent 13ecfa3 commit 60165b7

File tree

3 files changed

+107
-105
lines changed

3 files changed

+107
-105
lines changed

‎doc/api/readline.md

Lines changed: 103 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ added: v0.1.98
287287

288288
The `rl.write()` method will write either `data` or a key sequence identified
289289
by `key` to the `output`. The `key` argument is supported only if `output` is
290-
a [TTY][] text terminal. See [`TTY keybindings`][] for a list of covered key
290+
a [TTY][] text terminal. See [`TTY keybindings`][] for a list of key
291291
combinations.
292292

293293
If `key` is specified, `data` is ignored.
@@ -528,6 +528,107 @@ rl.on('line', (line) => {
528528
});
529529
```
530530

531+
## TTY keybindings
532+
533+
<table>
534+
<tr>
535+
<th>Keybindings</th>
536+
<th>Description</th>
537+
</tr>
538+
<tr>
539+
<td><code>ctrl+shift+backspace</code></td>
540+
<td>delete line left</td>
541+
</tr>
542+
<tr>
543+
<td><code>ctrl+shift+delete</code></td>
544+
<td>delete line right</td>
545+
</tr>
546+
<tr>
547+
<td><code>ctrl+c</code></td>
548+
<td>emits SIGINT</td>
549+
</tr>
550+
<tr>
551+
<td><code>ctrl+h</code></td>
552+
<td>delete left</td>
553+
</tr>
554+
<tr>
555+
<td><code>ctrl+d</code></td>
556+
<td>delete right or EOF</td>
557+
</tr>
558+
<tr>
559+
<td><code>ctrl+u</code></td>
560+
<td>delete from current to line start</td>
561+
</tr>
562+
<tr>
563+
<td><code>ctrl+k</code></td>
564+
<td>delete from current to end of line</td>
565+
</tr>
566+
<tr>
567+
<td><code>ctrl+a</code></td>
568+
<td>goto start of line</td>
569+
</tr>
570+
<tr>
571+
<td><code>ctrl+e</code></td>
572+
<td>goto to end of line</td>
573+
</tr>
574+
<tr>
575+
<td><code>ctrl+b</code></td>
576+
<td>back one character</td>
577+
</tr>
578+
<tr>
579+
<td><code>ctrl+f</code></td>
580+
<td>forward one character</td>
581+
</tr>
582+
<tr>
583+
<td><code>ctrl+l</code></td>
584+
<td>clear screen </td>
585+
</tr>
586+
<tr>
587+
<td><code>ctrl+n</code></td>
588+
<td>next history item</td>
589+
</tr>
590+
<tr>
591+
<td><code>ctrl+p</code></td>
592+
<td>prev history item </td>
593+
</tr>
594+
<tr>
595+
<td><code>ctrl+z</code></td>
596+
<td>(need clarification)</td>
597+
</tr>
598+
<tr>
599+
<td><code>ctrl+w</code> or <code>ctrl+backspace</code></td>
600+
<td>delete backwards to a word boundary</td>
601+
</tr>
602+
<tr>
603+
<td><code>ctrl+delete</code></td>
604+
<td>delete forward to a word boundary</td>
605+
</tr>
606+
<tr>
607+
<td><code>ctrl+left</code></td>
608+
<td>word left </td>
609+
</tr>
610+
<tr>
611+
<td><code>ctrl+right</code></td>
612+
<td>word right</td>
613+
</tr>
614+
<tr>
615+
<td><code>meta+b</code></td>
616+
<td>word left</td>
617+
</tr>
618+
<tr>
619+
<td><code>meta+f</code></td>
620+
<td>word right</td>
621+
</tr>
622+
<tr>
623+
<td><code>meta+d</code> or <code>meta+delete</code></td>
624+
<td>delete word right</td>
625+
</tr>
626+
<tr>
627+
<td><code>meta+backspace</code></td>
628+
<td>delete word left </td>
629+
</tr>
630+
</table>
631+
531632
[`'SIGCONT'`]: readline.html#readline_event_sigcont
532633
[`'SIGTSTP'`]: readline.html#readline_event_sigtstp
533634
[`process.stdin`]: process.html#process_process_stdin
@@ -536,4 +637,4 @@ rl.on('line', (line) => {
536637
[TTY]: tty.html
537638
[Writable]: stream.html#stream_writable_streams
538639
[reading files]: #readline_example_read_file_stream_line_by_line
539-
[`TTY keybindings`]: tty.html#tty_tty_keybindings
640+
[`TTY keybindings`]: #readline_tty_keybindings

‎doc/api/repl.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ The following key combinations in the REPL have these special effects:
6767
variables. When pressed while entering other input, displays relevant
6868
autocompletion options.
6969

70+
For a full list of special keys, refer [`TTY keybindings`][].
71+
7072
### Default Evaluation
7173

7274
By default, all instances of `repl.REPLServer` use an evaluation function that
@@ -634,3 +636,4 @@ For an example of running a REPL instance over [curl(1)][], see:
634636
[`util.inspect()`]: util.html#util_util_inspect_object_options
635637
[curl(1)]: https://curl.haxx.se/docs/manpage.html
636638
[stream]: stream.html
639+
[`TTY keybindings`]: readline.html#readline_tty_keybindings

‎doc/api/tty.md

Lines changed: 1 addition & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -158,109 +158,7 @@ The `tty.isatty()` method returns `true` if the given `fd` is associated with
158158
a TTY and `false` if it is not, including whenever `fd` is not a non-negative
159159
integer.
160160

161-
## TTY keybindings
162-
163-
<table>
164-
<tr>
165-
<th>Keybindings</th>
166-
<th>Description</th>
167-
</tr>
168-
<tr>
169-
<td><code>ctrl+shift+backspace</code></td>
170-
<td>delete line left</td>
171-
</tr>
172-
<tr>
173-
<td><code>ctrl+shift+delete</code></td>
174-
<td>delete line right</td>
175-
</tr>
176-
<tr>
177-
<td><code>ctrl+c</code></td>
178-
<td>emits SIGINT</td>
179-
</tr>
180-
<tr>
181-
<td><code>ctrl+h</code></td>
182-
<td>delete left</td>
183-
</tr>
184-
<tr>
185-
<td><code>ctrl+d</code></td>
186-
<td>delete right or EOF</td>
187-
</tr>
188-
<tr>
189-
<td><code>ctrl+u</code></td>
190-
<td>delete from current to line start</td>
191-
</tr>
192-
<tr>
193-
<td><code>ctrl+k</code></td>
194-
<td>delete from current to end of line</td>
195-
</tr>
196-
<tr>
197-
<td><code>ctrl+a</code></td>
198-
<td>goto start of line</td>
199-
</tr>
200-
<tr>
201-
<td><code>ctrl+e</code></td>
202-
<td>goto to end of line</td>
203-
</tr>
204-
<tr>
205-
<td><code>ctrl+b</code></td>
206-
<td>back one character</td>
207-
</tr>
208-
<tr>
209-
<td><code>ctrl+f</code></td>
210-
<td>forward one character</td>
211-
</tr>
212-
<tr>
213-
<td><code>ctrl+l</code></td>
214-
<td>clear screen </td>
215-
</tr>
216-
<tr>
217-
<td><code>ctrl+n</code></td>
218-
<td>next history item</td>
219-
</tr>
220-
<tr>
221-
<td><code>ctrl+p</code></td>
222-
<td>prev history item </td>
223-
</tr>
224-
<tr>
225-
<td><code>ctrl+z</code></td>
226-
<td>(need clarification)</td>
227-
</tr>
228-
<tr>
229-
<td><code>ctrl+w</code> or <code>ctrl+backspace</code></td>
230-
<td>delete backwards to a word boundary</td>
231-
</tr>
232-
<tr>
233-
<td><code>ctrl+delete</code></td>
234-
<td>delete forward to a word boundary</td>
235-
</tr>
236-
<tr>
237-
<td><code>ctrl+left</code></td>
238-
<td>word left </td>
239-
</tr>
240-
<tr>
241-
<td><code>ctrl+right</code></td>
242-
<td>word right</td>
243-
</tr>
244-
<tr>
245-
<td><code>meta+b</code></td>
246-
<td>word left</td>
247-
</tr>
248-
<tr>
249-
<td><code>meta+f</code></td>
250-
<td>word right</td>
251-
</tr>
252-
<tr>
253-
<td><code>meta+d</code> or <code>meta+delete</code></td>
254-
<td>delete word right</td>
255-
</tr>
256-
<tr>
257-
<td><code>meta+backspace</code></td>
258-
<td>delete word left </td>
259-
</tr>
260-
</table>
261-
262161
[`net.Socket`]: net.html#net_class_net_socket
263162
[`process.stdin`]: process.html#process_process_stdin
264163
[`process.stdout`]: process.html#process_process_stdout
265-
[`process.stderr`]: process.html#process_process_stderr
266-
[`TTY keybindings`]: #tty_tty_keybindings
164+
[`process.stderr`]: process.html#process_process_stderr

0 commit comments

Comments
 (0)