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 <!-- $Id$ -->
   6
   7 <!--
   8 This file is part of PulseAudio.
   9
  10 PulseAudio is free software; you can redistribute it and/or modify it
  11 under the terms of the GNU Lesser General Public License as
  12 published by the Free Software Foundation; either version 2.1 of the
  13 License, or (at your option) any later version.
  14
  15 PulseAudio is distributed in the hope that it will be useful, but WITHOUT
  16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  17 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  18 Public License for more details.
  19
  20 You should have received a copy of the GNU Lesser General Public
  21 License along with PulseAudio; if not, write to the Free Software
  22 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23 USA.
  24 -->
  25
  26 <manpage name="pulse-client.conf" section="5" desc="PulseAudio client configuration file">
  27
  28   <synopsis>
  29     <p><file>~/.pulse/client.conf</file></p>
  30
  31     <p><file>@pulseconfdir@/client.conf</file></p>
  32   </synopsis>
  33
  34   <description>
  35     <p>The PulseAudio client library reads configuration directives from
  36     a file <file>~/.pulse/client.conf</file> on startup, and when that
  37     file doesn't exist from
  38     <file>@pulseconfdir@/client.conf</file>.</p>
  39
  40     <p>The configuration file is a simple collection of variable
  41     declarations. If the configuration file parser encounters either ;
  42     or # for it ignores the rest of the line until its end.</p>
  43
  44     <p>For the settings that take a boolean argument, the values
  45     <opt>true</opt>, <opt>yes</opt>, <opt>on</opt> and <opt>1</opt>
  46     are equivalent, resp. <opt>false</opt>, <opt>no</opt>,
  47     <opt>off</opt>, <opt>0</opt>.</p>
  48
  49   </description>
  50
  51   <section name="Directives">
  52
  53     <option>
  54       <p><opt>default-sink=</opt> The default sink to connect to. If
  55       specified overwrites the setting in the daemon. The environment
  56       variable <opt>$PULSE_SINK</opt> however takes precedence.</p>
  57     </option>
  58
  59     <option>
  60       <p><opt>default-source=</opt> The default source to connect
  61       to. If specified overwrites the setting in the daemon. The
  62       environment variable <opt>$PULSE_SOURCE</opt> however takes
  63       precedence.</p>
  64     </option>
  65
  66     <option>
  67       <p><opt>default-server=</opt> The default sever to connect
  68       to. The environment variable <opt>$PULSE_SERVER</opt> takes
  69       precedence.</p>
  70     </option>
  71
  72     <option>
  73       <p><opt>autospawn=</opt> Autospawn a PulseAudio daemon when
  74       needed. Takes a boolean value, defaults to "no".</p>
  75     </option>
  76
  77     <option>
  78       <p><opt>daemon-binary=</opt> Path to the PulseAudio daemon to
  79       run when autospawning. Defaults to a path configured at compile
  80       time.</p>
  81     </option>
  82
  83     <option>
  84       <p><opt>extra-arguments=</opt> Extra arguments to pass to the
  85       PulseAudio daemon when autospawning. Defaults to
  86       <opt>--log-target=syslog --exit-idle-time=5</opt>
  87       </p>
  88     </option>
  89
  90     <option>
  91       <p><opt>cookie-file=</opt> Specify the path to the PulseAudio
  92       authentication cookie. Defaults to
  93       <file>~/.pulse-cookie</file>.</p>
  94     </option>
  95
  96     <option>
  97       <p><opt>disable-shm=</opt> Disable data transfer via POSIX
  98       shared memory. Takes a boolean argument, defaults to
  99       <opt>no</opt>.</p>
 100     </option>
 101
 102   </section>
 103
 104   <section name="Authors">
 105     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;;
 106     PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
 107   </section>
 108
 109   <section name="See also">
 110     <p>
 111       <manref name="pulse-daemon.conf" section="5"/>, <manref name="pulseaudio" section="1"/>
 112     </p>
 113   </section>
 114
 115 </manpage>