From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:470:142:3::10]:39070) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ipjRB-00071J-TI for guix-patches@gnu.org; Thu, 09 Jan 2020 20:50:11 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ipjRA-0002jm-HQ for guix-patches@gnu.org; Thu, 09 Jan 2020 20:50:09 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:47442) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1ipjRA-0002if-8r for guix-patches@gnu.org; Thu, 09 Jan 2020 20:50:08 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1ipjRA-0003lR-5F for guix-patches@gnu.org; Thu, 09 Jan 2020 20:50:08 -0500 Subject: [bug#39053] [PATCH 5/6] doc: Add pulseaudio documentation. Resent-Message-ID: From: Leo Prikler Date: Fri, 10 Jan 2020 02:48:23 +0100 Message-Id: <20200110014823.10595-5-leo.prikler@student.tugraz.at> In-Reply-To: <87blrc1epy.fsf@devup.no> References: <87blrc1epy.fsf@devup.no> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+kyle=kyleam.com@gnu.org Sender: "Guix-patches" To: 39053@debbugs.gnu.org * doc/guile.texi: Add documentation for pulseaudio-service-type and pulseaudio-configuration. --- doc/guix.texi | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/doc/guix.texi b/doc/guix.texi index 431895aa7d..05d826f6d8 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -15951,6 +15951,48 @@ 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 @code{client-conf} (default: @var{()}) +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 @code{daemon-conf} (default: @var{((flat-volumes . no))}) +List of settings to set in @file{daemon.conf}, formatted just like +@code{client-conf}. + +In addition to the above, @code{default-script-file} will be set to the +value of @code{script-file}. By default, @var{flat-volumes} is set to +``no'', so as to avoid bugs related to this feature. + +@item @code{script-file} +Script file to use as as @file{default.pa}. Defaults to the one included by +the @code{pulseaudio} package. + +@item @code{system-script-file} +Script file to use as as @file{system.pa}. Defaults to the one included by +the @code{pulseaudio} package. +@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. -- 2.24.1