aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/README.md
diff options
context:
space:
mode:
authorGravatar Arun Prakash Jana <engineerarun@gmail.com>2020-05-05 23:09:24 +0530
committerGravatar Arun Prakash Jana <engineerarun@gmail.com>2020-05-05 23:09:24 +0530
commita563c1a5539ea2187d087b34240cd31ad6a217f5 (patch)
tree9ca83a3ff7f1b1082c6a5f200301c6b5cfa39de8 /plugins/README.md
parent65da1c19413008eedcd228bb9cbda416ca269aae (diff)
downloadnnn-a563c1a5539ea2187d087b34240cd31ad6a217f5.tar.gz
Update docs
Diffstat (limited to 'plugins/README.md')
-rw-r--r--plugins/README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/plugins/README.md b/plugins/README.md
index 3ea9949..22083f1 100644
--- a/plugins/README.md
+++ b/plugins/README.md
@@ -8,7 +8,7 @@
## Introduction
-Plugins extend the capabilities of `nnn`. They are _executable_ scripts (or binaries) which `nnn` can communicate with and trigger. This mechanism fits perfectly with the fundamental design to keep the core file manager lean and fast, by delegating repetitive (but not necessarily file manager-specific) tasks to the plugins.
+Plugins extend the capabilities of `nnn`. They are _executable_ scripts (or binaries) `nnn` can communicate with and trigger. This mechanism fits perfectly with the fundamental design to keep the core file manager lean and fast, by delegating repetitive (but not necessarily file manager-specific) tasks to the plugins which can be run with custom hotkeys.
`nnn` is _**language-agnostic**_ when it comes to plugins. You can write a plugin in any (scripting) language you are comfortable in!
@@ -75,13 +75,13 @@ Plugins are installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`.
## Invoking a plugin
-Use the plugin shortcut (<kbd>;key</kbd> or <kbd>^Skey</kbd>) to list the defined plugin keys and press the required key. E.g., with the below config:
+Press the plugin shortcut (<kbd>;</kbd> or <kbd>^S</kbd>) followed by the assigned key. E.g., with the below config:
```sh
export NNN_PLUG='f:finder;o:fzopen;p:mocplay;d:diffs;t:nmount;v:imgview'
```
-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 `finder` can be run with the keybind <kbd>;f</kbd>, `fzopen` can be run with <kbd>;o</kbd> and so on... The key vs. plugin pairs are shown in the help and config screen.
To select and invoke a plugin from the plugin directory, press <kbd>Enter</kbd> (to _enter_ the plugin dir) after the plugin shortcut.