diff options
| author |  Arun Prakash Jana <engineerarun@gmail.com> | 2019-11-16 11:26:19 +0530 |
|---|---|---|
| committer | Arun Prakash Jana <engineerarun@gmail.com> | 2019-11-16 11:43:38 +0530 |
| commit | f8b8c67bee7eab2af9869283456b80de193eb5cb (patch) | |
| tree | 242ac6f708c20904074f911d429187fce65d929f | |
| parent | cf987fa9885127bccc5da0750584bca0f49d684e (diff) | |
| download | nnn-f8b8c67bee7eab2af9869283456b80de193eb5cb.tar.gz | |
Update docs
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | plugins/README.md | 18 |
2 files changed, 13 insertions, 7 deletions
@@ -16,7 +16,7 @@ `nnn` is a full-featured terminal file manager. It's tiny, [extremely light and fast](https://github.com/jarun/nnn/wiki/Performance). -`nnn` is also a disk usage analyzer, a fuzzy app launcher, a batch file renamer and a file picker. The [plugin repository](https://github.com/jarun/nnn/tree/master/plugins#nnn-plugins) has 30+ plugins to extend the capabilities further. There's an independent [(neo)vim plugin](https://github.com/mcchrish/nnn.vim). +`nnn` is also a disk usage analyzer, a fuzzy app launcher, a batch file renamer and a file picker. The [plugin repository](https://github.com/jarun/nnn/tree/master/plugins#nnn-plugins) has tons of plugins to extend the capabilities further. There's an independent [(neo)vim plugin](https://github.com/mcchrish/nnn.vim). It runs smoothly on the Raspberry Pi, Termux [on Android](https://www.youtube.com/watch?v=AbaauM7gUJw), Linux, macOS, BSD, Cygwin and Linux subsystem for Windows. `nnn` works seamlessly with DEs and GUI utilities. It's nearly zero-config (with sensible defaults) and can be setup in less than 5 minutes. diff --git a/plugins/README.md b/plugins/README.md index b3a3a3c..de7e08a 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -66,17 +66,23 @@ Plugins are installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`. You ca export NNN_PLUG='o:fzy-open;p:mocplay;d:ndiff;m:nmount;n:notes;v:viuimg;t:thumb' -With this, plugin `fzy-open` 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. Up to 10 plugins can have such keybinds. +Now plugin `fzy-open` 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. + +**Method 2:** Use the _pick plugin_ shortcut to visit the plugin directory and execute a plugin. Repeating the same shortcut cancels the operation and puts you back in the original directory. + +## Running commands as plugin To assign keys to arbitrary non-background cli commands (non-shell-interpreted) and invoke like plugins, add `_` (underscore) before the command. For example: export NNN_PLUG='x:_chmod +x $NNN;g:_git log;s:_smplayer $NNN;o:fzy-open' - Notes: - 1. use single quotes for $NNN_PLUG so $NNN is not interpreted - 2. $NNN should be the last argument (IF you want to pass the hovered file name) - 3. (_again_) add `_` before the command -**Method 2:** Use the _pick plugin_ shortcut to visit the plugin directory and execute a plugin. Repeating the same shortcut cancels the operation and puts you back in the original directory. +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. + +Notes: + +1. Use single quotes for `$NNN_PLUG` so `$NNN` is not interpreted +2. `$NNN` should be the last argument (IF you want to pass the hovered file name) +3. (_Again_) add `_` before the command ## Access level of plugins |