pacmd: Added --help and --version descriptions to the man page.
[profile/ivi/pulseaudio.git] / man / padsp.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="padsp" section="1" desc="PulseAudio OSS Wrapper">
25
26   <synopsis>
27     <cmd>padsp [<arg>options</arg>] <arg>PROGRAM</arg> [<arg>ARGUMENTS ...</arg>]</cmd>
28     <cmd>padsp <opt>-h</opt></cmd>
29   </synopsis>
30
31   <description>
32     <p><file>padsp</file> starts the specified program and
33     redirects its access to OSS compatible audio devices
34     (<file>/dev/dsp</file> and auxiliary devices) to a PulseAudio
35     sound server.</p>
36
37     <p><file>padsp</file> uses the $LD_PRELOAD environment variable
38     that is interpreted by <manref name="ld.so" section="8"/> and thus
39     does not work for SUID binaries and statically built
40     executables.</p>
41
42     <p>Equivalent to using <file>padsp</file> is starting an
43     application with $LD_PRELOAD set to
44     <file>libpulsedsp.so</file></p>
45   </description>
46
47   <options>
48
49     <option>
50       <p><opt>-h | --help</opt></p>
51
52       <optdesc><p>Show help.</p></optdesc>
53     </option>
54
55
56     <option>
57       <p><opt>-s</opt> <arg>SERVER</arg></p>
58
59       <optdesc><p>Set the PulseAudio server to connect to.</p></optdesc>
60     </option>
61
62     <option>
63       <p><opt>-n</opt> <arg>NAME</arg></p>
64
65       <optdesc><p>The client application name that shall be passed to the server when connecting.</p></optdesc>
66     </option>
67
68     <option>
69       <p><opt>-m</opt> <arg>NAME</arg></p>
70
71       <optdesc><p>The stream name that shall be passed to the server when creating a stream.</p></optdesc>
72     </option>
73
74     <option>
75       <p><opt>-M</opt></p>
76
77       <optdesc><p>Disable <file>/dev/mixer</file> emulation.</p></optdesc>
78     </option>
79
80     <option>
81       <p><opt>-S</opt></p>
82
83       <optdesc><p>Disable <file>/dev/sndstat</file> emulation.</p></optdesc>
84     </option>
85
86     <option>
87       <p><opt>-D</opt></p>
88
89       <optdesc><p>Disable <file>/dev/dsp</file> emulation.</p></optdesc>
90     </option>
91
92     <option>
93       <p><opt>-d</opt></p>
94
95       <optdesc><p>Enable debug output.</p></optdesc>
96     </option>
97
98   </options>
99
100   <section name="Authors">
101     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
102   </section>
103
104   <section name="See also">
105     <p>
106       <manref name="pulseaudio" section="1"/>, <manref name="pasuspender" section="1"/>, <manref name="ld.so" section="8"/>
107     </p>
108   </section>
109
110 </manpage>