diff options
| author | Přemysl Eric Janouch <p@janouch.name> | 2022-09-20 12:24:00 +0200 |
|---|---|---|
| committer | Přemysl Eric Janouch <p@janouch.name> | 2022-09-20 12:24:00 +0200 |
| commit | 8aac4ae0a8705641ee55772292d0ae25d529271a (patch) | |
| tree | 001baf6277ec00bcc98f9c298028d98e9ed6502d | |
| parent | e72ed71f53c3fbfe2bfe3aa1b591632ab24d0d34 (diff) | |
| download | nncmpp-8aac4ae0a8705641ee55772292d0ae25d529271a.tar.gz nncmpp-8aac4ae0a8705641ee55772292d0ae25d529271a.tar.xz nncmpp-8aac4ae0a8705641ee55772292d0ae25d529271a.zip | |
Update documentation
| -rw-r--r-- | README.adoc | 1 | ||||
| -rw-r--r-- | nncmpp.adoc | 21 |
2 files changed, 22 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc index 14d63a3..073e265 100644 --- a/README.adoc +++ b/README.adoc @@ -18,6 +18,7 @@ Features Most stuff is there. I've been using the program exclusively for many years. Among other things, it can display and change PulseAudio volume directly to cover the use case of remote control, it has a fast spectrum visualiser, +it can be extended with plugins to fetch lyrics or other song-related info, and both its appearance and key bindings can be customized. Note that currently only the filesystem browsing mode is implemented, diff --git a/nncmpp.adoc b/nncmpp.adoc index b493a38..5b1cfdb 100644 --- a/nncmpp.adoc +++ b/nncmpp.adoc @@ -128,6 +128,19 @@ For this to work, *nncmpp* needs to access the right PulseAudio daemon--in case your setup is unusual, consult the list of environment variables in *pulseaudio*(1). MPD-compatibles are currently unsupported. +Info plugins +------------ +You can invoke various plugins from the Info tab, for example to look up +song lyrics. + +Plugins can be arbitrary scripts or binaries. When run without command line +arguments, a plugin outputs a user interface description of what it does. +When invoked by a user, it receives the following self-explanatory arguments: +_TITLE_ _ARTIST_ [_ALBUM_], and anything it writes to its standard output +or standard error stream is presented back to the user. Here, bold and italic +formatting can be toggled with ASCII control characters 1 (SOH) and 2 (STX), +respectively. Otherwise, all input and output makes use of the UTF-8 encoding. + Files ----- *nncmpp* follows the XDG Base Directory Specification. @@ -135,6 +148,14 @@ Files _~/.config/nncmpp/nncmpp.conf_:: The configuration file. +_~/.local/share/nncmpp/info/_:: +_/usr/local/share/nncmpp/info/_:: +_/usr/share/nncmpp/info/_:: + Info plugins are loaded from these directories, in order, + then listed lexicographically. + Only the first occurence of a particular filename is used, + and empty files act as silent disablers. + Reporting bugs -------------- Use https://git.janouch.name/p/nncmpp to report bugs, request features, |