"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "man/pulse-daemon.conf.5" between
pulseaudio-14.0.tar.xz and pulseaudio-14.2.tar.xz

About: PulseAudio is a networked sound server (for POSIX OSes), a proxy for your sound applications.

pulse-daemon.conf.5  (pulseaudio-14.0.tar.xz):pulse-daemon.conf.5  (pulseaudio-14.2.tar.xz)
pulse-daemon.conf(5) File Formats Manual pulse-daemon.conf(5) pulse-daemon.conf(5) File Formats Manual pulse-daemon.conf(5)
NAME NAME
pulse-daemon.conf - PulseAudio daemon configuration file pulse-daemon.conf - PulseAudio daemon configuration file
SYNOPSIS SYNOPSIS
~/.config/pulse/daemon.conf ~/.config/pulse/daemon.conf
~/.config/pulse/daemon.conf.d/*.conf ~/.config/pulse/daemon.conf.d/*.conf
/home/arun/code/pulseaudio/pulseaudio/build-old/install-old/etc/pulse/dae mon.conf /usr/local/etc/pulse/daemon.conf
/home/arun/code/pulseaudio/pulseaudio/build-old/install-old/etc/pulse/dae mon.conf.d/*.conf /usr/local/etc/pulse/daemon.conf.d/*.conf
DESCRIPTION DESCRIPTION
The PulseAudio sound server reads configuration directives from a conf iguration file on startup. If the The PulseAudio sound server reads configuration directives from a conf iguration file on startup. If the
per-user file ~/.config/pulse/daemon.conf exists, it is used, otherwise the system configuration file per-user file ~/.config/pulse/daemon.conf exists, it is used, otherwise the system configuration file
/home/arun/code/pulseaudio/pulseaudio/build-old/install-old/etc/pulse/dae /usr/local/etc/pulse/daemon.conf is used. In addition to those main fi
mon.conf is used. In addition to les, configuration directives can
those main files, configuration directives can also be put in files under also be put in files under directories ~/.config/pulse/daemon.conf.d
directories ~/.config/pulse/dae- / and /usr/local/etc/pulse/dae-
mon.conf.d/ and /home/arun/code/pulseaudio/pulseaudio/build-old/inst mon.conf.d/. Those files have to have the .conf file name extension, bu
all-old/etc/pulse/daemon.conf.d/. t otherwise the file names can be
Those files have to have the .conf file name extension, but otherwise the chosen freely. The files under daemon.conf.d are processed in alphabetica
file names can be chosen freely. l order. In case the same option
The files under daemon.conf.d are processed in alphabetical order. In ca is set in multiple files, the last file to set an option overrides ea
se the same option is set in mul- rlier files. The main daemon.conf
tiple files, the last file to set an option overrides earlier files. The file is processed first, so options set in files under daemon.conf.d over
main daemon.conf file is pro- ride the main file.
cessed first, so options set in files under daemon.conf.d override the ma
in file.
Please note that the server also reads a configuration script on startup. See default.pa(5). Please note that the server also reads a configuration script on startup. See default.pa(5).
The configuration file is a simple collection of variable declarations. If the configuration file parser The configuration file is a simple collection of variable declarations. I f the configuration file parser
encounters either ; or # it ignores the rest of the line until its end. encounters either ; or # it ignores the rest of the line until its end.
For the settings that take a boolean argument the values true, yes, on an d 1 are equivalent, resp. false, For the settings that take a boolean argument the values true, yes, on a nd 1 are equivalent, resp. false,
no, off, 0. no, off, 0.
GENERAL DIRECTIVES GENERAL DIRECTIVES
daemonize= Daemonize after startup. Takes a boolean value, defaults to no. The --daemonize command line daemonize= Daemonize after startup. Takes a boolean value, defaults to no . The --daemonize command line
option takes precedence. option takes precedence.
fail= Fail to start up if any of the directives in the configuration scri pt default.pa fail. Takes a bool- fail= Fail to start up if any of the directives in the configuration scri pt default.pa fail. Takes a bool-
ean argument, defaults to yes. The --fail command line option takes prece dence. ean argument, defaults to yes. The --fail command line option takes prece dence.
allow-module-loading= Allow/disallow module loading after startup. This i s a security feature that if dis- allow-module-loading= Allow/disallow module loading after startup. This i s a security feature that if dis-
abled makes sure that no further modules may be loaded into the PulseAudi o server after startup completed. abled makes sure that no further modules may be loaded into the PulseAudi o server after startup completed.
It is recommended to disable this when system-instance is enabled. Pleas It is recommended to disable this when system-instance is enabled. Please
e note that certain features like note that certain features like
automatic hot-plug support will not work if this option is enabled. Takes automatic hot-plug support will not work if this option is enabled. Take
a boolean argument, defaults to s a boolean argument, defaults to
yes. The --disallow-module-loading command line option takes precedence. yes. The --disallow-module-loading command line option takes precedence.
allow-exit= Allow/disallow exit on user request. Defaults to yes. allow-exit= Allow/disallow exit on user request. Defaults to yes.
resample-method= The resampling algorithm to use. Use one of src-sinc-be resample-method= The resampling algorithm to use. Use one of src-sinc-bes
st-quality, src-sinc-medium-qual- t-quality, src-sinc-medium-qual-
ity, src-sinc-fastest, src-zero-order-hold, src-linear, trivial, speex- ity, src-sinc-fastest, src-zero-order-hold, src-linear, trivial, spee
float-N, speex-fixed-N, ffmpeg, x-float-N, speex-fixed-N, ffmpeg,
soxr-mq, soxr-hq, soxr-vhq. See the documentation of libsamplerate and s soxr-mq, soxr-hq, soxr-vhq. See the documentation of libsamplerate and sp
peex for explanations of the dif- eex for explanations of the dif-
ferent src- and speex- methods, respectively. The method trivial is the m ferent src- and speex- methods, respectively. The method trivial is the
ost basic algorithm implemented. most basic algorithm implemented.
If you're tight on CPU consider using this. On the other hand it has t If you're tight on CPU consider using this. On the other hand it has the
he worst quality of them all. The worst quality of them all. The
Speex resamplers take an integer quality setting in the range 0..10 (b Speex resamplers take an integer quality setting in the range 0..1
ad...good). They exist in two 0 (bad...good). They exist in two
flavours: fixed and float. The former uses fixed point numbers, the lat flavours: fixed and float. The former uses fixed point numbers, the latte
ter relies on floating point num- r relies on floating point num-
bers. On most desktop CPUs the float point resampler is a lot faster, and bers. On most desktop CPUs the float point resampler is a lot faster, a
it also offers slightly better nd it also offers slightly better
quality. The soxr-family methods are based on libsoxr, a resampler libr quality. The soxr-family methods are based on libsoxr, a resampler librar
ary from the SoX sound processing y from the SoX sound processing
utility. The mq variant has the best performance of the three. The hq is utility. The mq variant has the best performance of the three. The hq is
more expensive and, according to more expensive and, according to
SoX developers, is considered the best choice for audio of up to 16 bit SoX developers, is considered the best choice for audio of up to 16 bits
s per sample. The vhq variant has per sample. The vhq variant has
more precision than hq and is more suitable for larger samples. The Soxr resamplers generally offer better more precision than hq and is more suitable for larger samples. The Soxr resamplers generally offer better
quality at less CPU compared to other resamplers, such as speex. The dow quality at less CPU compared to other resamplers, such as speex. The down
nside is that they can add a sig- side is that they can add a sig-
nificant delay to the output (usually up to around 20 ms, in rare cases m nificant delay to the output (usually up to around 20 ms, in rare cas
ore). See the output of dump- es more). See the output of dump-
resample-methods for a complete list of all available resamplers. Defaul resample-methods for a complete list of all available resamplers. Default
ts to speex-float-1. The --resam- s to speex-float-1. The --resam-
ple-method command line option takes precedence. Note that some modules o ple-method command line option takes precedence. Note that some modules
verwrite or allow overwriting of overwrite or allow overwriting of
the resampler to use. the resampler to use.
avoid-resampling= If set, try to configure the device to avoid resam avoid-resampling= If set, try to configure the device to avoid resampling
pling. This only works on devices . This only works on devices
which support reconfiguring their rate, and when no other streams are alr which support reconfiguring their rate, and when no other streams are al
eady playing or capturing audio. ready playing or capturing audio.
The device will also not be configured to a rate less than the default an d alternate sample rates. The device will also not be configured to a rate less than the default an d alternate sample rates.
enable-remixing= If disabled never upmix or downmix channels to different channel maps. Instead, do a sim- enable-remixing= If disabled never upmix or downmix channels to different channel maps. Instead, do a sim-
ple name-based matching only. Defaults to yes. There is no known valid us e case for setting this option to ple name-based matching only. Defaults to yes. There is no known valid us e case for setting this option to
no, therefore, this option is deprecated and may be removed in a future v ersion of PulseAudio. no, therefore, this option is deprecated and may be removed in a future v ersion of PulseAudio.
remixing-use-all-sink-channels= If enabled, use all sink channels when remixing-use-all-sink-channels= If enabled, use all sink channels when re
remixing. Otherwise, remix to the mixing. Otherwise, remix to the
minimal set of sink channels needed to reproduce all of the source channe minimal set of sink channels needed to reproduce all of the source cha
ls. (This has no effect on LFE nnels. (This has no effect on LFE
remixing.) Defaults to yes. remixing.) Defaults to yes.
enable-lfe-remixing= This is a way to set remixing-produce-lfe and remix enable-lfe-remixing= This is a way to set remixing-produce-lfe and remixi
ing-consume-lfe to the same value ng-consume-lfe to the same value
at once. This option only exists for backward compatibility and may be re at once. This option only exists for backward compatibility and may
moved in a future version of be removed in a future version of
PulseAudio. PulseAudio.
remixing-produce-lfe= If enabled, and the sink input does not have the L remixing-produce-lfe= If enabled, and the sink input does not have the LF
FE channel, synthesize the output E channel, synthesize the output
LFE channel as a (lowpass-filtered, if lfe-crossover-freq is not 0) avera LFE channel as a (lowpass-filtered, if lfe-crossover-freq is not 0) ave
ge of all input channels. Also, rage of all input channels. Also,
when lfe-crossover-freq is not 0, filter out low frequencies from othe when lfe-crossover-freq is not 0, filter out low frequencies from other c
r channels while producing a syn- hannels while producing a syn-
thetic LFE output. If disabled, the output LFE channel will only get a si gnal when an input LFE channel is thetic LFE output. If disabled, the output LFE channel will only get a si gnal when an input LFE channel is
available as well. Defaults to no. available as well. Defaults to no.
remixing-consume-lfe= If enabled, and the sink does not have an LFE chan remixing-consume-lfe= If enabled, and the sink does not have an LFE chann
nel, redirect the input LFE chan- el, redirect the input LFE chan-
nel (if any) to other channels. If disabled, the input LFE channel will r nel (if any) to other channels. If disabled, the input LFE channel will
emain unused unless the sink has remain unused unless the sink has
the LFE channel as well. Defaults to no. the LFE channel as well. Defaults to no.
lfe-crossover-freq= The crossover frequency (in Hz) for the LFE filte r. Set it to 0 to disable the LFE lfe-crossover-freq= The crossover frequency (in Hz) for the LFE filter. S et it to 0 to disable the LFE
filter. Defaults to 0. filter. Defaults to 0.
use-pid-file= Create a PID file in the runtime directory ($XDG_RUNTIME_DI R/pulse/pid). If this is enabled use-pid-file= Create a PID file in the runtime directory ($XDG_RUNTIME_D IR/pulse/pid). If this is enabled
you may use commands like --kill or --check. If you are planning to start more than one PulseAudio process you may use commands like --kill or --check. If you are planning to start more than one PulseAudio process
per user, you better disable this option since it effectively disables mu ltiple instances. Takes a boolean per user, you better disable this option since it effectively disables mu ltiple instances. Takes a boolean
argument, defaults to yes. The --use-pid-file command line option takes p recedence. argument, defaults to yes. The --use-pid-file command line option takes p recedence.
cpu-limit= If disabled do not install the CPU load limiter, even on plat cpu-limit= If disabled do not install the CPU load limiter, even on platf
forms where it is supported. This orms where it is supported. This
option is useful when debugging/profiling PulseAudio to disable disturbin option is useful when debugging/profiling PulseAudio to disable disturbi
g SIGXCPU signals. Takes a bool- ng SIGXCPU signals. Takes a bool-
ean argument, defaults to no. The --no-cpu-limit command line argument ta kes precedence. ean argument, defaults to no. The --no-cpu-limit command line argument ta kes precedence.
system-instance= Run the daemon as system-wide instance, requires root privileges. Takes a boolean argu- system-instance= Run the daemon as system-wide instance, requires root pr ivileges. Takes a boolean argu-
ment, defaults to no. The --system command line argument takes precedence . ment, defaults to no. The --system command line argument takes precedence .
local-server-type= Please don't use this option if you don't have to! Thi s option is currently only useful local-server-type= Please don't use this option if you don't have to! Thi s option is currently only useful
when you want D-Bus clients to use a remote server. This option may be r when you want D-Bus clients to use a remote server. This option may be re
emoved in future versions. If you moved in future versions. If you
only want to run PulseAudio in the system mode, use the system-instance o only want to run PulseAudio in the system mode, use the system-instance
ption. This option takes one of option. This option takes one of
user, system or none as the argument. This is essentially a duplicate fo user, system or none as the argument. This is essentially a duplicate for
r the system-instance option. The the system-instance option. The
difference is the none option, which is useful when you want to use a rem ote server with D-Bus clients. If difference is the none option, which is useful when you want to use a rem ote server with D-Bus clients. If
both this and system-instance are defined, this option takes precedence. Defaults to whatever the system- both this and system-instance are defined, this option takes precedence. Defaults to whatever the system-
instance is set. instance is set.
enable-shm= Enable data transfer via POSIX or memfd shared memory. Takes a boolean argument, defaults to enable-shm= Enable data transfer via POSIX or memfd shared memory. Take s a boolean argument, defaults to
yes. The --disable-shm command line argument takes precedence. yes. The --disable-shm command line argument takes precedence.
enable-memfd=. Enable memfd shared memory. Takes a boolean argument, defa ults to yes. enable-memfd=. Enable memfd shared memory. Takes a boolean argument, defa ults to yes.
shm-size-bytes= Sets the shared memory segment size for the daemon, in shm-size-bytes= Sets the shared memory segment size for the daemon, in by
bytes. If left unspecified or is tes. If left unspecified or is
set to 0 it will default to some system-specific default, usually 64 MiB. set to 0 it will default to some system-specific default, usually 64 Mi
Please note that usually there B. Please note that usually there
is no need to change this value, unless you are running an OS kernel that does not do memory overcommit. is no need to change this value, unless you are running an OS kernel that does not do memory overcommit.
lock-memory= Locks the entire PulseAudio process into memory. While th lock-memory= Locks the entire PulseAudio process into memory. While this
is might increase drop-out safety might increase drop-out safety
when used in conjunction with real-time scheduling this takes away a lot when used in conjunction with real-time scheduling this takes away a l
of memory from other processes ot of memory from other processes
and might hence considerably slow down your system. Defaults to no. and might hence considerably slow down your system. Defaults to no.
flat-volumes= Enable 'flat' volumes, i.e. where possible let the sink vol ume equal the maximum of the vol- flat-volumes= Enable 'flat' volumes, i.e. where possible let the sink vol ume equal the maximum of the vol-
umes of the inputs connected to it. Takes a boolean argument, defaults to no. umes of the inputs connected to it. Takes a boolean argument, defaults to no.
rescue-streams= Enable rescuing of streams if the used sink or source bec omes unavailable. Takes a boolean rescue-streams= Enable rescuing of streams if the used sink or source bec omes unavailable. Takes a boolean
argument. If set to yes, pulseaudio will try to move the streams f argument. If set to yes, pulseaudio will try to move the streams from a
rom a sink or source that becomes sink or source that becomes
unavailable to the default sink or source. If set to no, streams will be unavailable to the default sink or source. If set to no, streams will be
killed if the corresponding sink killed if the corresponding sink
or source disappears. Defaults to yes. or source disappears. Defaults to yes.
SCHEDULING SCHEDULING
high-priority= Renice the daemon after startup to become a high-priority high-priority= Renice the daemon after startup to become a high-priority
process. This a good idea if you process. This a good idea if you
experience drop-outs during playback. However, this is a certain securit experience drop-outs during playback. However, this is a certain se
y issue, since it works when curity issue, since it works when
called SUID root only, or RLIMIT_NICE is used. root is dropped immediatel y after gaining the nice level on called SUID root only, or RLIMIT_NICE is used. root is dropped immediatel y after gaining the nice level on
startup, thus it is presumably safe. See pulseaudio(1) for more informati on. Takes a boolean argument, startup, thus it is presumably safe. See pulseaudio(1) for more infor mation. Takes a boolean argument,
defaults to yes. The --high-priority command line option takes precedence . defaults to yes. The --high-priority command line option takes precedence .
realtime-scheduling= Try to acquire SCHED_FIFO scheduling for the IO th realtime-scheduling= Try to acquire SCHED_FIFO scheduling for the IO thre
reads. The same security concerns ads. The same security concerns
as mentioned above apply. However, if PA enters an endless loop, realti as mentioned above apply. However, if PA enters an endless loop, re
me scheduling causes a system altime scheduling causes a system
lockup. Thus, realtime scheduling should only be enabled on trusted m lockup. Thus, realtime scheduling should only be enabled on trusted machi
achines for now. Please note that nes for now. Please note that
only the IO threads of PulseAudio are made real-time. The controlling thr only the IO threads of PulseAudio are made real-time. The controlling th
ead is left a normally scheduled read is left a normally scheduled
thread. Thus enabling the high-priority option is orthogonal. See pu thread. Thus enabling the high-priority option is orthogonal. See pulse
lseaudio(1) for more information. audio(1) for more information.
Takes a boolean argument, defaults to yes. The --realtime command line op tion takes precedence. Takes a boolean argument, defaults to yes. The --realtime command line op tion takes precedence.
realtime-priority= The realtime priority to acquire, if realtime-scheduli ng is enabled. Note: JACK uses 10 realtime-priority= The realtime priority to acquire, if realtime-scheduli ng is enabled. Note: JACK uses 10
by default, 9 for clients. Thus it is recommended to choose the Pulse by default, 9 for clients. Thus it is recommended to choose the PulseAud
Audio real-time priorities lower. io real-time priorities lower.
Some PulseAudio threads might choose a priority a little lower or hig Some PulseAudio threads might choose a priority a little lower or
her than the specified value. higher than the specified value.
Defaults to 5. Defaults to 5.
nice-level= The nice level to acquire for the daemon, if high-priority is enabled. Note: on some distribu- nice-level= The nice level to acquire for the daemon, if high-priority is enabled. Note: on some distribu-
tions X11 uses -10 by default. Defaults to -11. tions X11 uses -10 by default. Defaults to -11.
IDLE TIMES IDLE TIMES
exit-idle-time= Terminate the daemon after the last client quit and this exit-idle-time= Terminate the daemon after the last client quit and t
time in seconds passed. Use a his time in seconds passed. Use a
negative value to disable this feature. Defaults to 20. The --exit-id negative value to disable this feature. Defaults to 20. The --exit-idle-t
le-time command line option takes ime command line option takes
precedence. precedence.
When PulseAudio runs in the per-user mode and detects a login sess ion, then any positive value will When PulseAudio runs in the per-user mode and detects a login sess ion, then any positive value will
be reset to 0 so that PulseAudio will terminate immediately on l ogout. A positive value therefore be reset to 0 so that PulseAudio will terminate immediately on log out. A positive value therefore
has effect only in environments where there's no support for login session tracking (or if the user has effect only in environments where there's no support for login session tracking (or if the user
is logged in without a session spawned, a.k.a. lingering). A ne gative value can still be used to is logged in without a session spawned, a.k.a. lingering). A negat ive value can still be used to
disable any automatic exit. disable any automatic exit.
When PulseAudio runs in the system mode, automatic exit is always disabled, so this option does When PulseAudio runs in the system mode, automatic exit is alw ays disabled, so this option does
nothing. nothing.
scache-idle-time= Unload autoloaded sample cache entries after bei ng idle for this time in seconds. scache-idle-time= Unload autoloaded sample cache entries after being id le for this time in seconds.
Defaults to 20. The --scache-idle-time command line option takes preceden ce. Defaults to 20. The --scache-idle-time command line option takes preceden ce.
PATHS PATHS
dl-search-path= The path where to look for dynamic shared objects (DSOs/p lugins). You may specify more dl-search-path= The path where to look for dynamic shared objects (DS Os/plugins). You may specify more
than one path separated by colons. The default path depends on compile ti me settings. The --dl-search-path than one path separated by colons. The default path depends on compile ti me settings. The --dl-search-path
command line option takes precedence. command line option takes precedence.
default-script-file= The default configuration script file to load. Speci default-script-file= The default configuration script file to load. Spec
fy an empty string for not load- ify an empty string for not load-
ing a default script file. The default behaviour is to load ~/.config/p ing a default script file. The default behaviour is to load ~/.config/pul
ulse/default.pa, and if that file se/default.pa, and if that file
does not exist fall back to the system wide installed version /home/arun/ does not exist fall back to the system wide installed version /usr/loca
code/pulseaudio/pulseaudio/build- l/etc/pulse/default.pa. If run in
old/install-old/etc/pulse/default.pa. If run in system-wide mode th system-wide mode the file /usr/local/etc/pulse/system.pa is used instead.
e file /home/arun/code/pulseau- If -n is passed on the command
dio/pulseaudio/build-old/install-old/etc/pulse/system.pa is used instead.
If -n is passed on the command
line or default-script-file= is disabled the default configuration script is ignored. line or default-script-file= is disabled the default configuration script is ignored.
load-default-script-file= Load the default configuration script file as s pecified in default-script-file=. load-default-script-file= Load the default configuration script file as s pecified in default-script-file=.
Defaults to yes. Defaults to yes.
LOGGING LOGGING
log-target= The default log target. Use either stderr, syslog, journal (o ptional), auto, file:PATH or new- log-target= The default log target. Use either stderr, syslog, journal (o ptional), auto, file:PATH or new-
file:PATH. On traditional systems auto is equivalent to syslog. On system d-enabled systems, auto is equiv- file:PATH. On traditional systems auto is equivalent to syslog. On system d-enabled systems, auto is equiv-
alent to journal, in case daemonize is enabled, and to stderr otherwise. If set to file:PATH, logging is alent to journal, in case daemonize is enabled, and to stderr otherwise. If set to file:PATH, logging is
directed to the file indicated by PATH. newfile:PATH is otherwise th e same as file:PATH, but existing directed to the file indicated by PATH. newfile:PATH is otherwise th e same as file:PATH, but existing
 End of changes. 35 change blocks. 
140 lines changed or deleted 136 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)