| Message ID | 20200110014823.10595-5-leo.prikler@student.tugraz.at |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [bug#39062,1/6] services: Add pulseaudio-configuration. | expand |
| Context | Check | Description |
|---|---|---|
| cbaines/applying patch | fail | Apply failed |
Leo Prikler <leo.prikler@student.tugraz.at> writes: > * doc/guile.texi: Add documentation for pulseaudio-service-type and > pulseaudio-configuration. Ideally this would have been squashed with the first commit, but then we'd have to move ladspa-service-type first, so I kept it as a standalone commit. I also added a copyright notice for you. [...] > +@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. The first sentence of this paragraph is obsolete, no? The second is rather vague, so I opted to remove the whole thing. Let me know if you think something should be added! > +@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 I added a (default: ...) on these two and removed the related sentences.
Marius Bakke <mbakke@fastmail.com> writes: >> +@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 > > I added a (default: ...) on these two and removed the related sentences. I also changed to @var{...} instead of @code{...} for the options; and used @code{...} instead of @var{...} on the defaults after reading the generated HTML.
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.