Skip to content

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

Closed
Closed
doc: add doc for tty writes ( readline.js / REPL )#20814
Labels
docIssues and PRs related to Node.js documentation.readlineIssues and PRs related to the built-in readline module.replIssues and PRs related to the REPL subsystem.ttyIssues and PRs related to the tty subsystem.

Description

@shobhitchittora
shobhitchittora
opened on May 18, 2018

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

Activity

  1. shobhitchittora
    changed the title [-]doc: add doc for tty writes ( readline.js )[/-] [+]doc: add doc for tty writes ( readline.js / REPL )[/+] on May 18, 2018

  2. shobhitchittora commented on May 18, 2018

    @shobhitchittora
    shobhitchittora
    on May 18, 2018
    ContributorAuthor

    @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. 😇

  3. shobhitchittora
    added a commit that references this issue on May 18, 2018

    doc: adds handeled tty write keybindings

    13ecfa3
  4. BridgeAR
    added
    docIssues and PRs related to Node.js documentation.
    readlineIssues and PRs related to the built-in readline module.
    replIssues and PRs related to the REPL subsystem.
    ttyIssues and PRs related to the tty subsystem.
    on May 19, 2018
  5. shobhitchittora
    added 6 commits that reference this issue on May 21, 2018

    doc: add the keybindings to readline doc. Also -

    60165b7

    doc: fixes as per review comments

    c39f8b6

    doc: highlighting code + capital case description

    2faec19

    doc: fixes typo

    e3d38dd

    doc: adds description for ctrl+z

    76d462c

    doc: fixes line warnings + removes nbsp;

    67e3d92

  6. HarshithaKP commented on Jan 3, 2020

    @HarshithaKP
    HarshithaKP
    on Jan 3, 2020
    Member

    I would like to work on this.

  7. HarshithaKP
    added a commit that references this issue on Jan 8, 2020

    doc: document readline keybindings

    0de07fc
  8. BridgeAR
    closed this as completedin 027eaacon Jan 13, 2020
  9. MylesBorins
    added a commit that references this issue on Jan 16, 2020

    doc: document readline key bindings

    b9aca78
  10. codebytere
    added a commit that references this issue on Mar 14, 2020

    doc: document readline key bindings

    c72fff6
  11. sjarmak
    added a commit that references this issue on Jul 27, 2026

    doc: document readline key bindings

    027eaac
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to Node.js documentation.readlineIssues and PRs related to the built-in readline module.replIssues and PRs related to the REPL subsystem.ttyIssues and PRs related to the tty subsystem.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions