summaryrefslogtreecommitdiff
path: root/plugins/sudo
diff options
context:
space:
mode:
authorMarc Cornellà <hello@mcornella.com>2021-12-29 16:26:35 +0100
committerMarc Cornellà <hello@mcornella.com>2021-12-29 16:26:35 +0100
commit8b53d0494241fe044e44e24515f7c6293717557e (patch)
tree1759023bb2557ca590c50a5579ede02d530654c6 /plugins/sudo
parent8b231f2aa752238bd8624822df7034a1b9d1188e (diff)
downloadzsh-8b53d0494241fe044e44e24515f7c6293717557e.tar.gz
zsh-8b53d0494241fe044e44e24515f7c6293717557e.tar.bz2
zsh-8b53d0494241fe044e44e24515f7c6293717557e.zip
docs(sudo): document key binding change
Diffstat (limited to 'plugins/sudo')
-rw-r--r--plugins/sudo/README.md16
1 files changed, 15 insertions, 1 deletions
diff --git a/plugins/sudo/README.md b/plugins/sudo/README.md
index 4f3973ef8..012fc5325 100644
--- a/plugins/sudo/README.md
+++ b/plugins/sudo/README.md
@@ -1,6 +1,6 @@
# sudo
-Easily prefix your current or previous commands with `sudo` by pressing <kbd>esc</kbd> twice
+Easily prefix your current or previous commands with `sudo` by pressing <kbd>esc</kbd> twice.
To use it, add `sudo` to the plugins array in your zshrc file:
@@ -43,3 +43,17 @@ $ sudo rm some-system-file.txt
Password:
$
```
+
+## Key binding
+
+By default, the `sudo` plugin uses <kbd>Esc</kbd><kbd>Esc</kbd> as the trigger.
+If you want to change it, you can use the `bindkey` command to bind it to a different key:
+
+```sh
+bindkey -M emacs '<seq>' sudo-command-line
+bindkey -M vicmd '<seq>' sudo-command-line
+bindkey -M viins '<seq>' sudo-command-line
+```
+
+where `<seq>` is the sequence you want to use. You can find the keyboard sequence
+by running `cat` and pressing the keyboard combination you want to use.