From a563c1a5539ea2187d087b34240cd31ad6a217f5 Mon Sep 17 00:00:00 2001 From: Arun Prakash Jana Date: Tue, 5 May 2020 23:09:24 +0530 Subject: [PATCH] Update docs --- README.md | 2 +- nnn.1 | 2 +- plugins/README.md | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 28b7a4e9..19a6c3fe 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ `nnn` (or `n³`) is a full-featured terminal file manager. It's tiny and nearly 0-config with an [incredible performance](https://github.com/jarun/nnn/wiki/Performance). -`nnn` can analyze disk usage, batch rename, launch apps and pick files. The [plugin repository](https://github.com/jarun/nnn/tree/master/plugins#nnn-plugins) has tons of plugins and documentation to extend the capabilities further. You can _plug_ new functionality _and play_ with a hotkey. There's an independent [(neo)vim plugin](https://github.com/mcchrish/nnn.vim). +`nnn` can analyze disk usage, batch rename, launch apps and pick files. The [plugin repository](https://github.com/jarun/nnn/tree/master/plugins#nnn-plugins) has tons of plugins and documentation to extend the capabilities further. There's an independent [(neo)vim plugin](https://github.com/mcchrish/nnn.vim). It runs smoothly on the Pi, [Termux](https://www.youtube.com/watch?v=AbaauM7gUJw) (Android), Linux, macOS, BSD, Haiku, Cygwin, WSL, across DEs and GUI utilities or a strictly CLI environment. diff --git a/nnn.1 b/nnn.1 index fe7e0a59..0f37ef8f 100644 --- a/nnn.1 +++ b/nnn.1 @@ -328,7 +328,7 @@ separated by \fI;\fR: export NNN_BMS='d:~/Documents;u:/home/user/Cam Uploads;D:~/Downloads/' .Ed .Pp -\fBNNN_PLUG:\fR directly executable plugins as \fIkey_char:location\fR pairs +\fBNNN_PLUG:\fR directly executable plugins as \fIkey_char:plugin\fR pairs separated by \fI;\fR: .Bd -literal export NNN_PLUG='f:finder;o:fzopen;p:mocplay;d:diffs;t:nmount;v:imgview' diff --git a/plugins/README.md b/plugins/README.md index 3ea9949a..22083f1f 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 (;key or ^Skey) to list the defined plugin keys and press the required key. E.g., with the below config: +Press the plugin shortcut (; or ^S) 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 ;o, `mocplay` can be run with ;p and so on... The key vs. plugin pairs are shown in the help and config screen. +Plugin `finder` can be run with the keybind ;f, `fzopen` can be run with ;o 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 Enter (to _enter_ the plugin dir) after the plugin shortcut.