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

document interactive key bindings #1719

Open
eMBee opened this issue Aug 25, 2023 · 2 comments
Open

document interactive key bindings #1719

eMBee opened this issue Aug 25, 2023 · 2 comments

Comments

@eMBee
Copy link

eMBee commented Aug 25, 2023

i was very confused that some well known key bindings from other shells are not working.

that led me to a search to find that the default keybindings are not documented yet:

https://elv.sh/learn/fundamentals.html#editing-the-command-line

just says TODO.

i am creating this issue to track that so that it eventually may get fixed.

in addition to filling out that TODO i would also propose that the quick tour starts with a brief section about interactive editing that links to the above editing section in fundamentals, but also explains how to activate readline-bindings or vim command mode for those who want them.

@dxlr8r
Copy link

dxlr8r commented Sep 17, 2023

As an interactive shell, keybindings is very important to any user looking to use elvish as an interactive shell.

@krader1961
Copy link
Contributor

Note that documenting the key bindings is complicated because many depend on the current "mode"; e.g., are we in "insert", "location", "history", or some other mode. Which is not to imply the default bindings shouldn't be documented. At a minimum the documentation should explain how to use introspection to determine the current bindings. For example, pprint $edit:insert:binding.

i was very confused that some well known key bindings from other shells are not working.

I know it has been several months since you opened this issue, @eMBee, but do you recall which key bindings did not work as you expected? It is possible that adding use readline-binding to your ~/.config/elvish/rc.elv would provide the bindings you expected.

krader1961 added a commit to krader1961/elvish that referenced this issue Jan 16, 2024
The primary purpose of this change is to fix a broken link to the
readline binding source. A secondary purpose is a baby step to
addressing issue elves#1719.

Related elves#1719
xiaq pushed a commit that referenced this issue Jan 23, 2024
The primary purpose of this change is to fix a broken link to the
readline binding source. A secondary purpose is a baby step to
addressing issue #1719.

Related #1719
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants