From 6a4ff8b825ab264835f8e4db72b4659b076fdecb Mon Sep 17 00:00:00 2001
From: Arun Prakash Jana <engineerarun@gmail.com>
Date: Mon, 17 Aug 2020 14:05:15 +0530
Subject: [PATCH] Update docs
---
README.md | 6 ++++--
nnn.1 | 3 +++
plugins/README.md | 30 ++++++++++++++++--------------
3 files changed, 23 insertions(+), 16 deletions(-)
diff --git a/README.md b/README.md
index e414f71..56b1632 100644
--- a/README.md
+++ b/README.md
@@ -101,8 +101,10 @@ It runs smoothly on the Pi, [Termux](https://www.youtube.com/watch?v=AbaauM7gUJw
- By name, access/change/mod (default) time, size, extn
- Reverse sort
- Mimes
- - Open with desktop opener or specify a custom opener
- Preview hovered files in FIFO-based previewer
+ - Open with desktop opener or specify a custom opener
+ - File-specific colors (or minimal _dirs in context color_)
+ - Icons (can be compiled-in using relevant make option)
- Plugins for image and video thumbnails
- Create, list, extract, mount (FUSE based) archives
- Option to open all text files in EDITOR
@@ -129,7 +131,7 @@ It runs smoothly on the Pi, [Termux](https://www.youtube.com/watch?v=AbaauM7gUJw
1. [Install](https://github.com/jarun/nnn/wiki/Usage#installation) `nnn` and deps (if you need any). All files are opened with the desktop opener by default.
2. Add option `-e` to your alias to open text files in `$VISUAL`/`$EDITOR`/ vi. [Open detached](https://github.com/jarun/nnn/wiki/Basic-use-cases#detached-text) if you wish.
3. Configure [cd on quit](https://github.com/jarun/nnn/wiki/Basic-use-cases#configure-cd-on-quit).
-4. [Install plugins](https://github.com/jarun/nnn/tree/master/plugins#installing-plugins).
+4. [Install plugins](https://github.com/jarun/nnn/tree/master/plugins#installation).
5. Use option `-x` to copy selected file paths to system clipboard and show notis on cp, mv, rm completion.
6. For a CLI-only environment, customize and use plugin [`nuke`](https://github.com/jarun/nnn/blob/master/plugins/nuke) with option `-c` (overrides `-e`).
diff --git a/nnn.1 b/nnn.1
index 0725a02..d7043b8 100644
--- a/nnn.1
+++ b/nnn.1
@@ -380,6 +380,9 @@ separated by \fI;\fR:
.Bd -literal
export NNN_PLUG='x:_chmod +x $nnn;g:_git log;s:_smplayer $nnn'
+ To pick and run an unassigned plugin, press \fBEnter\fR at the plugin prompt.
+ To run a plugin at startup, use the option `-P` followed by the plugin key.
+
NOTES:
1. Use single quotes for $NNN_PLUG so $nnn is not interpreted
2. $nnn should be the last argument (IF used)
diff --git a/plugins/README.md b/plugins/README.md
index fbc8628..360d91f 100644
--- a/plugins/README.md
+++ b/plugins/README.md
@@ -12,16 +12,6 @@ Plugins extend the capabilities of `nnn`. They are _executable_ scripts (or bina
`nnn` is _**language-agnostic**_ when it comes to plugins. You can write a plugin in any (scripting) language you are comfortable in!
-## Installing plugins
-
-The following command installs or updates (after backup) all plugins:
-
-```sh
-curl -Ls https://raw.githubusercontent.com/jarun/nnn/master/plugins/getplugs | sh
-```
-
-Plugins are installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`.
-
## List of plugins
| Plugin (a-z) | Description | Lang | Dependencies |
@@ -78,19 +68,31 @@ Plugins are installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`.
| [wall](wall) | Set wallpaper or change colorscheme | sh | nitrogen/pywal |
| [x2sel](x2sel) | Copy `\n`-separated file list from system clipboard to sel | sh | _see in-file docs_ |
-## Invoking a plugin
+## Installation
-Press the plugin shortcut (<kbd>;</kbd>) followed by the assigned key character. E.g., with the below config:
+The following command installs or updates (after backup) all plugins:
+
+```sh
+curl -Ls https://raw.githubusercontent.com/jarun/nnn/master/plugins/getplugs | sh
+```
+
+Plugins are installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`.
+
+## Configuration
+
+Set environment variable `NNN_PLUG` to assign keybinds and invoke plugins directly using the plugin shortcut (<kbd>;</kbd>) followed by the assigned key character. E.g., with the below config:
```sh
export NNN_PLUG='f:finder;o:fzopen;p:mocplay;d:diffs;t:nmount;v:imgview'
```
-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.
+plugin `finder` can be invoked 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.
Alternatively, combine with <kbd>Alt</kbd> (i.e. <kbd>Alt+key</kbd>).
-To select and invoke a plugin from the plugin directory, press <kbd>Enter</kbd> (to _enter_ the plugin dir) after the plugin shortcut.
+To pick and run an unassigned plugin, press <kbd>Enter</kbd> (to _enter_ the plugin dir) at the plugin prompt.
+
+To run a plugin at startup, use the option `-P` followed by the plugin key.
#### Skip directory refresh after running a plugin