code.delx.au - pulseaudio/blob - man/pulse-client.conf.5.xml.in

   1 <?xml version="1.0"?><!--*-nxml-*-->
   2 <!DOCTYPE manpage SYSTEM "xmltoman.dtd">
   3 <?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
   4
   5 <!--
   6 This file is part of PulseAudio.
   7
   8 PulseAudio is free software; you can redistribute it and/or modify it
   9 under the terms of the GNU Lesser General Public License as
  10 published by the Free Software Foundation; either version 2.1 of the
  11 License, or (at your option) any later version.
  12
  13 PulseAudio is distributed in the hope that it will be useful, but WITHOUT
  14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  15 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  16 Public License for more details.
  17
  18 You should have received a copy of the GNU Lesser General Public
  19 License along with PulseAudio; if not, write to the Free Software
  20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  21 USA.
  22 -->
  23
  24 <manpage name="pulse-client.conf" section="5" desc="PulseAudio client configuration file">
  25
  26   <synopsis>
  27     <p><file>~/.config/pulse/client.conf</file></p>
  28
  29     <p><file>@PA_DEFAULT_CONFIG_DIR@/client.conf</file></p>
  30   </synopsis>
  31
  32   <description>
  33     <p>The PulseAudio client library reads configuration directives from
  34     a file <file>~/.config/pulse/client.conf</file> on startup and when that
  35     file doesn't exist from
  36     <file>@PA_DEFAULT_CONFIG_DIR@/client.conf</file>.</p>
  37
  38     <p>The configuration file is a simple collection of variable
  39     declarations. If the configuration file parser encounters either ;
  40     or # it ignores the rest of the line until its end.</p>
  41
  42     <p>For the settings that take a boolean argument the values
  43     <opt>true</opt>, <opt>yes</opt>, <opt>on</opt> and <opt>1</opt>
  44     are equivalent, resp. <opt>false</opt>, <opt>no</opt>,
  45     <opt>off</opt>, <opt>0</opt>.</p>
  46
  47   </description>
  48
  49   <section name="Directives">
  50
  51     <option>
  52       <p><opt>default-sink=</opt> The default sink to connect to. If
  53       specified overwrites the setting in the daemon. The environment
  54       variable <opt>$PULSE_SINK</opt> however takes precedence.</p>
  55     </option>
  56
  57     <option>
  58       <p><opt>default-source=</opt> The default source to connect
  59       to. If specified overwrites the setting in the daemon. The
  60       environment variable <opt>$PULSE_SOURCE</opt> however takes
  61       precedence.</p>
  62     </option>
  63
  64     <option>
  65       <p><opt>default-server=</opt> The default sever to connect
  66       to. The environment variable <opt>$PULSE_SERVER</opt> takes
  67       precedence.</p>
  68     </option>
  69
  70     <option>
  71       <p><opt>autospawn=</opt> Autospawn a PulseAudio daemon when
  72       needed. Takes a boolean value, defaults to <opt>yes</opt>.</p>
  73     </option>
  74
  75     <option>
  76       <p><opt>daemon-binary=</opt> Path to the PulseAudio daemon to
  77       run when autospawning. Defaults to a path configured at compile
  78       time.</p>
  79     </option>
  80
  81     <option>
  82       <p><opt>extra-arguments=</opt> Extra arguments to pass to the
  83       PulseAudio daemon when autospawning. Defaults to
  84       <opt>--log-target=syslog</opt>
  85       </p>
  86     </option>
  87
  88     <option>
  89       <p><opt>cookie-file=</opt> Specify the path to the PulseAudio
  90       authentication cookie. Defaults to
  91       <file>~/.config/pulse/cookie</file>.</p>
  92     </option>
  93
  94     <option>
  95       <p><opt>enable-shm=</opt> Enable data transfer via POSIX
  96       shared memory. Takes a boolean argument, defaults to
  97       <opt>yes</opt>.</p>
  98     </option>
  99
 100     <option>
 101       <p><opt>shm-size-bytes=</opt> Sets the shared memory segment
 102       size for clients, in bytes. If left unspecified or is set to 0
 103       it will default to some system-specific default, usually 64
 104       MiB. Please note that usually there is no need to change this
 105       value, unless you are running an OS kernel that does not do
 106       memory overcommit.</p>
 107     </option>
 108
 109     <option>
 110       <p><opt>auto-connect-localhost=</opt> Automatically try to
 111       connect to localhost via IP. Enabling this is a potential
 112       security hole since connections are only authenticated one-way
 113       and a rogue server might hence fool a client into sending it its
 114       private (e.g. VoIP call) data. This was enabled by default on
 115       PulseAudio version 0.9.21 and older. Defaults to
 116       <opt>no</opt>.</p>
 117     </option>
 118
 119     <option>
 120       <p><opt>auto-connect-display=</opt> Automatically try to connect
 121       to the host X11's $DISPLAY variable is set to. The same security
 122       issues apply as to <opt>auto-connect-localhost=</opt>. Defaults
 123       to <opt>no</opt>.</p>
 124     </option>
 125
 126   </section>
 127
 128   <section name="Authors">
 129     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;;
 130     PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
 131   </section>
 132
 133   <section name="See also">
 134     <p>
 135       <manref name="pulse-daemon.conf" section="5"/>, <manref name="pulseaudio" section="1"/>
 136     </p>
 137   </section>
 138
 139 </manpage>