1<?xml version="1.0"?><!--*-nxml-*--> 2<!DOCTYPE manpage SYSTEM "xmltoman.dtd"> 3<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?> 4 5<!-- 6This file is part of PulseAudio. 7 8PulseAudio is free software; you can redistribute it and/or modify it 9under the terms of the GNU Lesser General Public License as 10published by the Free Software Foundation; either version 2.1 of the 11License, or (at your option) any later version. 12 13PulseAudio is distributed in the hope that it will be useful, but WITHOUT 14ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 15or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General 16Public License for more details. 17 18You should have received a copy of the GNU Lesser General Public 19License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>. 20--> 21 22<manpage name="pulse-client.conf" section="5" desc="PulseAudio client configuration file"> 23 24 <synopsis> 25 <p><file>~/.config/pulse/client.conf</file></p> 26 <p><file>~/.config/pulse/client.conf.d/*.conf</file></p> 27 <p><file>@PA_DEFAULT_CONFIG_DIR@/client.conf</file></p> 28 <p><file>@PA_DEFAULT_CONFIG_DIR@/client.conf.d/*.conf</file></p> 29 </synopsis> 30 31 <description> 32 <p>The PulseAudio client library reads configuration directives from 33 a configuration file on startup. If the per-user file 34 <file>~/.config/pulse/client.conf</file> exists, it is used, otherwise the 35 system configuration file <file>@PA_DEFAULT_CONFIG_DIR@/client.conf</file> 36 is used. In addition to those main files, configuration directives can also 37 be put in files under directories 38 <file>~/.config/pulse/client.conf.d/</file> and 39 <file>@PA_DEFAULT_CONFIG_DIR@/client.conf.d/</file>. Those files have to 40 have the .conf file name extension, but otherwise the file names can be 41 chosen freely. The files under client.conf.d are processed in alphabetical 42 order. In case the same option is set in multiple files, the last file to 43 set an option overrides earlier files. The main client.conf file is 44 processed first, so options set in files under client.conf.d override the 45 main file.</p> 46 47 <p>The configuration file is a simple collection of variable 48 declarations. If the configuration file parser encounters either ; 49 or # it ignores the rest of the line until its end.</p> 50 51 <p>For the settings that take a boolean argument the values 52 <opt>true</opt>, <opt>yes</opt>, <opt>on</opt> and <opt>1</opt> 53 are equivalent, resp. <opt>false</opt>, <opt>no</opt>, 54 <opt>off</opt>, <opt>0</opt>.</p> 55 56 </description> 57 58 <section name="Directives"> 59 60 <option> 61 <p><opt>default-sink=</opt> The default sink to connect to. If 62 specified overwrites the setting in the daemon. The environment 63 variable <opt>$PULSE_SINK</opt> however takes precedence.</p> 64 </option> 65 66 <option> 67 <p><opt>default-source=</opt> The default source to connect 68 to. If specified overwrites the setting in the daemon. The 69 environment variable <opt>$PULSE_SOURCE</opt> however takes 70 precedence.</p> 71 </option> 72 73 <option> 74 <p><opt>default-server=</opt> The default sever to connect 75 to. The environment variable <opt>$PULSE_SERVER</opt> takes 76 precedence.</p> 77 </option> 78 79 <option> 80 <p><opt>autospawn=</opt> Autospawn a PulseAudio daemon when needed. Takes 81 a boolean value, defaults to <opt>yes</opt>. Note that setting this to 82 "no" doesn't disable the systemd service. The autospawn option is only 83 meant to be used on systems without systemd. If you use systemd to start 84 PulseAudio, use "systemctl --user stop pulseaudio.service 85 pulseaudio.socket" to stop the daemon temporarily, or "systemctl --user 86 mask pulseaudio.service pulseaudio.socket" to permanently disable the 87 units (the "disable" command of systemctl probably won't work, because 88 the pulseaudio.socket unit is often installed to 89 /usr/lib/systemd/user/sockets.target.wants/, which makes it impossible to 90 disable the unit with the "disable" command).</p> 91 </option> 92 93 <option> 94 <p><opt>daemon-binary=</opt> Path to the PulseAudio daemon to 95 run when autospawning. Defaults to a path configured at compile 96 time.</p> 97 </option> 98 99 <option> 100 <p><opt>extra-arguments=</opt> Extra arguments to pass to the 101 PulseAudio daemon when autospawning. Defaults to 102 <opt>--log-target=syslog</opt> 103 </p> 104 </option> 105 106 <option> 107 <p><opt>cookie-file=</opt> Specify the path to the PulseAudio 108 authentication cookie. Defaults to 109 <file>~/.config/pulse/cookie</file>.</p> 110 </option> 111 112 <option> 113 <p><opt>enable-shm=</opt> Enable data transfer via POSIX 114 or memfd shared memory. Takes a boolean argument, defaults to 115 <opt>yes</opt>. If set to <opt>no</opt>, communication with 116 the server will be exclusively done through data-copy over 117 sockets.</p> 118 </option> 119 120 <option> 121 <p><opt>enable-memfd=</opt>. Enable data transfer via memfd 122 shared memory. Takes a boolean argument, defaults to 123 <opt>yes</opt>.</p> 124 </option> 125 126 <option> 127 <p><opt>shm-size-bytes=</opt> Sets the shared memory segment 128 size for clients, in bytes. If left unspecified or is set to 0 129 it will default to some system-specific default, usually 64 130 MiB. Please note that usually there is no need to change this 131 value, unless you are running an OS kernel that does not do 132 memory overcommit.</p> 133 </option> 134 135 <option> 136 <p><opt>auto-connect-localhost=</opt> Automatically try to 137 connect to localhost via IP. Enabling this is a potential 138 security hole since connections are only authenticated one-way 139 and a rogue server might hence fool a client into sending it its 140 private (e.g. VoIP call) data. This was enabled by default on 141 PulseAudio version 0.9.21 and older. Defaults to 142 <opt>no</opt>.</p> 143 </option> 144 145 <option> 146 <p><opt>auto-connect-display=</opt> Automatically try to connect 147 to the host X11's $DISPLAY variable is set to. The same security 148 issues apply as to <opt>auto-connect-localhost=</opt>. Defaults 149 to <opt>no</opt>.</p> 150 </option> 151 152 </section> 153 154 <section name="Authors"> 155 <p>The PulseAudio Developers <@PACKAGE_BUGREPORT@>; 156 PulseAudio is available from <url href="@PACKAGE_URL@"/></p> 157 </section> 158 159 <section name="See also"> 160 <p> 161 <manref name="pulse-daemon.conf" section="5"/>, <manref name="pulseaudio" section="1"/> 162 </p> 163 </section> 164 165</manpage> 166