Commit 94ce46d4 authored by Marc Cornellà's avatar Marc Cornellà
Browse files

docs(vi-mode): revamp README and document settings

parent 66e0438d
vi-mode # vi-mode plugin
=======
This plugin increase `vi-like` zsh functionality. This plugin increase `vi-like` zsh functionality.
Use `ESC` or `CTRL-[` to enter `Normal mode`. To use it, add `vi-mode` to the plugins array in your zshrc file:
```zsh
plugins=(... vi-mode)
```
History ## Settings
-------
- `ctrl-p` : Previous command in history - `VI_MODE_RESET_PROMPT_ON_MODE_CHANGE`: controls whether the prompt is redrawn when
- `ctrl-n` : Next command in history switching to a different input mode. If this is unset, the mode indicator will not
- `/` : Search backward in history be updated when changing to a different mode.
- `n` : Repeat the last `/` Set it to `true` to enable it. For example:
```zsh
VI_MODE_RESET_PROMPT_ON_MODE_CHANGE=true
```
Mode indicators The default value is unset, unless `vi_mode_prompt_info` is used, in which case it'll
--------------- automatically be set to `true`.
*Normal mode* is indicated with red `<<<` mark at the right prompt, when it - `MODE_INDICATOR`: controls the string displayed when the shell is in normal mode.
wasn't defined by theme. See [Mode indicator](#mode-indicator) for details.
## Mode indicator
Vim edition *Normal mode* is indicated with a red `<<<` mark at the right prompt, when it
----------- hasn't been defined by theme.
- `v` : Edit current command line in Vim You can change this indicator by setting the `MODE_INDICATOR` variable. This setting
supports Prompt Expansion sequences. For example:
```zsh
MODE_INDICATOR="%F{yellow}+%f"
```
You can also use the `vi_mode_prompt_info` function in your prompt, which will display
this mode indicator.
## Key bindings
Use `ESC` or `CTRL-[` to enter `Normal mode`.
NOTE: some of these key bindings are set by zsh by default when using a vi-mode keymap.
Movement ### History
--------
- `ctrl-p` : Previous command in history
- `ctrl-n` : Next command in history
- `/` : Search backward in history
- `n` : Repeat the last `/`
### Movement
- `$` : To the end of the line - `$` : To the end of the line
- `^` : To the first non-blank character of the line - `^` : To the first non-blank character of the line
...@@ -46,9 +71,7 @@ Movement ...@@ -46,9 +71,7 @@ Movement
- `;` : Repeat latest f, t, F or T [count] times - `;` : Repeat latest f, t, F or T [count] times
- `,` : Repeat latest f, t, F or T in opposite direction - `,` : Repeat latest f, t, F or T in opposite direction
### Insertion
Insertion
---------
- `i` : Insert text before the cursor - `i` : Insert text before the cursor
- `I` : Insert text before the first character in the line - `I` : Insert text before the first character in the line
...@@ -57,9 +80,7 @@ Insertion ...@@ -57,9 +80,7 @@ Insertion
- `o` : Insert new command line below the current one - `o` : Insert new command line below the current one
- `O` : Insert new command line above the current one - `O` : Insert new command line above the current one
### Delete and Insert
Delete and Insert
-----------------
- `ctrl-h` : While in *Insert mode*: delete character before the cursor - `ctrl-h` : While in *Insert mode*: delete character before the cursor
- `ctrl-w` : While in *Insert mode*: delete word before the cursor - `ctrl-w` : While in *Insert mode*: delete word before the cursor
...@@ -73,3 +94,7 @@ Delete and Insert ...@@ -73,3 +94,7 @@ Delete and Insert
- `R` : Enter replace mode: Each character replaces existing one - `R` : Enter replace mode: Each character replaces existing one
- `x` : Delete [count] characters under and after the cursor - `x` : Delete [count] characters under and after the cursor
- `X` : Delete [count] characters before the cursor - `X` : Delete [count] characters before the cursor
### Removed key bindings
- `v` : Edit current command line in Vim
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment