p
/
nncmpp
1
1
Fork 0
Code Issues Pull Requests Releases 8 Wiki Activity

Update documentation

This commit is contained in:
Přemysl Eric Janouch 2022-09-20 12:24:00 +02:00
parent e72ed71f53
commit 8aac4ae0a8
Signed by: p
GPG Key ID: A0420B94F92B9493
2 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.adoc
View File

@ -18,6 +18,7 @@ Features
Most stuff is there. I've been using the program exclusively for many years. 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 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, 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. and both its appearance and key bindings can be customized.
Note that currently only the filesystem browsing mode is implemented, Note that currently only the filesystem browsing mode is implemented,

21
nncmpp.adoc
View File

@ -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 your setup is unusual, consult the list of environment variables in
*pulseaudio*(1). MPD-compatibles are currently unsupported. *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 Files
----- -----
*nncmpp* follows the XDG Base Directory Specification. *nncmpp* follows the XDG Base Directory Specification.
@ -135,6 +148,14 @@ Files
_~/.config/nncmpp/nncmpp.conf_:: _~/.config/nncmpp/nncmpp.conf_::
The configuration file. 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 Reporting bugs
-------------- --------------
Use https://git.janouch.name/p/nncmpp to report bugs, request features, Use https://git.janouch.name/p/nncmpp to report bugs, request features,