nnn/plugins/README.md

53 lines
3.6 KiB
Markdown
Raw Normal View History

2019-04-18 14:57:35 +00:00
| Plugin (a-z) | Lang | Deps | Description |
2019-04-18 04:59:47 +00:00
| --- | --- | --- | --- |
2019-06-07 03:14:49 +00:00
| boom | sh | SMPlayer | Play random music from dir (modify `PLAYER`) |
2019-06-23 03:48:35 +00:00
| checksum | sh | md5sum,<br>sha256sum | Create and verify checksums |
2019-04-19 13:34:20 +00:00
| fzy-edit | sh | fzy | Fuzzy find a file in directory subtree and edit in vim |
| fzy-open | sh | fzy | Fuzzy find a file in directory subtree and open using xdg-open |
| getplugs | sh | wget | Update plugins |
2019-05-31 18:47:19 +00:00
| hexview | sh | xxd | View a file in hex in `$PAGER` |
2019-04-18 04:59:47 +00:00
| imgresize | sh | [imgp](https://github.com/jarun/imgp) | Resize images in directory to screen resolution |
2019-04-18 15:28:14 +00:00
| imgur | bash | - | Upload an image to imgur (from [imgur-screenshot](https://github.com/jomo/imgur-screenshot)) |
2019-05-24 17:44:19 +00:00
| ipinfo | sh | curl, whois | Fetch external IP address and whois information |
2019-04-18 04:59:47 +00:00
| kdeconnect | sh | kdeconnect-cli | Send selected files to an Android device |
2019-06-03 12:56:53 +00:00
| mocplay | sh | [moc](http://moc.daper.net/) | Appends (and plays, see script) selection/dir/file in moc|
| ndiff | sh | vimdiff | Diff for selection (limited to 2 for directories) |
2019-05-31 18:47:19 +00:00
| nmount | sh | pmount, udisks2 | Toggle mount status of a device as normal user |
2019-04-18 04:59:47 +00:00
| nwal | sh | nitrogen | Set the selected image as wallpaper using nitrogen |
2019-06-07 03:14:49 +00:00
| pastebin | sh | [pastebinit](https://launchpad.net/pastebinit) | Paste contents of (text) file to paste.ubuntu.com |
2019-06-23 03:48:35 +00:00
| pdfview | sh | pdftotext/<br>mupdf-tools | View PDF file in `$PAGER` |
2019-04-18 04:59:47 +00:00
| picker | sh | nnn | Pick files and pipe the newline-separated list to another utility |
| pywal | sh | pywal | Set selected image as wallpaper, change terminal color scheme |
2019-06-23 03:48:35 +00:00
| readit | sh | pdftotext, mpv,<br>pico2wave | Read a PDF or text file aloud |
2019-06-21 17:06:34 +00:00
| ringtone | sh | date, ffmpeg | Create a variable bitrate mp3 ringtone from file |
| splitjoin | sh | split, cat | Split file or join selection |
2019-04-18 15:28:14 +00:00
| sxiv | sh | sxiv | Browse images in a dir in sxiv, set wallpaper, copy path ([config](https://wiki.archlinux.org/index.php/Sxiv#Assigning_keyboard_shortcuts))|
2019-06-07 03:14:49 +00:00
| transfer | sh | curl | Upload file to transfer.sh |
2019-04-18 04:59:47 +00:00
| upgrade | sh | wget | Upgrade to latest nnn version manually on Debian 9 Stretch |
| viuimg | sh | [viu](https://github.com/atanunq/viu), less | View an image or images in a directory |
2019-04-18 04:59:47 +00:00
2019-04-30 03:06:55 +00:00
#### Installing plugins
2019-06-20 13:40:47 +00:00
Download the `getplugs` plugin and execute it anywhere to get all the plugins installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`. You can run it again later to update the plugins. It backs up earlier plugins.
2019-04-30 03:06:55 +00:00
2019-05-05 02:50:35 +00:00
**NOTE:** `getplugs` also downloads the launcher `nlaunch` and tries to place it at `/usr/local/bin/` using `sudo`. If it fails you have to place `nlauch` manually somewhere in your `$PATH`.
2019-04-30 03:06:55 +00:00
2019-04-18 15:28:14 +00:00
#### File access from plugins
2019-04-18 04:59:47 +00:00
2019-04-18 15:28:14 +00:00
Plugins can access:
2019-04-18 14:57:35 +00:00
- 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)
2019-04-21 18:37:48 +00:00
- the current file under the cursor (the file name is passed as the argument to a plugin)
2019-06-20 13:40:47 +00:00
- the current selection (by reading the file `.selection` in config dir, see the plugin `ndiff`)
2019-04-18 04:59:47 +00:00
Each script has a _Description_ section which provides more details on what the script does, if applicable.
2019-06-03 04:57:01 +00:00
#### Usage
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.
2019-04-18 15:28:14 +00:00
#### Contributing plugins
2019-04-18 04:59:47 +00:00
2019-04-18 14:57:35 +00:00
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.
2019-04-18 04:59:47 +00:00
2019-04-18 14:57:35 +00:00
The plugins should be executable. Please add an entry in the table above.