summaryrefslogtreecommitdiffstats
path: root/man/padsp.1.xml.in
diff options
context:
space:
mode:
Diffstat (limited to 'man/padsp.1.xml.in')
-rw-r--r--man/padsp.1.xml.in112
1 files changed, 112 insertions, 0 deletions
diff --git a/man/padsp.1.xml.in b/man/padsp.1.xml.in
new file mode 100644
index 00000000..610a9602
--- /dev/null
+++ b/man/padsp.1.xml.in
@@ -0,0 +1,112 @@
+<?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="padsp" section="1" desc="PulseAudio OSS Wrapper">
+
+ <synopsis>
+ <cmd>padsp [<arg>options</arg>] <arg>PROGRAM</arg> [<arg>ARGUMENTS ...</arg>]</cmd>
+ <cmd>padsp <opt>-h</opt></cmd>
+ </synopsis>
+
+ <description>
+ <p><file>padsp</file> starts the specified program and
+ redirects its access to OSS compatible audio devices
+ (<file>/dev/dsp</file> and auxiliary devices) to a PulseAudio
+ sound server.</p>
+
+ <p><file>padsp</file> uses the $LD_PRELOAD environment variable
+ that is interpreted by <manref name="ld.so" section="8"/> and thus
+ does not work for SUID binaries and statically built
+ executables.</p>
+
+ <p>Equivalent to using <file>padsp</file> is starting an
+ application with $LD_PRELOAD set to
+ <file>libpulsedsp.so</file></p>
+ </description>
+
+ <options>
+
+ <option>
+ <p><opt>-h | --help</opt></p>
+
+ <optdesc><p>Show help.</p></optdesc>
+ </option>
+
+
+ <option>
+ <p><opt>-s</opt> <arg>SERVER</arg></p>
+
+ <optdesc><p>Set the PulseAudio server to connect to.</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>-n</opt> <arg>NAME</arg></p>
+
+ <optdesc><p>The client application name that shall be passed to the server when connecting.</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>-m</opt> <arg>NAME</arg></p>
+
+ <optdesc><p>The stream name that shall be passed to the server when creating a stream.</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>-M</opt></p>
+
+ <optdesc><p>Disable <file>/dev/mixer</file> emulation.</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>-S</opt></p>
+
+ <optdesc><p>Disable <file>/dev/sndstat</file> emulation.</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>-D</opt></p>
+
+ <optdesc><p>Disable <file>/dev/dsp</file> emulation.</p></optdesc>
+ </option>
+
+ <option>
+ <p><opt>-d</opt></p>
+
+ <optdesc><p>Enable debug output.</p></optdesc>
+ </option>
+
+ </options>
+
+ <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="pulseaudio" section="1"/>, <manref name="pasuspender" section="1"/>, <manref name="ld.so" section="8"/>
+ </p>
+ </section>
+
+</manpage>