From 2b3b0990cc26ee6df272f2a8d80e9c248b31403d Mon Sep 17 00:00:00 2001 From: Doug Headley Date: Thu, 29 Oct 2020 16:35:41 -0700 Subject: [PATCH] Plugin readme improvement --- plugins/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/plugins/README.md b/plugins/README.md index 3d2a609c..772f28e1 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -94,6 +94,23 @@ To pick and run an unassigned plugin, press Enter (to _enter_ the plu To run a plugin at startup, use the option `-P` followed by the plugin key. +If the plugins list gets too long, try breaking them up into sections: + +``` +NNN_PLUG_PERSONAL='g:personal/convert2zoom;p:personal/echo' +NNN_PLUG_WORK='j:work/prettyjson;d:work/foobar' +NNN_PLUG_INLINE='e:_go run $nnn*' +NNN_PLUG_DEFAULT='1:bookmarks;2:ipinfo;p:preview-tui;o:fzz;b:nbak' +NNN_PLUG="$NNN_PLUG_PERSONAL;$NNN_PLUG_WORK;$NNN_PLUG_DEFAULT;$NNN_PLUG_INLINE" +export NNN_PLUG +``` + +Note: +- `'g:personal/convert2zoom'` will look in the personal sub-folder inside the plugin folder. +- `'b:boom;b:bookmarks` will result in only the first definition of *b* (`b:boom`) being used. +- A keybinding definition of more than 1 character will prevent nnn from starting. + + #### Skip directory refresh after running a plugin `nnn` refreshes the directory after running a plugin to reflect any changes by the plugin. To disable this (say while running the `mediainf` plugin on some filtered files), add a `-` before the plugin name: