summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorMaxim Cournoyer <maxim.cournoyer@gmail.com>2023-04-28 00:13:56 -0400
committerMaxim Cournoyer <maxim.cournoyer@gmail.com>2023-07-26 10:40:16 -0400
commit53138a393b64f6fc66c6698c14f565bd9e208d5e (patch)
tree60380266c7630d83c7e75bf2730c751abbb4922e /doc
parent776317e7072979ee87246c8382e63395d7cbfe4b (diff)
downloadguix-53138a393b64f6fc66c6698c14f565bd9e208d5e.tar.gz
services: mpd: Update basic example.
Relates to <https://issues.guix.gnu.org/63082>.

* doc/guix.texi (Audio Services): Do not use a deprecated user form; keep the
default one.  Remove port.  Specify a music-directory.  Mention the importance
of permissions on the music directory.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi19
1 files changed, 15 insertions, 4 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 31643bfacf..58cc3d7aad 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -34241,16 +34241,27 @@ The Music Player Daemon (MPD) is a service that can play music while
 being controlled from the local machine or over the network by a variety
 of clients.
 
-The following example shows how one might run @code{mpd} as user
-@code{"bob"} on port @code{6666}.  It uses pulseaudio for output.
+The following example shows the simplest configuration to locally
+expose, via PulseAudio, a music collection kept at @file{/srv/music},
+with @command{mpd} running as the default @samp{mpd} user.  This user
+will spawn its own PulseAudio daemon, which may compete for the sound
+card access with that of your own user.  In this configuration, you may
+have to stop the playback of your user audio applications to hear MPD's
+output and vice-versa.
 
 @lisp
 (service mpd-service-type
          (mpd-configuration
-          (user "bob")
-          (port "6666")))
+          (music-directory "/srv/music")))
 @end lisp
 
+@quotation Important
+The music directory must be readable to the MPD user, by default,
+@samp{mpd}.  Permission problems will be reported via @samp{Permission
+denied} errors in the MPD logs, which appear in @file{/var/log/messages}
+by default.
+@end quotation
+
 Most MPD clients will trigger a database update upon connecting, but you
 can also use the @code{update} action do to so: