Update plugin docs

This commit is contained in:
Arun Prakash Jana 2019-08-15 11:06:41 +05:30
parent 7575a3e031
commit 9282eff925
No known key found for this signature in database
GPG key ID: A75979F35C080412
2 changed files with 6 additions and 6 deletions

View file

@ -14,7 +14,7 @@ The currently available plugins are listed below.
| imgur | bash | - | Upload an image to imgur (from [imgur-screenshot](https://github.com/jomo/imgur-screenshot)) | | imgur | bash | - | Upload an image to imgur (from [imgur-screenshot](https://github.com/jomo/imgur-screenshot)) |
| ipinfo | sh | curl, whois | Fetch external IP address and whois information | | ipinfo | sh | curl, whois | Fetch external IP address and whois information |
| kdeconnect | sh | kdeconnect-cli | Send selected files to an Android device | | kdeconnect | sh | kdeconnect-cli | Send selected files to an Android device |
| moclyrics | sh | [ddgr](https://github.com/jarun/ddgr), [moc](http://moc.daper.net/) | Show lyrics of current track in moc | | moclyrics | sh | [ddgr](https://github.com/jarun/ddgr), [moc](http://moc.daper.net/) | Show lyrics of the track playing in moc |
| mocplay | sh | [moc](http://moc.daper.net/) | Appends (and plays, see script) selection/dir/file in moc| | 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) | | ndiff | sh | vimdiff | Diff for selection (limited to 2 for directories) |
| nmount | sh | pmount, udisks2 | Toggle mount status of a device as normal user | | nmount | sh | pmount, udisks2 | Toggle mount status of a device as normal user |
@ -52,13 +52,13 @@ Each script has a _Description_ section which provides more details on what the
There are 2 ways to run plugins: There are 2 ways to run plugins:
1. 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. 1. Directly with <kbd>x-key</kbd>:
2. To run (up to 10) plugins directly with <kbd>x-key</kbd>:
export NNN_PLUG='o:fzy-open;p:mocplay;d:ndiff;m:nmount;t:thumb' export NNN_PLUG='o:fzy-open;p:mocplay;d:ndiff;m:nmount;t:thumb'
With this, plugin `fzy-open` can be run with the keybind <kbd>xo</kbd>, `mocplay` can be run with <kbd>xp</kbd> and so on... The key vs. plugin pairs are shown in the help and config screen. With this, plugin `fzy-open` can be run with the keybind <kbd>xo</kbd>, `mocplay` can be run with <kbd>xp</kbd> and so on... The key vs. plugin pairs are shown in the help and config screen. Up to 10 plugins can have such keybinds.
2. 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.
#### Contributing plugins #### Contributing plugins

View file

@ -1,6 +1,6 @@
#!/usr/bin/env sh #!/usr/bin/env sh
# Description: Fetches the lyrics of the currently playing track in MOC # Description: Fetches the lyrics of the track currently playing in MOC
# Requires ddgr (https://github.com/jarun/ddgr) # Requires ddgr (https://github.com/jarun/ddgr)
# #
# Shell: POSIX compliant # Shell: POSIX compliant