aboutsummaryrefslogtreecommitdiffstats
path: root/plugins
diff options
context:
space:
mode:
authorGravatar Arun Prakash Jana <engineerarun@gmail.com>2020-01-13 21:09:40 +0530
committerGravatar Arun Prakash Jana <engineerarun@gmail.com>2020-01-13 21:09:40 +0530
commit526330bb8b48c0139c09c8a08410e72500977900 (patch)
tree4efe04e196604a31c7136962bb89389f4c7f414b /plugins
parentc53b9df5ea5e1cb4623bad6094a8d83dc4f55d91 (diff)
downloadnnn-526330bb8b48c0139c09c8a08410e72500977900.tar.gz
Unify plugin keys
Diffstat (limited to 'plugins')
-rw-r--r--plugins/README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/plugins/README.md b/plugins/README.md
index 853c5d7..3268c38 100644
--- a/plugins/README.md
+++ b/plugins/README.md
@@ -63,19 +63,19 @@ Plugins are installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`.
| vidthumb | Show video thumbnails in terminal | sh | [ffmpegthumbnailer](https://github.com/dirkvdb/ffmpegthumbnailer),<br>[lsix](https://github.com/hackerb9/lsix) |
| wall | Set wallpaper or change colorscheme | sh | nitrogen/pywal |
-## Ways to invoke a plugin
+## Invoking a plugin
-1. Fire directly with <kbd>;key</kbd> or <kbd>^Fkey</kbd>:
+Use the plugin shortcut (<kbd>;key</kbd> or <kbd>;key</kbd>) to list the defined plugin keys and press the required key. E.g., with the below config:
- export NNN_PLUG='o:fzopen;p:mocplay;d:diffs;m:nmount;n:notes;v:imgviu;t:imgthumb'
+ export NNN_PLUG='o:fzopen;p:mocplay;d:diffs;m:nmount;n:notes;v:imgviu;t:imgthumb'
- Now plugin `fzopen` can be run with the keybind <kbd>;o</kbd>, `mocplay` can be run with <kbd>;p</kbd> and so on... The key vs. plugin pairs are shown in the help and config screen.
+ Plugin `fzopen` can be run with the keybind <kbd>;o</kbd>, `mocplay` can be run with <kbd>;p</kbd> and so on... The key vs. plugin pairs are shown in the help and config screen.
-2. Use the _pick plugin_ keybind to visit the plugin directory, select and run a plugin. Repeat the keybind to cancel and return to the original directory.
+A maximum of 15 keys can be defined. To select and invoke a plugin from the plugin directory, press <kbd>Enter</kbd> (to _enter_ the plugin dir) after the plugin shortcut.
#### Skip directory refresh after running a plugin
-`nnn` refreshes a directory after running a plugin by key (method 1 above) to reflect any changes by the plugin. To disable this (say while running the `mediainfo` plugin on some filtered files), add a `-` before the plugin name:
+`nnn` refreshes the directory after running a plugin to reflect any changes by the plugin. To disable this (say while running the `mediainfo` plugin on some filtered files), add a `-` before the plugin name:
export NNN_PLUG='m:-mediainfo'