README.md | 29 ++++++++++++++--------------- nnn.1 | 4 ++-- src/nnn.c | 50 +++++++++++++++++++++++++------------------------- src/nnn.h | 8 ++++---- user-scripts/README.md => plugins/README.md | 19 +++++++++---------- user-scripts/copier => scripts/clipboard-copier/copier | 0 user-scripts/edit => plugins/edit | 0 user-scripts/fzy => plugins/fzy | 0 user-scripts/hexview => plugins/hexview | 0 user-scripts/imgresize => plugins/imgresize | 0 user-scripts/imgur => plugins/imgur | 0 user-scripts/kdeconnect => plugins/kdeconnect | 0 user-scripts/ndiff => plugins/ndiff | 0 user-scripts/nwal => plugins/nwal | 0 user-scripts/paste => plugins/paste | 0 user-scripts/picker => plugins/picker | 0 user-scripts/pywal => plugins/pywal | 0 user-scripts/sxiv => plugins/sxiv | 0 user-scripts/transfer => plugins/transfer | 0 user-scripts/upgrade => plugins/upgrade | 0 diff --git a/README.md b/README.md index ab24f6a5986f33b4beced08df514a26c890da453..9b1b4bd69586576498a4c1577e3e966fdf45a866 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ `nnn` is one of the fastest and most lightweight file managers (`~50KB` binary, `~3.5MB` resident memory usage, [highly optimized](https://github.com/jarun/nnn/wiki/performance-factors) code). And yet, it doesn't lack in features! `nnn` works seamlessly with your DE and favourite GUI utilities. It runs on Linux, macOS, Raspberry Pi, BSD, Cygwin, Linux subsystem for Windows and Termux on Android. -Have as many scripts as you want to extend the power of `nnn`! Pick from the [scripts repository](https://github.com/jarun/nnn/tree/master/user-scripts) or add your own. +Have as many scripts as you want to extend the power of `nnn`! Pick from the available [plugins](https://github.com/jarun/nnn/tree/master/plugins) or add your own. [Quickstart](#quickstart) and see how `nnn` simplifies long desktop sessions. When you are ready for more, start [hacking `nnn`](https://github.com/jarun/nnn/wiki/hacking-nnn). @@ -60,7 +60,7 @@ - [Navigate-as-you-type](#navigate-as-you-type) - [File indicators](#file-indicators) - [Configuration](#configuration) - [Help](#help) -- [User scripts](#user-scripts) +- [Plugins](#plugins) - [Troubleshooting](#troubleshooting) - [Tmux configuration](#tmux-configuration) - [BSD terminal issue](#bsd-terminal-issue) @@ -102,13 +102,12 @@ - Select files across dirs; all/range selection - Copy, move, delete, archive, link selection - FreeDesktop compliant trash (needs trash-cli) - Show copy, move progress on Linux (needs avdcpmv) - - Script to view directory and file diff for selection + - Plugin repository - Transfer files using lftp - Batch rename (needs vidir) - Per-context directory color (default: blue) - Spawn a shell in the current directory - Launch applications, run a command - - Repository of custom scripts - Run current file as executable - Change directory at exit (*easy* shell integration) - Edit file in EDITOR or open in PAGER @@ -143,7 +142,7 @@ | vlock (Linux), bashlock (macOS), lock(1) (BSD) | terminal locker | | advcpmv (Linux) ([integration](https://github.com/jarun/nnn/wiki/hacking-nnn#show-cp-mv-progress)) | copy, move progress | | $EDITOR (overridden by $VISUAL, if defined) | edit files (fallback vi) | | $PAGER (less, most) | page through files (fallback less) | -| $SHELL | spawn a shell, run script (fallback sh) | +| $SHELL | spawn a shell, run some commands (fallback sh) | #### From a package manager @@ -199,7 +198,7 @@ 4. Run `n`. 5. To use `nnn` as a GUI app launcher with fuzzy selection menu, drop [`nlaunch`](https://github.com/jarun/nnn/blob/master/scripts/nlaunch/nlaunch) somewhere in your `$PATH`. Note that the launcher requires fzy. 6. Don't memorize keys. Arrows, / and q suffice. Press ? for help on keyboard shortcuts anytime. -- For additional functionality [setup custom scripts](#user-scripts). +- For additional functionality [setup plugins](#plugins). - Visit the wiki page [hacking `nnn`](https://github.com/jarun/nnn/wiki/hacking-nnn) for many more specific use cases. - To set `nnn` as the default file manager, follow these [instructions](https://github.com/jarun/nnn/wiki/nnn-as-default-file-manager). @@ -264,7 +263,7 @@ ^J Disk usage S Apparent du ^W Random s Size t Time modified MISC ! ^] Spawn SHELL C Execute entry - R ^V Run script L Lock terminal + R ^V Pick plugin L Lock terminal ^P Prompt ^N Note = Launcher ``` @@ -379,8 +378,8 @@ | `NNN_OPENER=mimeopen` | custom file opener | | `NNN_OPENER_DETACH=1` | do not block when invoking file opener | | `NNN_CONTEXT_COLORS='1234'` | specify per context color [default: '4444' (all blue)] | | `NNN_IDLE_TIMEOUT=300` | idle seconds before locking terminal [default: disabled] | -| `NNN_COPIER='copier.sh'` | system clipboard copier script [default: none] | -| `NNN_SCRIPT_DIR=/home/user/scripts` | absolute path to script dir | +| `NNN_COPIER='/path/to/copier.sh'` | system clipboard copier script [default: none] | +| `NNN_PLUGIN_DIR=/home/user/nnn-plugins` | absolute path to plugins dir | | `NNN_NOTE=/home/user/Dropbox/Public/notes` | path to note file [default: none] | | `NNN_TMPFILE=/tmp/nnn` | file to write current open dir path to for cd on quit | | `NNN_USE_EDITOR=1` | Open text files in `$EDITOR` (`$VISUAL`, if defined; fallback vi) | @@ -396,17 +395,17 @@ $ nnn -h $ man nnn To lookup keyboard shortcuts at runtime, press ?. -#### USER SCRIPTS +#### PLUGINS -`nnn` can invoke custom scripts in the current directory (`$PWD` for the script) with the currently selected file name as the argument. +`nnn` can invoke plugins in the current directory (`$PWD` for the plugin) with the currently selected file name as the argument. -Copy the scripts of your interest from the [user-scripts](https://github.com/jarun/nnn/tree/master/user-scripts) directory and let `nnn` know the location: +Copy the plugins of your interest from the [plugins](https://github.com/jarun/nnn/tree/master/plugins) directory and let `nnn` know the location: - export NNN_SCRIPT_DIR=/absolute/path/to/scripts_dir + export NNN_PLUGIN_DIR=/absolute/path/to/plugins_dir -Use the run script shortcut to jump to the script directory and pick a script. Repeating the same shortcut cancels the operation and puts you back in the original directory. +Use the pick plugin shortcut to visit the plugin directory and pick a plugin. Repeating the same shortcut cancels the operation and puts you back in the original directory. -If you have an interesting script feel free to raise a PR. +If you have an interesting plugin feel free to raise a PR. #### TROUBLESHOOTING diff --git a/nnn.1 b/nnn.1 index 11d44e4e48e605239252aeebccfd3593d426ee23..8621776af337087f6407b2016b717be4605b5625 100644 --- a/nnn.1 +++ b/nnn.1 @@ -174,9 +174,9 @@ \fI$HOME\fR or, \fI$TMPDIR\fR or, \fI/tmp\fR. The path is shown in the help and configuration screen. .Ed .Pp -\fBNNN_SCRIPT_DIR:\fR \fIabsolute\fR path to script directory. Selected script is invoked with currently selected file name as argument 1. +\fBNNN_PLUGIN_DIR:\fR \fIabsolute\fR path to plugin directory. Selected plugin is invoked with currently selected file name as argument 1. .Bd -literal - export NNN_SCRIPT_DIR=/absolute/path/to/scripts_dir + export NNN_PLUGIN_DIR=/absolute/path/to/plugins_dir .Ed .Pp \fBNNN_NOTE:\fR \fIabsolute\fR path to a note file. diff --git a/src/nnn.c b/src/nnn.c index 72db2c5e4c3c6e042f58cc1b5b1b85508342184d..05d1a266dd3cdb24b22a2b21eeb69a6cb63a57a4 100644 --- a/src/nnn.c +++ b/src/nnn.c @@ -217,8 +217,8 @@ uint nonavopen : 1; /* Open file on right arrow or `l` */ uint autoselect : 1; /* Auto-select dir in nav-as-you-type mode */ uint metaviewer : 1; /* Index of metadata viewer in utils[] */ uint useeditor : 1; /* Use VISUAL to open text files */ - uint runscript : 1; /* Choose script to run mode */ - uint runctx : 2; /* The context in which script is to be run */ + uint runplugin : 1; /* Choose plugin mode */ + uint runctx : 2; /* The context in which plugin is to be run */ uint restrict0b : 1; /* Restrict 0-byte file opening */ uint filter_re : 1; /* Use regex filters */ uint wild : 1; /* Do not sort entries on dir load */ @@ -257,7 +257,7 @@ 0, /* nonavopen */ 1, /* autoselect */ 0, /* metaviewer */ 0, /* useeditor */ - 0, /* runscript */ + 0, /* runplugin */ 0, /* runctx */ 0, /* restrict0b */ 1, /* filter_re */ @@ -385,7 +385,7 @@ #define NNN_OPENER 1 #define NNN_CONTEXT_COLORS 2 #define NNN_IDLE_TIMEOUT 3 #define NNN_COPIER 4 -#define NNN_SCRIPT_DIR 5 +#define NNN_PLUGIN_DIR 5 #define NNN_NOTE 6 #define NNN_TMPFILE 7 #define NNNLVL 8 /* strings end here */ @@ -405,7 +405,7 @@ "NNN_OPENER", "NNN_CONTEXT_COLORS", "NNN_IDLE_TIMEOUT", "NNN_COPIER", - "NNN_SCRIPT_DIR", + "NNN_PLUGIN_DIR", "NNN_NOTE", "NNN_TMPFILE", "NNNLVL", @@ -2158,7 +2158,7 @@ g_ctx[r].c_last[0] = '\0'; xstrlcpy(g_ctx[r].c_name, curname, NAME_MAX + 1); g_ctx[r].c_fltr[0] = g_ctx[r].c_fltr[1] = '\0'; g_ctx[r].c_cfg = cfg; - g_ctx[r].c_cfg.runscript = 0; + g_ctx[r].c_cfg.runplugin = 0; } cfg.curctx = r; @@ -2386,7 +2386,7 @@ "b^J Disk usage S Apparent du\n" "b^W Random s Size t Time modified\n" "1MISC\n" "9! ^] Spawn SHELL C Execute entry\n" - "9R ^V Run script L Lock terminal\n" + "9R ^V Pick plugin L Lock terminal\n" "b^P Prompt ^N Note = Launcher\n"}; if (g_tmpfpath[0]) @@ -2845,7 +2845,7 @@ bool dir_changed = FALSE; struct stat sb; char *path, *lastdir, *lastname; char *dir, *tmp; - char *scriptpath = getenv(env_cfg[NNN_SCRIPT_DIR]); + char *pluginpath = getenv(env_cfg[NNN_PLUGIN_DIR]); atexit(dentfree); @@ -3002,11 +3002,11 @@ /* If open file is disabled on right arrow or `l`, return */ if (cfg.nonavopen && sel == SEL_NAV_IN) continue; - /* Handle script selection mode */ - if (cfg.runscript) { - if (!scriptpath || (cfg.runctx != cfg.curctx) - /* Must be in script directory to select script */ - || (strcmp(path, scriptpath) != 0)) + /* Handle plugin selection mode */ + if (cfg.runplugin) { + if (!pluginpath || (cfg.runctx != cfg.curctx) + /* Must be in plugin directory to select plugin */ + || (strcmp(path, pluginpath) != 0)) continue; mkpath(path, dents[cur].name, newpath); @@ -3019,7 +3019,7 @@ runfile[0] = '\0'; } else spawn(newpath, NULL, NULL, path, F_NORMAL); rundir[0] = '\0'; - cfg.runscript = 0; + cfg.runplugin = 0; setdirwatch(); goto begin; } @@ -3739,7 +3739,7 @@ goto begin; } case SEL_EXEC: // fallthrough case SEL_SHELL: // fallthrough - case SEL_SCRIPT: // fallthrough + case SEL_PLUGIN: // fallthrough case SEL_LAUNCH: // fallthrough case SEL_RUNCMD: switch (sel) { @@ -3766,13 +3766,13 @@ break; case SEL_SHELL: spawn(shell, NULL, NULL, path, F_CLI); break; - case SEL_SCRIPT: - if (!scriptpath) { - printwait("set NNN_SCRIPT_DIR", &presel); + case SEL_PLUGIN: + if (!pluginpath) { + printwait("set NNN_PLUGIN_DIR", &presel); goto nochange; } - if (stat(scriptpath, &sb) == -1) { + if (stat(pluginpath, &sb) == -1) { printwarn(); goto nochange; } @@ -3781,13 +3781,13 @@ /* Must be a directory */ if (!S_ISDIR(sb.st_mode)) break; - cfg.runscript ^= 1; - if (!cfg.runscript && rundir[0]) { + cfg.runplugin ^= 1; + if (!cfg.runplugin && rundir[0]) { /* - * If toggled, and still in the script dir, + * If toggled, and still in the plugin dir, * switch to original directory */ - if (strcmp(path, scriptpath) == 0) { + if (strcmp(path, pluginpath) == 0) { xstrlcpy(path, rundir, PATH_MAX); xstrlcpy(lastname, runfile, NAME_MAX); rundir[0] = runfile[0] = '\0'; @@ -3798,11 +3798,11 @@ break; } /* Check if directory is accessible */ - if (!xdiraccess(scriptpath)) + if (!xdiraccess(pluginpath)) goto nochange; xstrlcpy(rundir, path, PATH_MAX); - xstrlcpy(path, scriptpath, PATH_MAX); + xstrlcpy(path, pluginpath, PATH_MAX); if (ndents) xstrlcpy(runfile, dents[cur].name, NAME_MAX); cfg.runctx = cfg.curctx; diff --git a/src/nnn.h b/src/nnn.h index 839ec0c17422df81ee5db90d9d04ca9c0d4ca456..dd21ef5b419a2e6217447c6b751c9209d74984cd 100644 --- a/src/nnn.h +++ b/src/nnn.h @@ -88,7 +88,7 @@ SEL_RENAMEALL, SEL_HELP, SEL_EXEC, SEL_SHELL, - SEL_SCRIPT, + SEL_PLUGIN, SEL_LAUNCH, SEL_RUNCMD, SEL_RUNEDIT, @@ -225,9 +225,9 @@ { 'C', SEL_EXEC }, /* Run command */ { '!', SEL_SHELL }, { CONTROL(']'), SEL_SHELL }, - /* Run a custom script */ - { 'R', SEL_SCRIPT }, - { CONTROL('V'), SEL_SCRIPT }, + /* Run a plugin */ + { 'R', SEL_PLUGIN }, + { CONTROL('V'), SEL_PLUGIN }, /* Launcher */ { '=', SEL_LAUNCH }, /* Run a command */ diff --git a/user-scripts/README.md b/plugins/README.md rename from user-scripts/README.md rename to plugins/README.md index 40aae409aafdc53c721e915fac75c26536de5c65..be8aa4c0eebb94a13eeb4fe6d515832944e8a8c8 100644 --- a/user-scripts/README.md +++ b/plugins/README.md @@ -1,6 +1,5 @@ -| Script (a-z) | Lang | Deps | Description | +| Plugin (a-z) | Lang | Deps | Description | | --- | --- | --- | --- | -| copier | sh | OS-specific | Copy selection to clipboard | | edit | sh | fzy | Fuzzy find a file in directory subtree and edit in vim | | fzy | sh | fzy | Fuzzy find a file in directory subtree and open using xdg-open | | hexview | sh | xxd, $PAGER | view a file in hex | @@ -16,15 +15,15 @@ | sxiv | sh | sxiv | Open images in a dir in sxiv, set wallpaper, copy path ([tips](https://wiki.archlinux.org/index.php/Sxiv#Assigning_keyboard_shortcuts))| | transfer | sh | curl | Upload current file to transfer.sh | | upgrade | sh | wget | Upgrade to latest nnn version manually on Debian 9 Stretch | -### File access from scripts +### File access from plugins -The design is flexible so a script can access: -- all files in the directory (`nnn` switches to the dir where the script is to be run so the dir is `$PWD` for the script) -- the currently highlighted file (the file name is passed as the first argument to a script) -- the current selection (by reading the file .nnncp, see the script `copier`) +The design is flexible so a plugin can access: +- all files in the directory (`nnn` switches to the dir where the plugin is to be run so the dir is `$PWD` for the plugin) +- the currently highlighted file (the file name is passed as the argument to a plugin) +- the current selection (by reading the file .nnncp, see the plugin `ndiff`) -### Contributing scripts +### Contributing plugins -All scripting languages should work. However, POSIX-compliant shell scripts runnable in `sh` are preferred. If that's too rudimentary for your use case, use Python, Perl or Ruby. Please keep non-portable commands (like `notify-send`) commented so users from any other OS/DE aren't surprised. +Plugins are scripts and all scripting languages should work. However, POSIX-compliant shell scripts runnable in `sh` are preferred. If that's too rudimentary for your use case, use Python, Perl or Ruby. Please keep non-portable commands (like `notify-send`) commented so users from any other OS/DE aren't surprised. -The scripts should be executable. Please add an entry in the table above. +The plugins should be executable. Please add an entry in the table above. diff --git a/user-scripts/copier b/scripts/clipboard-copier/copier rename from user-scripts/copier rename to scripts/clipboard-copier/copier diff --git a/user-scripts/edit b/plugins/edit rename from user-scripts/edit rename to plugins/edit diff --git a/user-scripts/fzy b/plugins/fzy rename from user-scripts/fzy rename to plugins/fzy diff --git a/user-scripts/hexview b/plugins/hexview rename from user-scripts/hexview rename to plugins/hexview diff --git a/user-scripts/imgresize b/plugins/imgresize rename from user-scripts/imgresize rename to plugins/imgresize diff --git a/user-scripts/imgur b/plugins/imgur rename from user-scripts/imgur rename to plugins/imgur diff --git a/user-scripts/kdeconnect b/plugins/kdeconnect rename from user-scripts/kdeconnect rename to plugins/kdeconnect diff --git a/user-scripts/ndiff b/plugins/ndiff rename from user-scripts/ndiff rename to plugins/ndiff diff --git a/user-scripts/nwal b/plugins/nwal rename from user-scripts/nwal rename to plugins/nwal diff --git a/user-scripts/paste b/plugins/paste rename from user-scripts/paste rename to plugins/paste diff --git a/user-scripts/picker b/plugins/picker rename from user-scripts/picker rename to plugins/picker diff --git a/user-scripts/pywal b/plugins/pywal rename from user-scripts/pywal rename to plugins/pywal diff --git a/user-scripts/sxiv b/plugins/sxiv rename from user-scripts/sxiv rename to plugins/sxiv diff --git a/user-scripts/transfer b/plugins/transfer rename from user-scripts/transfer rename to plugins/transfer diff --git a/user-scripts/upgrade b/plugins/upgrade rename from user-scripts/upgrade rename to plugins/upgrade