man/padsp.1.xml.in

<?xml version="1.0"?><!--*-nxml-*-->
<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>

<!--
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, see <http://www.gnu.org/licenses/>.
-->

<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>