From 1a671dfad5062ba265e873f7353c7d682943af98 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?P=C5=99emysl=20Eric=20Janouch?= <p@janouch.name>
Date: Tue, 16 Nov 2021 04:46:46 +0100
Subject: Document PulseAudio integration

---
 nncmpp.adoc | 25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

(limited to 'nncmpp.adoc')

diff --git a/nncmpp.adoc b/nncmpp.adoc
index de668cb..ed7c1cf 100644
--- a/nncmpp.adoc
+++ b/nncmpp.adoc
@@ -47,7 +47,6 @@ snippet:
 settings = {
   address    = "~/.mpd/mpd.socket"
   password   = "<your password>"
-  root       = "~/Music"
   pulseaudio = on
 }
 colors = {
@@ -98,6 +97,28 @@ settings = {
 The sample rate should be greater than 40 kHz, the number of bits 8 or 16,
 and the number of channels doesn't matter, as they're simply averaged together.
 
+PulseAudio
+----------
+If you find standard MPD volume control useless, you may instead configure
+*nncmpp* to show and control the volume of any PulseAudio sink MPD is currently
+connected to.
+
+This feature may be enabled with the *settings.pulseaudio* configuration option,
+as in the snippet above.  To replace the default volume control bindings, use:
+
+....
+normal = {
+  "M-PageUp" = "pulse-volume-up"
+  "M-PageDown" = "pulse-volume-down"
+}
+....
+
+The respective actions may also be invoked from the help tab directly.
+
+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.
+
 Files
 -----
 *nncmpp* follows the XDG Base Directory Specification.
@@ -112,4 +133,4 @@ or submit pull requests.
 
 See also
 --------
-*mpd*(1)
+*mpd*(1), *pulseaudio*(1)
-- 
cgit v1.2.3

