20867N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
20867N/A<!--ArborText, Inc., 2011, v.4002-->
20867N/A<!ENTITY cmd "pulse-client.conf">
20867N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
20867N/A%commonents;
20867N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
20867N/A%booktitles;
20867N/A<!ENTITY suncopy "Copyright (c) 2003,2006,2007 Sun Microsystems, Inc. All Rights Reserved.">
20867N/A]>
20867N/A<?Pub UDT _bookmark _target>
20867N/A<?Pub Inc>
20867N/A<refentry id="pules-client.conf-5">
20867N/A<!-- %Z%%M% %I% %E% SMI; -->
20867N/A<refmeta><refentrytitle>pulse-client.conf</refentrytitle><manvolnum>5</manvolnum>
20867N/A<refmiscinfo class="date">11 Oct 2011</refmiscinfo>
20867N/A<refmiscinfo class="sectdesc">&man5;</refmiscinfo>
20867N/A<refmiscinfo class="software">&release;</refmiscinfo>
20867N/A<refmiscinfo class="arch">generic</refmiscinfo>
20867N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
20867N/A</refmeta>
20867N/A<indexterm><primary>pulse-client.conf</primary></indexterm><indexterm><primary>
20867N/APulseAudio client configuration file</primary></indexterm>
20867N/A<refnamediv id="pulse-client.conf-5-name"><refname>pulse-client.conf</refname><refpurpose>
20867N/APulseAudio client configuration file</refpurpose></refnamediv>
20867N/A
20867N/A<refsynopsisdiv id="pulse-client.conf-5-synp"><title>&synp-tt;</title>
20867N/A<cmdsynopsis><file>~/.pulse/client.conf</file></cmdsynopsis>
20867N/A<cmdsynopsis><file>~/etc/pulse/client.conf</file></cmdsynopsis>
20867N/A</refsynopsisdiv>
20867N/A
20867N/A<refsect1 id="pulse-client.conf-5-desc"><title>&desc-tt;</title>
20867N/A<para>
20867N/AThe PulseAudio client library reads configuration directives from a file
20867N/A<filename>~/.pulse/client.conf</filename> on startup and when that file does
20867N/Anot exist from <filename>/etc/pulse/client.conf</filename>.
20867N/A</para>
20867N/A
20867N/A<para>
20867N/AThe configuration file is a simple collection of variable declarations. If the
20867N/Aconfiguration file parser encounters either ; or # it ignores the rest of the
20867N/Aline until its end.
20867N/A</para>
20867N/A
20867N/A<para>
20867N/AFor the settings that take a boolean argument the values true, yes, on and 1
20867N/Aare equivalent, resp. false, no, off, 0.
20867N/A</para>
20867N/A</refsect1>
20867N/A
20867N/A<refsect1 id="pulse-client.conf-5-params"><title>&parm-tt;</title>
20867N/A<para>The following configuration options are supported:</para>
20867N/A<variablelist termlength="wholeline">
20867N/A
20867N/A<varlistentry>
20867N/A<term>default_sink=</term>
20867N/A<listitem><para>
20867N/AThe default sink to connect to. If specified overwrites the setting in the
20867N/Adaemon. The environment variable $PULSE_SINK however takes precedence.
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term>default-source=</term>
20867N/A<listitem><para>
20867N/AThe default source to connect to. If specified overwrites the setting in the
20867N/Adaemon. The environment variable $PULSE_SOURCE however takes precedence.
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term>default-server=</term>
20867N/A<listitem><para>
20867N/AThe default sever to connect to. The environment variable $PULSE_SERVER takes
20867N/Aprecedence.
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term>autospawn=</term>
20867N/A<listitem><para>
20867N/AAutospawn a PulseAudio daemon when needed. Takes a boolean value, defaults to
20867N/Ayes.
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term>daemon-binary=</term>
20867N/A<listitem><para>
20867N/APath to the PulseAudio daemon to run when autospawning. Defaults to a path
20867N/Aconfigured at compile time.
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term>extra-arguments=</term>
20867N/A<listitem><para>
20867N/AExtra arguments to pass to the PulseAudio daemon when autospawning. Defaults to
20867N/A<option>-log-target=syslog</option>
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term>cookie-file=</term>
20867N/A<listitem><para>
20867N/ASpecify the path to the PulseAudio authentication cookie. Defaults to
20867N/A<filename>~/.pulse-cookie</filename>
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term>enable-shm=</term>
20867N/A<listitem><para>
20867N/AEnable data transfer via POSIX shared memory. Takes a boolean argument,
20867N/Adefaults to yes.
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term>shm-size-bytes=</term>
20867N/A<listitem><para>
20867N/ASets the shared memory segment size for clients, in bytes. If left unspecified
20867N/Aor is set to 0 it will default to some system-specific default, usually 64 MiB.
20867N/APlease note that usually there is no need to change this value, unless you are
20867N/Arunning an OS kernel that does not do memory overcommit.
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term>auto-connect-localhost=</term>
20867N/A<listitem><para>
20867N/AAutomatically try to connect to localhost via IP. Enabling this is a potential
20867N/Asecurity hole since connections are only authenticated one-way and a rogue
20867N/Aserver might hence fool a client into sending it its private (e.g. VoIP call)
20867N/Adata. This was enabled by default on PulseAudio version 0.9.21 and older.
20867N/ADefaults to no.
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term>auto-connect-display=</term>
20867N/A<listitem><para>
20867N/AAutomatically try to connect to the host X11's $DISPLAY variable is set to. The
20867N/Asame security issues apply as to auto-connect-localhost=. Defaults to no.
20867N/A</para></listitem></varlistentry>
20867N/A</variablelist></refsect1>
20867N/A
20867N/A<refsect1 id="pulse-client.conf-5-envr"><title>&envr-tt;</title>
20867N/A<para>See <citerefentry><refentrytitle>environ</refentrytitle><manvolnum>
20867N/A5</manvolnum></citerefentry> for descriptions of the following environment
20867N/Avariables:</para>
20867N/A
20867N/A<variablelist>
20867N/A<varlistentry>
20867N/A<term>PULSE_CLIENTCONFIG</term>
20867N/A<listitem><para>
20867N/ASpecify the file that will be read instead of <filename>client.conf</filename>
20867N/Afor client configuration.
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term>PULSE_SINK</term>
20867N/A<listitem><para>
20867N/ASpecify the default sink to use. This takes precedence over the configuration
20867N/Asettings specified in configuration files.
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term>PULSE_SOURCE</term>
20867N/A<listitem><para>
20867N/ASpecify the default source to use. This takes precedence over the
20867N/Aconfiguration settings specified in configuration files.
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term>PULSE_SERVER</term>
20867N/A<listitem><para>
20867N/ASpecify the default PulseAudio server to connect to. This takes precedence
20867N/Aover the configuration settings specified in configuration files.
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term>PULSE_BINARY</term>
20867N/A<listitem><para>
20867N/ASpecify the default PulseAudio daemon binary to run when autospawning. This
20867N/Atakes precedence over the configuration settings specified in configuration
20867N/Afiles.
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term>PULSE_PROP</term>
20867N/A<listitem><para>
20867N/AA space separated list of properties of the form 'media.role=event' to be set
20867N/Afor all streams.
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term>PULSE_PROP_<replaceable>xxxx</replaceable></term>
20867N/A<listitem><para>
20867N/ASet property <replaceable>xxxx</replaceable> for all streams.
20867N/A</para>
20867N/A</listitem></varlistentry>
20867N/A</variablelist></refsect1>
20867N/A
20867N/A<refsect1 id="pulse-client.conf-5-file"><title>&file-tt;</title>
20867N/A<para>The following files are used by this application:</para>
20867N/A
20867N/A<variablelist>
20867N/A<varlistentry>
20867N/A<term><filename>/etc/pulse/client.conf</filename></term>
20867N/A<listitem><para>
20867N/ASystem configuration file.
20867N/A</para></listitem></varlistentry>
20867N/A
20867N/A<varlistentry>
20867N/A<term><filename>~/.pulse/client.conf</filename></term>
20867N/A<listitem><para>
20867N/AUser configuration file.
20867N/A</para></listitem></varlistentry>
20867N/A</variablelist></refsect1>
20867N/A
20867N/A<refsect1 id="pulse-client.conf-5-attr"><title>&attr-tt;</title>
20867N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
20867N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
20867N/Afor descriptions of the following attributes:</para>
20867N/A<informaltable frame="all">
20867N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
20867N/A<colspec colname="COLSPEC1" colwidth="1*">
20867N/A<thead>
20867N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
20867N/Avalign="middle">ATTRIBUTE VALUE</entry></row>
20867N/A</thead>
20867N/A<tbody>
20867N/A<row><entry><para>Availability</para></entry><entry><para>SUNWpulseaudio</para></entry>
20867N/A</row>
20867N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
20867N/Acolname="COLSPEC1"><para>Volatile</para></entry></row>
20867N/A</tbody>
20867N/A</tgroup>
20867N/A</informaltable>
20867N/A</refsect1>
20867N/A
20867N/A<refsect1 id="pulse-client.conf-5-also"><title>&also-tt;</title>
20867N/A<!--Reference to another man page-->
20867N/A<!--Reference to a Help manual-->
20867N/A<!--Reference to a book.-->
20867N/A<para>
20867N/A<citerefentry><refentrytitle>pulseaudio</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
20867N/A<citerefentry><refentrytitle>pulse-daemon.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
20867N/A</para>
20867N/A</refsect1>
20867N/A<refsect1 id="pulse-client.conf-5-note"><title>&note-tt;</title>
20867N/A<para>
20867N/AWritten by the PulseAudio Developers <mzchyfrnhqvb (at) 0pointer (dot) net>;
20867N/APulseAudio is available from http://www.pulseaudio.org/.
20867N/A</para>
20867N/A</refsect1>
20867N/A</refentry>