]> code.delx.au - pulseaudio/blobdiff - man/pulse-client.conf.5.xml.in
add remaing man pages
[pulseaudio] / man / pulse-client.conf.5.xml.in
diff --git a/man/pulse-client.conf.5.xml.in b/man/pulse-client.conf.5.xml.in
new file mode 100644 (file)
index 0000000..dbf8dc0
--- /dev/null
@@ -0,0 +1,115 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!-- $Id$ -->
+
+<!--
+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>~/.pulse/client.conf</file></p>
+
+    <p><file>@pulseconfdir@/client.conf</file></p>
+  </synopsis>
+
+  <description>
+    <p>The PulseAudio client library reads configuration directives from
+    a file <file>~/.pulse/client.conf</file> on startup, and when that
+    file doesn't exist from
+    <file>@pulseconfdir@/client.conf</file>.</p>
+
+    <p>The configuration file is a simple collection of variable
+    declarations. If the configuration file parser encounters either ;
+    or # for 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 "no".</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 --exit-idle-time=5</opt>
+      </p>
+    </option>
+
+    <option>
+      <p><opt>cookie-file=</opt> Specify the path to the PulseAudio
+      authentication cookie. Defaults to
+      <file>~/.pulse-cookie</file>.</p>
+    </option>
+
+    <option>
+      <p><opt>disable-shm=</opt> Disable data transfer via POSIX
+      shared memory. Takes a boolean argument, defaults to
+      <opt>no</opt>.</p>
+    </option>
+
+  </section>
+
+  <section name="Authors">
+    <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;;
+    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>