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.

Sign up for GitHub

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

Jump to bottom

doc: add doc for tty writes ( readline.js / REPL ) #20814

Closed
shobhitchittora opened this issue May 18, 2018 · 2 comments
Closed

doc: add doc for tty writes ( readline.js / REPL ) #20814

shobhitchittora opened this issue May 18, 2018 · 2 comments
Labels
doc Issues and PRs related to the documentations. readline Issues and PRs related to the built-in readline module. repl Issues and PRs related to the REPL subsystem. tty Issues and PRs related to the tty subsystem.

Comments

@shobhitchittora
Copy link
Contributor

The readline interface is missing the keybindings docs for possible input to tty. Attaching a list of possible bindings to be added to the doc.

KeyBindings Description
ctrl+shift+backspace delete line left
ctrl+shift+delete delete line right
ctrl+c emits SIGINT
ctrl+h delete left
ctrl+d delete right or EOF
ctrl+u delete from current to line start
ctrl+k delete from current to end of line
ctrl+a goto start of line
ctrl+e goto to end of line
ctrl+b back one character
ctrl+f forward one character
ctrl+l clear screen
ctrl+n next history item
ctrl+p prev history item
ctrl+z (need clarification)
ctrl+w or ctrl+backspace delete backwards to a word boundary
ctrl+delete delete forward to a word boundary
ctrl+left word left
ctrl+right word right
meta+b word left
meta+f word right
meta+d or meta+delete delete word right
meta+backspace delete word left
@shobhitchittora shobhitchittora mentioned this issue May 18, 2018
Closed
2 tasks
@shobhitchittora shobhitchittora changed the title doc: add doc for tty writes ( readline.js ) doc: add doc for tty writes ( readline.js / REPL ) May 18, 2018
@shobhitchittora
Copy link
Contributor Author

@BridgeAR can you suggest the correct place to add these bindings. Are these to be added to REPL doc or readline doc. Also for now I just took the Description from the comments in the code, probably a better description is in order. Can you add the concerned group to help with this?

Thanks. 😇

shobhitchittora added a commit to shobhitchittora/node that referenced this issue May 18, 2018
@shobhitchittora
doc: adds handeled tty write keybindings
13ecfa3 
Closes: nodejs#20814
@shobhitchittora shobhitchittora mentioned this issue May 18, 2018
Closed
4 tasks
@BridgeAR BridgeAR added doc Issues and PRs related to the documentations. readline Issues and PRs related to the built-in readline module. repl Issues and PRs related to the REPL subsystem. tty Issues and PRs related to the tty subsystem. labels May 19, 2018
shobhitchittora added a commit to shobhitchittora/node that referenced this issue May 21, 2018
@shobhitchittora
doc: add the keybindings to readline doc. Also -
60165b7 
1. Adds ref in repl doc
2. Removes ref from tty doc

Closes: nodejs#20814
shobhitchittora added a commit to shobhitchittora/node that referenced this issue May 24, 2018
@shobhitchittora
doc: fixes as per review comments
c39f8b6 
1. typo fix
2. adding new lines

Closes: nodejs#20814
shobhitchittora added a commit to shobhitchittora/node that referenced this issue May 24, 2018
@shobhitchittora
doc: highlighting code + capital case description
2faec19 
refs: nodejs#20814
shobhitchittora added a commit to shobhitchittora/node that referenced this issue May 24, 2018
@shobhitchittora
doc: fixes typo
e3d38dd 
refs: nodejs#20814
shobhitchittora added a commit to shobhitchittora/node that referenced this issue May 26, 2018
@shobhitchittora
doc: adds description for ctrl+z
76d462c 
refs: nodejs#20814
shobhitchittora added a commit to shobhitchittora/node that referenced this issue May 27, 2018
@shobhitchittora
doc: fixes line warnings + removes nbsp;
67e3d92 
refs: nodejs#20814
@HarshithaKP
Copy link
Member

I would like to work on this.

HarshithaKP added a commit to HarshithaKP/node that referenced this issue Jan 8, 2020
@HarshithaKP
doc: document readline keybindings
0de07fc 
This is a rework of closed pr nodejs#20825
fixes: nodejs#20814
@HarshithaKP HarshithaKP mentioned this issue Jan 8, 2020
Closed
4 tasks
MylesBorins pushed a commit that referenced this issue Jan 16, 2020
@HarshithaKP @MylesBorins
doc: document readline key bindings
b9aca78 
This documents all readline key bindings. It is a rework of
#20825

PR-URL: #31256
Fixes: #20814
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
codebytere pushed a commit that referenced this issue Mar 14, 2020
@HarshithaKP @codebytere
doc: document readline key bindings
c72fff6 
This documents all readline key bindings. It is a rework of
#20825

PR-URL: #31256
Fixes: #20814
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
targos pushed a commit to targos/node that referenced this issue Apr 25, 2020
@HarshithaKP @targos
doc: document readline key bindings
cc9fa9f 
This documents all readline key bindings. It is a rework of
nodejs#20825

PR-URL: nodejs#31256
Fixes: nodejs#20814
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
targos pushed a commit that referenced this issue Apr 28, 2020
@HarshithaKP @targos
doc: document readline key bindings
1d2565b 
This documents all readline key bindings. It is a rework of
#20825

PR-URL: #31256
Fixes: #20814
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. readline Issues and PRs related to the built-in readline module. repl Issues and PRs related to the REPL subsystem. tty Issues and PRs related to the tty subsystem.
Projects
None yet
Milestone
No milestone
3 participants
@shobhitchittora @BridgeAR @HarshithaKP