From a9505103429a26209ba6b57bcb140d83621bf3ad Mon Sep 17 00:00:00 2001 From: Arun Prakash Jana Date: Mon, 4 May 2020 20:17:40 +0530 Subject: [PATCH] Update docs --- README.md | 2 +- nnn.1 | 8 ++++---- plugins/README.md | 8 ++++---- plugins/finder | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0fcc3b6f..28b7a4e9 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ It runs smoothly on the Pi, [Termux](https://www.youtube.com/watch?v=AbaauM7gUJw - Edit and preview markdown, man page, html - Open a file and auto-advance to the next - Export (filtered) list of visible files -- Find and list in `nnn` from `nnn` +- find/fd/fzf/grep/ripgrep/fzf from `nnn` and list in `nnn` - Unlimited bookmarks, plugins, commands with custom hotkeys - Write a plugin in any language you know - Configure the middle mouse click to do anything diff --git a/nnn.1 b/nnn.1 index 936eaee7..fe7e0a59 100644 --- a/nnn.1 +++ b/nnn.1 @@ -331,20 +331,20 @@ separated by \fI;\fR: \fBNNN_PLUG:\fR directly executable plugins as \fIkey_char:location\fR pairs separated by \fI;\fR: .Bd -literal - export NNN_PLUG='o:fzopen;p:mocplay;d:diffs;m:nmount;t:imgthumb' + export NNN_PLUG='f:finder;o:fzopen;p:mocplay;d:diffs;t:nmount;v:imgview' NOTES: 1. To run a plugin directly, press \fI;\fR followed by the plugin key. 2. To skip directory refresh after running a plugin, prefix with \fB-\fR. - export NNN_PLUG='m:-mediainfo' + export NNN_PLUG='m:-mediainf' .Ed .Pp To assign keys to arbitrary non-background non-shell-interpreted cli commands and invoke like plugins, add \fI_\fR (underscore) before the command. .Bd -literal - export NNN_PLUG='x:_chmod +x $nnn;g:_git log;s:_smplayer $nnn;o:fzopen' + export NNN_PLUG='x:_chmod +x $nnn;g:_git log;s:_smplayer $nnn' NOTES: 1. Use single quotes for $NNN_PLUG so $nnn is not interpreted @@ -364,8 +364,8 @@ separated by \fI;\fR: ----------------------------------- + ------------------------------------------------- Key:Command | Description ----------------------------------- + ------------------------------------------------- - k:-_fuser -kiv $nnn* | Interactively kill process(es) using hovered file g:-_git diff | Show git diff + k:-_fuser -kiv $nnn* | Interactively kill process(es) using hovered file l:-_git log | Show git log n:-_vi /home/user/Dropbox/dir/note* | Take quick notes in a synced file/dir of notes p:-_less -iR $nnn* | Page through hovered file in less diff --git a/plugins/README.md b/plugins/README.md index 4e346b1a..292c06b0 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -78,7 +78,7 @@ Plugins are installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`. Use the plugin shortcut (;key or ^Skey) to list the defined plugin keys and press the required key. E.g., with the below config: ```sh -export NNN_PLUG='o:fzopen;p:mocplay;d:diffs;m:nmount;n:notes;v:imgviu;t:imgthumb' +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. @@ -90,7 +90,7 @@ To select and invoke a plugin from the plugin directory, press Enter `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: ```sh -export NNN_PLUG='m:-mediainfo' +export NNN_PLUG='m:-mediainf' ``` Now `nnn` will not refresh the directory after running the `mediainfo` plugin. @@ -102,7 +102,7 @@ To assign keys to arbitrary non-background, non-shell-interpreted cli commands a For example: ```sh -export NNN_PLUG='x:_chmod +x $nnn;g:_git log;s:_smplayer $nnn;o:fzopen' +export NNN_PLUG='x:_chmod +x $nnn;g:_git log;s:_smplayer $nnn' ``` Now ;x can be used to make a file executable, ;g can be used to the git log of a git project directory, ;s can be used to preview a partially downloaded media file. @@ -136,8 +136,8 @@ Notes: | Key:Command | Description | |---|---| -| `k:-_fuser -kiv $nnn*` | Interactively kill process(es) using hovered file | | `g:-_git diff` | Show git diff | +| `k:-_fuser -kiv $nnn*` | Interactively kill process(es) using hovered file | | `l:-_git log` | Show git log | | `n:-_vi /home/user/Dropbox/dir/note*` | Take quick notes in a synced file/dir of notes | | `p:-_less -iR $nnn*` | Page through hovered file in less | diff --git a/plugins/finder b/plugins/finder index b7cda420..649b7113 100755 --- a/plugins/finder +++ b/plugins/finder @@ -3,7 +3,7 @@ # Description: Run custom search and list results in smart context # # Note: To enable multi select in fzf, export the following: -# - export FZF_DEFAULT_OPTS='--bind ctrl-a:select-all,ctrl-d:deselect-all' +# - export FZF_DEFAULT_OPTS='--bind ctrl-a:select-all,ctrl-d:deselect-all,ctrl-t:toggle' # # Shell: POSIX compliant # Author: Arun Prakash Jana