diff --git a/README.md b/README.md index 0474d8ba..653ddd77 100644 --- a/README.md +++ b/README.md @@ -135,8 +135,9 @@ Don't memorize! Arrows (or h j k l), - [0xACE](https://github.com/0xACE) - [Anna Arad](https://github.com/annagrram) - [KlzXS](https://github.com/KlzXS) -- [leovilok](https://github.com/leovilok) +- [Léo Villeveygoux](https://github.com/leovilok) - [Maxim Baz](https://github.com/maximbaz) +- [Todd Yamakawa](https://github.com/toddyamakawa) - and other contributors Visit the [ToDo list](https://github.com/jarun/nnn/issues/506) to contribute or see the features in progress. diff --git a/plugins/chksum b/plugins/chksum index 1514de72..0a386e5a 100755 --- a/plugins/chksum +++ b/plugins/chksum @@ -12,7 +12,7 @@ # the output checksum filename will be directory.checksum_type # # Shell: POSIX compliant -# Author: ath3, Arun Prakash Jana +# Authors: ath3, Arun Prakash Jana selection=${NNN_SEL:-${XDG_CONFIG_HOME:-$HOME/.config}/nnn/.selection} resp=f diff --git a/plugins/dragdrop b/plugins/dragdrop index bc01d870..5734d98e 100755 --- a/plugins/dragdrop +++ b/plugins/dragdrop @@ -1,15 +1,16 @@ #!/usr/bin/env sh # Description: Open a Drag and drop window, to drop files onto other programs. -# Also provides drag and drop window for files. +# Also provides drag and drop window for files. # -# Files that are dropped will be added to nnn's selection -# Some webbased files will be downloaded to current directory with curl -# and it may overwrite some existing files +# Requires: https://github.com/mwh/dragon # -# The user has to mm to clear nnn's selection first +# Notes: +# - Files that are dropped will be added to nnn's selection +# Some webbased files will be downloaded to current directory with curl +# and it may overwrite some existing files +# - The user has to mm to clear nnn's selection first # -# Dependency: https://github.com/mwh/dragon # Shell: POSIX compliant # Author: 0xACE diff --git a/plugins/dups b/plugins/dups index c35489c6..d44ecfcf 100755 --- a/plugins/dups +++ b/plugins/dups @@ -7,7 +7,7 @@ # Requires: find md5sum sort uniq xargs # # Shell: POSIX compliant -# Author: syssyphus, KlzXS +# Authors: syssyphus, KlzXS find . -size +0 -type f -printf "%s %p\n" | sort -rn | sed -n 'N; /^\([0-9]*\) .*\n\1.*$/p;$d;D' | awk '{printf("%s\0", substr($0, index($0, $2)))}' | xargs -0 md5sum | sort | uniq -w32 --all-repeated=separate diff --git a/plugins/getplugs b/plugins/getplugs index 2dfc0027..0c68be07 100755 --- a/plugins/getplugs +++ b/plugins/getplugs @@ -3,7 +3,7 @@ # Description: Update nnn plugins to installed nnn version # # Shell: POSIX compliant -# Author: Arun Prakash Jana, KlzXS +# Authors: Arun Prakash Jana, KlzXS CONFIG_DIR=${XDG_CONFIG_HOME:-$HOME/.config}/nnn/ PLUGIN_DIR=${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins diff --git a/plugins/mocplay b/plugins/mocplay index 6739c556..39c7c9ad 100755 --- a/plugins/mocplay +++ b/plugins/mocplay @@ -8,7 +8,7 @@ # - to let mocp shuffle tracks, set SHUFFLE=1 # # Shell: POSIX compliant -# Author: Arun Prakash Jana, ath3 +# Authors: Arun Prakash Jana, ath3 IFS="$(printf '\n\r')" selection=${NNN_SEL:-${XDG_CONFIG_HOME:-$HOME/.config}/nnn/.selection} diff --git a/plugins/nbak b/plugins/nbak index 8ff5474c..f9cb6449 100755 --- a/plugins/nbak +++ b/plugins/nbak @@ -1,6 +1,9 @@ #!/usr/bin/env sh -# Description: Backup of all nnn config +# Description: Backup nnn configuration +# - config dir content +# - environment config +# - shell functions and aliases # # Shell: POSIX compliant # Author: Léo Villeveygoux @@ -70,4 +73,3 @@ printf "Saving as '%s' ... " "$workdir/$outfile" tar caf "$workdir/$outfile" "$outdir" && echo "Done" || echo "Failed" cd "$workdir" && rm -rf "$tempdir" - diff --git a/plugins/picker b/plugins/picker index 91101fea..93acca54 100755 --- a/plugins/picker +++ b/plugins/picker @@ -2,21 +2,21 @@ # Description: Pick files and pipe the newline-separated list to another utility # +# Usage: +# Copy this file in your $PATH, make it executable and preferably name it to picker. +# Run commands like: +# ls -l `picker` +# cd `picker` +# vimdiff `picker` +# or, in fish shell: +# ls -l (picker) +# cd (picker) +# vimdiff (picker) +# +# Note: This use case is limited to picking files, other functionality may not work as expected. +# # Shell: POSIX compliant # Author: Arun Prakash Jana -# -# Usage: -# Copy this file in your $PATH, make it executable and preferably name it to picker. -# Run commands like: -# ls -l `picker` -# cd `picker` -# vimdiff `picker` -# or, in fish shell: -# ls -l (picker) -# cd (picker) -# vimdiff (picker) -# -# NOTE: This use case is limited to picking files, other functionality may not work as expected. nnn -p /tmp/picked diff --git a/plugins/preview-tabbed b/plugins/preview-tabbed index 7e7e8400..b5b5f052 100755 --- a/plugins/preview-tabbed +++ b/plugins/preview-tabbed @@ -1,11 +1,9 @@ -#!/bin/bash +#!/usr/bin/env bash # Description: tabbed/xembed based file previewer # # Note: This plugin needs a "NNN_FIFO" to work. See man. # -# Shell: Bash (job control is weakly specified in POSIX) -# # Dependencies: # - tabbed (https://tools.suckless.org/tabbed): xembed host # - xterm (or urxvt or st) : xembed client for text-based preview @@ -46,6 +44,7 @@ # [1]: http://tools.suckless.org/tabbed/ # [2]: https://specifications.freedesktop.org/xembed-spec/xembed-spec-latest.html # +# Shell: bash (job control is weakly specified in POSIX) # Author: leovilok diff --git a/plugins/preview-tui b/plugins/preview-tui index 0c50390e..17b529bf 100755 --- a/plugins/preview-tui +++ b/plugins/preview-tui @@ -6,7 +6,7 @@ # # Dependencies: tmux (>=3.0) or xterm (or set $TERMINAL), file, tree # -# How to use: +# Usage: # You need to set a NNN_FIFO path and set a key for the plugin, # then start `nnn`: # @@ -18,7 +18,8 @@ # single common preview window. I you provide different FIFO path, they # will be independent. # -# Authors: Todd Yamakawa and Léo Villeveygoux +# Shell: POSIX compliant +# Authors: Todd Yamakawa, Léo Villeveygoux TERMINAL="${TERMINAL:-xterm}" diff --git a/plugins/uidgid b/plugins/uidgid index a73acae0..8e0b197e 100755 --- a/plugins/uidgid +++ b/plugins/uidgid @@ -3,7 +3,7 @@ # Description: list uid and gid of files # # Shell: POSIX compliant -# Author: Arun Prakash Jana, superDuperCyberTechno +# Authors: Arun Prakash Jana, superDuperCyberTechno # shellcheck disable=SC2012 ls -lah --group-directories-first | less diff --git a/plugins/upgrade b/plugins/upgrade index d1669919..b2170f7b 100755 --- a/plugins/upgrade +++ b/plugins/upgrade @@ -2,9 +2,10 @@ # Description: Check and update to latest version of nnn manually on Debian 9 Stretch # +# Note: This script installs a package, should be issued with admin privilege +# # Shell: POSIX-compliant # Author: Arun Prakash Jana -# NOTE: This script installs a package, should be issued with admin privilege cur="$(nnn -v)" new="$(curl -s "https://github.com/jarun/nnn/releases/latest" | grep -Eo "[0-9]+\.[0-9]+")" diff --git a/plugins/x2sel b/plugins/x2sel index 79856eb1..88f9dcc5 100755 --- a/plugins/x2sel +++ b/plugins/x2sel @@ -9,7 +9,7 @@ # cygwim's /dev/clipboard (Cygwin) # wl-paste (Wayland) # -# LIMITATION: breaks if a filename has newline in it +# Limitation: breaks if a filename has newline in it # # Shell: POSIX compliant # Author: Léo Villeveygoux, after Arun Prakash Jana's .cbcp