xref: /third_party/pulseaudio/man/esdcompat.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="esdcompat" section="1" desc="PulseAudio ESD wrapper script">

  <synopsis>
    <cmd>esdcompat [<arg>options</arg>]</cmd>
    <cmd>esdcompat <opt>--help</opt></cmd>
    <cmd>esdcompat <opt>--version</opt></cmd>
  </synopsis>

  <description>
    <p><file>esdcompat</file> is a compatibility script that takes the
    same arguments as the ESD sound daemon <manref name="esd"
    section="1"/>, but uses them to start a the PulseAudio sound server with the appropriate parameters. It is
    required to make PulseAudio a drop-in replacement for esd, i.e. it
    can be used to make <manref name="gnome-session" section="1"/>
    start up PulseAudio instead of esd.</p>

    <p>It is recommended to make <file>esd</file> a symbolic link to this script.</p>
  </description>

  <options>

    <option>
      <p><opt>-h | --help</opt></p>

      <optdesc><p>Show help.</p></optdesc>
    </option>

    <option>
      <p><opt>--version</opt></p>

      <optdesc><p>Show version information.</p></optdesc>
    </option>

    <option>
      <p><opt>-tcp | -promiscuous | -d | -b | -r | -as | -unix | -public | -terminate | -nobeeps | -trust | -port | -bind</opt></p>

      <optdesc><p>These options understood by the original
      <file>esd</file> are ignored by
      <file>esdcompat</file>.</p></optdesc>

    </option>


    <option>
      <p><opt>-spawnpid | -spawnfd</opt></p>

      <optdesc><p>These internally used options understood by the
      original <file>esd</file> are properly handled by
      <file>esdcompat</file>, however are not to be used
      manually.</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="esd" section="1"/>
    </p>
  </section>

</manpage>