aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Arun Prakash Jana <engineerarun@gmail.com>2020-02-20 00:57:14 +0530
committerGravatar Arun Prakash Jana <engineerarun@gmail.com>2020-02-20 00:59:06 +0530
commitf7f53bbd6b422b0adcaab7a62834d5dbd54b54d8 (patch)
tree6e922754354d0fdc2f5b5b8822713c6b92d6c586
parentf6e814e364cb42c724d062350d3847013e64def3 (diff)
downloadnnn-f7f53bbd6b422b0adcaab7a62834d5dbd54b54d8.tar.gz
Update docs
-rw-r--r--README.md6
-rw-r--r--plugins/README.md24
2 files changed, 22 insertions, 8 deletions
diff --git a/README.md b/README.md
index ffc99b2..430327c 100644
--- a/README.md
+++ b/README.md
@@ -149,8 +149,10 @@ Packages for Arch Linux, CentOS, Debian, Fedora and Ubuntu are auto-generated wi
Download the latest stable release or clone this repository (*risky*), install deps and compile. On Ubuntu 18.04:
- $ sudo apt-get install pkg-config libncursesw5-dev libreadline-dev
- $ sudo make strip install
+```sh
+sudo apt-get install pkg-config libncursesw5-dev libreadline-dev
+sudo make strip install
+```
`PREFIX` is supported, in case you want to install to a different location.
diff --git a/plugins/README.md b/plugins/README.md
index b8666e6..8909c4a 100644
--- a/plugins/README.md
+++ b/plugins/README.md
@@ -16,7 +16,9 @@ Plugins extend the capabilities of `nnn`. They are _executable_ scripts (or bina
The following command installs or updates (after backup) all plugins:
- curl -Ls https://raw.githubusercontent.com/jarun/nnn/master/plugins/getplugs | sh
+```sh
+curl -Ls https://raw.githubusercontent.com/jarun/nnn/master/plugins/getplugs | sh
+```
Plugins are installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`.
@@ -69,7 +71,9 @@ Plugins are installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`.
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:
- export NNN_PLUG='o:fzopen;p:mocplay;d:diffs;m:nmount;n:notes;v:imgviu;t:imgthumb'
+```sh
+export NNN_PLUG='o:fzopen;p:mocplay;d:diffs;m:nmount;n:notes;v:imgviu;t:imgthumb'
+```
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.
@@ -79,7 +83,9 @@ A maximum of 15 keys can be defined. To select and invoke a plugin from the plug
`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'
+```sh
+export NNN_PLUG='m:-mediainfo'
+```
Now `nnn` will not refresh the directory after running the `mediainfo` plugin.
@@ -89,7 +95,9 @@ To assign keys to arbitrary non-background, non-shell-interpreted cli commands a
For example:
- export NNN_PLUG='x:_chmod +x $nnn;g:_git log;s:_smplayer $nnn;o:fzopen'
+```sh
+export NNN_PLUG='x:_chmod +x $nnn;g:_git log;s:_smplayer $nnn;o:fzopen'
+```
Now <kbd>;x</kbd> can be used to make a file executable, <kbd>;g</kbd> can be used to the git log of a git project directory, <kbd>;s</kbd> can be used to preview a partially downloaded media file.
@@ -97,7 +105,9 @@ Now <kbd>;x</kbd> can be used to make a file executable, <kbd>;g</kbd> can be us
`nnn` waits for user confirmation (the prompt `Press Enter to continue`) after it executes a command as plugin (unlike plugins which can add a `read` to wait). To skip this, add a `*` after the command. For example:
- export NNN_PLUG='s:_smplayer $nnn*;n:-_vim /home/vaio/Dropbox/Public/synced_note*'
+```sh
+export NNN_PLUG='s:_smplayer $nnn*;n:-_vim /home/vaio/Dropbox/Public/synced_note*'
+```
Now there will be no prompt after <kbd>;s</kbd> and <kbd>;n</kbd>.
@@ -105,7 +115,9 @@ Now there will be no prompt after <kbd>;s</kbd> and <kbd>;n</kbd>.
To run a GUI app as plugin, add a `|` after `_`. For example:
- export NNN_PLUG='m:-_|mousepad $nnn'
+```sh
+export NNN_PLUG='m:-_|mousepad $nnn'
+```
Notes: