mirror of
https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git
synced 2025-10-31 22:25:33 -04:00
7276faca72
When enabled, this method is prefered over pulseaudio's built in systems so we should try our best to ensure that it cannot be spawned outside of the mechanisms desired. Packagers should call 'systemctl --global enable pulseaudio.socket' to enable the socket for all users, or alternatively ship an enabling symlink in /usr/lib/systemd/user/sockets.target.wants/ folder. It may also make sense for distributions to add in a ConditionNNN= line to the socket unit if they have a downstream mechanism for enabling or disabling pulseaudio. If individual users wish to opt out of this vendor (or administrator) decision, they can call 'systemctl --user mask pulseaudio.socket'
139 lines
4.8 KiB
XML
139 lines
4.8 KiB
XML
<?xml version="1.0"?><!--*-nxml-*-->
|
|
<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
|
|
<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
|
|
|
|
<!--
|
|
This file is part of PulseAudio.
|
|
|
|
PulseAudio is free software; you can redistribute it and/or modify it
|
|
under the terms of the GNU Lesser General Public License as
|
|
published by the Free Software Foundation; either version 2.1 of the
|
|
License, or (at your option) any later version.
|
|
|
|
PulseAudio is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
|
|
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
|
|
Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with PulseAudio; if not, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
|
|
USA.
|
|
-->
|
|
|
|
<manpage name="pulse-client.conf" section="5" desc="PulseAudio client configuration file">
|
|
|
|
<synopsis>
|
|
<p><file>~/.config/pulse/client.conf</file></p>
|
|
|
|
<p><file>@PA_DEFAULT_CONFIG_DIR@/client.conf</file></p>
|
|
</synopsis>
|
|
|
|
<description>
|
|
<p>The PulseAudio client library reads configuration directives from
|
|
a file <file>~/.config/pulse/client.conf</file> on startup and when that
|
|
file doesn't exist from
|
|
<file>@PA_DEFAULT_CONFIG_DIR@/client.conf</file>.</p>
|
|
|
|
<p>The configuration file is a simple collection of variable
|
|
declarations. If the configuration file parser encounters either ;
|
|
or # it ignores the rest of the line until its end.</p>
|
|
|
|
<p>For the settings that take a boolean argument the values
|
|
<opt>true</opt>, <opt>yes</opt>, <opt>on</opt> and <opt>1</opt>
|
|
are equivalent, resp. <opt>false</opt>, <opt>no</opt>,
|
|
<opt>off</opt>, <opt>0</opt>.</p>
|
|
|
|
</description>
|
|
|
|
<section name="Directives">
|
|
|
|
<option>
|
|
<p><opt>default-sink=</opt> The default sink to connect to. If
|
|
specified overwrites the setting in the daemon. The environment
|
|
variable <opt>$PULSE_SINK</opt> however takes precedence.</p>
|
|
</option>
|
|
|
|
<option>
|
|
<p><opt>default-source=</opt> The default source to connect
|
|
to. If specified overwrites the setting in the daemon. The
|
|
environment variable <opt>$PULSE_SOURCE</opt> however takes
|
|
precedence.</p>
|
|
</option>
|
|
|
|
<option>
|
|
<p><opt>default-server=</opt> The default sever to connect
|
|
to. The environment variable <opt>$PULSE_SERVER</opt> takes
|
|
precedence.</p>
|
|
</option>
|
|
|
|
<option>
|
|
<p><opt>autospawn=</opt> Autospawn a PulseAudio daemon when
|
|
needed. Takes a boolean value, defaults to <opt>@PA_DEFAULT_AUTOSPAWN@</opt>.</p>
|
|
</option>
|
|
|
|
<option>
|
|
<p><opt>daemon-binary=</opt> Path to the PulseAudio daemon to
|
|
run when autospawning. Defaults to a path configured at compile
|
|
time.</p>
|
|
</option>
|
|
|
|
<option>
|
|
<p><opt>extra-arguments=</opt> Extra arguments to pass to the
|
|
PulseAudio daemon when autospawning. Defaults to
|
|
<opt>--log-target=syslog</opt>
|
|
</p>
|
|
</option>
|
|
|
|
<option>
|
|
<p><opt>cookie-file=</opt> Specify the path to the PulseAudio
|
|
authentication cookie. Defaults to
|
|
<file>~/.config/pulse/cookie</file>.</p>
|
|
</option>
|
|
|
|
<option>
|
|
<p><opt>enable-shm=</opt> Enable data transfer via POSIX
|
|
shared memory. Takes a boolean argument, defaults to
|
|
<opt>yes</opt>.</p>
|
|
</option>
|
|
|
|
<option>
|
|
<p><opt>shm-size-bytes=</opt> Sets the shared memory segment
|
|
size for clients, in bytes. If left unspecified or is set to 0
|
|
it will default to some system-specific default, usually 64
|
|
MiB. 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.</p>
|
|
</option>
|
|
|
|
<option>
|
|
<p><opt>auto-connect-localhost=</opt> Automatically try to
|
|
connect to localhost via IP. Enabling this is a potential
|
|
security hole since connections are only authenticated one-way
|
|
and a rogue server might hence fool a client into sending it its
|
|
private (e.g. VoIP call) data. This was enabled by default on
|
|
PulseAudio version 0.9.21 and older. Defaults to
|
|
<opt>no</opt>.</p>
|
|
</option>
|
|
|
|
<option>
|
|
<p><opt>auto-connect-display=</opt> Automatically try to connect
|
|
to the host X11's $DISPLAY variable is set to. The same security
|
|
issues apply as to <opt>auto-connect-localhost=</opt>. Defaults
|
|
to <opt>no</opt>.</p>
|
|
</option>
|
|
|
|
</section>
|
|
|
|
<section name="Authors">
|
|
<p>The PulseAudio Developers <@PACKAGE_BUGREPORT@>;
|
|
PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
|
|
</section>
|
|
|
|
<section name="See also">
|
|
<p>
|
|
<manref name="pulse-daemon.conf" section="5"/>, <manref name="pulseaudio" section="1"/>
|
|
</p>
|
|
</section>
|
|
|
|
</manpage>
|