code.delx.au - pulseaudio/blob - man/esdcompat.1.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 <!--
   6 This file is part of PulseAudio.
   7
   8 PulseAudio is free software; you can redistribute it and/or modify it
   9 under the terms of the GNU Lesser General Public License as
  10 published by the Free Software Foundation; either version 2.1 of the
  11 License, or (at your option) any later version.
  12
  13 PulseAudio is distributed in the hope that it will be useful, but WITHOUT
  14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  15 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  16 Public License for more details.
  17
  18 You should have received a copy of the GNU Lesser General Public
  19 License along with PulseAudio; if not, write to the Free Software
  20 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  21 USA.
  22 -->
  23
  24 <manpage name="esdcompat" section="1" desc="PulseAudio ESD wrapper script">
  25
  26   <synopsis>
  27     <cmd>esdcompat [<arg>options</arg>]</cmd>
  28     <cmd>esdcompat <opt>--help</opt></cmd>
  29     <cmd>esdcompat <opt>--version</opt></cmd>
  30   </synopsis>
  31
  32   <description>
  33     <p><file>esdcompat</file> is a compatibility script that takes the
  34     same arguments as the ESD sound daemon <manref name="esd"
  35     section="1"/>, but uses them to start a the PulseAudio sound server with the appropriate parameters. It is
  36     required to make PulseAudio a drop-in replacement for esd, i.e. it
  37     can be used to make <manref name="gnome-session" section="1"/>
  38     start up PulseAudio instead of esd.</p>
  39
  40     <p>It is recommended to make <file>esd</file> a symbolic link to this script.</p>
  41   </description>
  42
  43   <options>
  44
  45     <option>
  46       <p><opt>-h | --help</opt></p>
  47
  48       <optdesc><p>Show help.</p></optdesc>
  49     </option>
  50
  51     <option>
  52       <p><opt>--version</opt></p>
  53
  54       <optdesc><p>Show version information.</p></optdesc>
  55     </option>
  56
  57     <option>
  58       <p><opt>-tcp | -promiscuous | -d | -b | -r | -as | -unix | -public | -terminate | -nobeeps | -trust | -port | -bind</opt></p>
  59
  60       <optdesc><p>These options understood by the original
  61       <file>esd</file> are ignored by
  62       <file>esdcompat</file>.</p></optdesc>
  63
  64     </option>
  65
  66
  67     <option>
  68       <p><opt>-spawnpid | -spawnfd</opt></p>
  69
  70       <optdesc><p>These internally used options understood by the
  71       original <file>esd</file> are properly handled by
  72       <file>esdcompat</file>, however are not to be used
  73       manually.</p></optdesc>
  74
  75     </option>
  76
  77   </options>
  78
  79   <section name="Authors">
  80     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
  81   </section>
  82
  83   <section name="See also">
  84     <p>
  85       <manref name="pulseaudio" section="1"/>, <manref name="esd" section="1"/>
  86     </p>
  87   </section>
  88
  89 </manpage>