[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
06/07: doc: Add pulseaudio documentation.
From: |
guix-commits |
Subject: |
06/07: doc: Add pulseaudio documentation. |
Date: |
Sat, 11 Jan 2020 12:22:57 -0500 (EST) |
mbakke pushed a commit to branch master
in repository guix.
commit fc29f3bf4f0642f1634af8b6f73aee83ca6711f6
Author: Leo Prikler <address@hidden>
AuthorDate: Fri Jan 10 02:48:23 2020 +0100
doc: Add pulseaudio documentation.
* doc/guile.texi: Add documentation for pulseaudio-service-type and
pulseaudio-configuration.
Signed-off-by: Marius Bakke <address@hidden>
---
doc/guix.texi | 37 +++++++++++++++++++++++++++++++++++++
1 file changed, 37 insertions(+)
diff --git a/doc/guix.texi b/doc/guix.texi
index af6ffbb..d2038d1 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -69,6 +69,7 @@ Copyright @copyright{} 2019 Jakob L. Kreuze@*
Copyright @copyright{} 2019 Kyle Andrews@*
Copyright @copyright{} 2019 Alex Griffin@*
Copyright @copyright{} 2019 Guillaume Le Vaillant@*
+Copyright @copyright{} 2020 Leo Prikler@*
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -15951,6 +15952,42 @@ pcm.!default @{
See @uref{https://www.alsa-project.org/main/index.php/Asoundrc} for the
details.
+@deffn {Scheme Variable} pulseaudio-service-type
+This is the type for the @uref{http://www.pulseaudio.org/, PulseAudio}
+sound server. It exists to allow system overrides of the default settings
+via @code{pulseaudio-configuration}, see below.
+
+@quotation Warning
+This service on its own does not ensure, that the @code{pulseaudio} package
+exists on your machine. It merely adds configuration files for it, as
+detailed below. In the (admittedly unlikely) case, that you find yourself
+without a @code{pulseaudio} package, consider enabling it through the
+@code{alsa-service-type} above.
+@end quotation
+@end deffn
+
+@deftp {Data Type} pulseaudio-configuration
+Data type representing the configuration for @code{pulseaudio-service}.
+
+@table @asis
+@item @var{client-conf} (default: @code{'()})
+List of settings to set in @file{client.conf}.
+Accepts a list of strings or a symbol-value pairs. A string will be
+inserted as-is with a newline added. A pair will be formatted as
+``key = value'', again with a newline added.
+
+@item @var{daemon-conf} (default: @code{'((flat-volumes . no))})
+List of settings to set in @file{daemon.conf}, formatted just like
+@var{client-conf}.
+
+@item @var{script-file} (default: @code{(file-append pulseaudio
"/etc/pulse/default.pa")})
+Script file to use as as @file{default.pa}.
+
+@item @var{system-script-file} (default: @code{(file-append pulseaudio
"/etc/pulse/system.pa")})
+Script file to use as as @file{system.pa}.
+@end table
+@end deftp
+
@deffn {Scheme Variable} ladspa-service-type
This service sets the @var{LADSPA_PATH} variable, so that programs, which
respect it, e.g. PulseAudio, can load LADSPA plugins.
- branch master updated (efc32ed -> 71e33e3), guix-commits, 2020/01/11
- 01/07: gnu: Add qtwebengine., guix-commits, 2020/01/11
- 04/07: services: pulseaudio-configuration: Set flat-volumes to no., guix-commits, 2020/01/11
- 03/07: services: Add pulseaudio-configuration., guix-commits, 2020/01/11
- 02/07: gnu: qtwebengine: Purge unnecessary bundled software from the source., guix-commits, 2020/01/11
- 05/07: services: Split ladspa-service-type from pulseaudio-service-type., guix-commits, 2020/01/11
- 06/07: doc: Add pulseaudio documentation.,
guix-commits <=
- 07/07: services: Add pulseaudio to %desktop-services., guix-commits, 2020/01/11