1pulse-client.conf(5) File Formats Manual pulse-client.conf(5)
2
3
4
6 pulse-client.conf - PulseAudio client configuration file
7
9 ~/.config/pulse/client.conf
10
11 ~/.config/pulse/client.conf.d/*.conf
12
13 /etc/pulse/client.conf
14
15 /etc/pulse/client.conf.d/*.conf
16
18 The PulseAudio client library reads configuration directives from a
19 configuration file on startup. If the per-user file ~/.con‐
20 fig/pulse/client.conf exists, it is used, otherwise the system configu‐
21 ration file /etc/pulse/client.conf is used. In addition to those main
22 files, configuration directives can also be put in files under directo‐
23 ries ~/.config/pulse/client.conf.d/ and /etc/pulse/client.conf.d/.
24 Those files have to have the .conf file name extension, but otherwise
25 the file names can be chosen freely. The files under client.conf.d are
26 processed in alphabetical order. In case the same option is set in mul‐
27 tiple files, the last file to set an option overrides earlier files.
28 The main client.conf file is processed first, so options set in files
29 under client.conf.d override the main file.
30
31 The configuration file is a simple collection of variable declarations.
32 If the configuration file parser encounters either ; or # it ignores
33 the rest of the line until its end.
34
35 For the settings that take a boolean argument the values true, yes, on
36 and 1 are equivalent, resp. false, no, off, 0.
37
39 default-sink= The default sink to connect to. If specified overwrites
40 the setting in the daemon. The environment variable $PULSE_SINK however
41 takes precedence.
42
43 default-source= The default source to connect to. If specified over‐
44 writes the setting in the daemon. The environment variable
45 $PULSE_SOURCE however takes precedence.
46
47 default-server= The default sever to connect to. The environment vari‐
48 able $PULSE_SERVER takes precedence.
49
50 autospawn= Autospawn a PulseAudio daemon when needed. Takes a boolean
51 value, defaults to yes. Note that setting this to "no" doesn't disable
52 the systemd service. The autospawn option is only meant to be used on
53 systems without systemd. If you use systemd to start PulseAudio, use
54 "systemctl --user stop pulseaudio.service pulseaudio.socket" to stop
55 the daemon temporarily, or "systemctl --user mask pulseaudio.service
56 pulseaudio.socket" to permanently disable the units (the "disable" com‐
57 mand of systemctl probably won't work, because the pulseaudio.socket
58 unit is often installed to /usr/lib/systemd/user/sockets.target.wants/,
59 which makes it impossible to disable the unit with the "disable" com‐
60 mand).
61
62 daemon-binary= Path to the PulseAudio daemon to run when autospawning.
63 Defaults to a path configured at compile time.
64
65 extra-arguments= Extra arguments to pass to the PulseAudio daemon when
66 autospawning. Defaults to --log-target=syslog
67
68 cookie-file= Specify the path to the PulseAudio authentication cookie.
69 Defaults to ~/.config/pulse/cookie.
70
71 enable-shm= Enable data transfer via POSIX or memfd shared memory.
72 Takes a boolean argument, defaults to yes. If set to no, communication
73 with the server will be exclusively done through data-copy over sock‐
74 ets.
75
76 enable-memfd=. Enable data transfer via memfd shared memory. Takes a
77 boolean argument, defaults to yes.
78
79 shm-size-bytes= Sets the shared memory segment size for clients, in
80 bytes. If left unspecified or is set to 0 it will default to some sys‐
81 tem-specific default, usually 64 MiB. Please note that usually there is
82 no need to change this value, unless you are running an OS kernel that
83 does not do memory overcommit.
84
85 auto-connect-localhost= Automatically try to connect to localhost via
86 IP. Enabling this is a potential security hole since connections are
87 only authenticated one-way and a rogue server might hence fool a client
88 into sending it its private (e.g. VoIP call) data. This was enabled by
89 default on PulseAudio version 0.9.21 and older. Defaults to no.
90
91 auto-connect-display= Automatically try to connect to the host X11's
92 $DISPLAY variable is set to. The same security issues apply as to auto-
93 connect-localhost=. Defaults to no.
94
96 The PulseAudio Developers <pulseaudio-discuss (at) lists (dot)
97 freedesktop (dot) org>; PulseAudio is available from http://pulseau‐
98 dio.org/
99
101 pulse-daemon.conf(5), pulseaudio(1)
102
103
104
105Manuals User pulse-client.conf(5)