unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
From: Leo Prikler <leo.prikler@student.tugraz.at>
To: 39053@debbugs.gnu.org
Subject: [bug#39053] [PATCH 5/6] doc: Add pulseaudio documentation.
Date: Fri, 10 Jan 2020 02:48:23 +0100	[thread overview]
Message-ID: <20200110014823.10595-5-leo.prikler@student.tugraz.at> (raw)
In-Reply-To: <87blrc1epy.fsf@devup.no>

* 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

  parent reply	other threads:[~2020-01-10  1:50 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-01-09 13:57 [bug#39053] [PATCH] Add pulseaudio configuration and fix volume bugs Leo Prikler
2020-01-09 13:57 ` [bug#39052] [PATCH 1/3] services: Add pulseaudio-configuration Leo Prikler
2020-01-09 13:57 ` [bug#39054] [PATCH 2/3] services: pulseaudio-service-type: Honor /etc Leo Prikler
2020-01-09 13:57 ` [bug#39055] [PATCH 3/3] services: Add pulseaudio to %desktop-services Leo Prikler
2020-01-09 21:50 ` [bug#39053] [PATCH] Add pulseaudio configuration and fix volume bugs Marius Bakke
2020-01-10  1:48   ` [bug#39062] [PATCH 1/6] services: Add pulseaudio-configuration Leo Prikler
2020-01-10  1:48   ` [bug#39061] [PATCH 2/6] services: pulseaudio-service-type: Honor /etc Leo Prikler
2020-01-11 16:57     ` Marius Bakke
2020-01-10  1:48   ` [bug#39053] [PATCH 3/6] services: pulseaudio-configuration: Set flat-volumes to no Leo Prikler
2020-01-11 16:59     ` [bug#39053] [bug#39063] " Marius Bakke
2020-01-10  1:48   ` [bug#39065] [PATCH 4/6] services: Split ladspa-service-type from pulseaudio-service-type Leo Prikler
2020-01-11 17:00     ` [bug#39053] " Marius Bakke
2020-01-10  1:48   ` Leo Prikler [this message]
2020-01-11 17:09     ` [bug#39064] [PATCH 5/6] doc: Add pulseaudio documentation Marius Bakke
2020-01-11 17:25       ` [bug#39053] " Marius Bakke
2020-01-10  1:48   ` [bug#39066] [PATCH 6/6] services: Add pulseaudio to %desktop-services Leo Prikler
2020-01-11 17:10     ` [bug#39053] " Marius Bakke
2020-01-17 16:30     ` [bug#39053] [bug#39066] " Ludovic Courtès
     [not found] ` <87ftglzz3l.fsf@devup.no>
2020-01-11 18:37   ` [bug#39053] [PATCH] Add pulseaudio configuration and fix volume bugs Leo Prikler
2020-01-11 23:49     ` Marius Bakke
2020-01-12  0:32       ` Leo Prikler
2020-01-12 19:55         ` Marius Bakke
2020-01-12 20:22           ` Leo Prikler

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200110014823.10595-5-leo.prikler@student.tugraz.at \
    --to=leo.prikler@student.tugraz.at \
    --cc=39053@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).