extern/ohmyzsh
1
0
Fork 1
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-26 01:33:40 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs(vi-mode): document $KEYTIMEOUT issue (#9588)

Browse Source 
Closes #9588
This commit is contained in:
Marc Cornellà 2021-09-27 11:46:42 +02:00
parent 2ea1fa6cbf
commit 93ad3a8821
No known key found for this signature in database
GPG Key ID: 0314585E776A9C1B
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
plugins/vi-mode/README.md
View File

@ -64,7 +64,7 @@ NOTE: some of these key bindings are set by zsh by default when using a vi-mode
- `vv` : Edit current command line in Vim
NOTE: this used to be bound to `v`. That is now the default (`visual-mode`)
NOTE: this used to be bound to `v`. That is now the default (`visual-mode`).
### Movement
@ -107,3 +107,21 @@ NOTE: this used to be bound to `v`. That is now the default (`visual-mode`)
- `R` : Enter replace mode: Each character replaces existing one
- `x` : Delete `count` characters under and after the cursor
- `X` : Delete `count` characters before the cursor
## Known issues
### Low `$KEYTIMEOUT`
A low `$KEYTIMEOUT` value (< 15) means that key bindings that need multiple characters,
like `vv`, will be very difficult to trigger. `$KEYTIMEOUT` controls the number of
milliseconds that must pass before a key press is read and the appropriate key binding
is triggered. For multi-character key bindings, the key presses need to happen before
the timeout is reached, so on low timeouts the key press happens too slow, and therefore
another key binding is triggered.
We recommend either setting `$KEYTIMEOUT` to a higher value, or remapping the key bindings
that you want to trigger to a keyboard sequence. For example:
```zsh
bindkey -M vicmd 'V' edit-command-line # this remaps `vv` to `V` (but overrides `visual-mode`)
```