]> code.delx.au - pulseaudio/blob - man/pasuspender.1.xml.in
406dfe6091698fe3048af641cbfc1cb9b78200cc
[pulseaudio] / man / pasuspender.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 <!-- $Id$ -->
6
7 <!--
8 This file is part of PulseAudio.
9
10 PulseAudio is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as
12 published by the Free Software Foundation; either version 2.1 of the
13 License, or (at your option) any later version.
14
15 PulseAudio is distributed in the hope that it will be useful, but WITHOUT
16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
17 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
18 Public License for more details.
19
20 You should have received a copy of the GNU Lesser General Public
21 License along with PulseAudio; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
23 USA.
24 -->
25
26 <manpage name="pasuspender" section="1" desc="Temporarily suspend PulseAudio">
27
28 <synopsis>
29 <cmd>pasuspender [<arg>options</arg>] -- <arg>PROGRAM</arg> [<arg>ARGUMENTS ...</arg>]</cmd>
30 <cmd>pasuspender <opt>--help</opt></cmd>
31 <cmd>pasuspender <opt>--version</opt></cmd>
32 </synopsis>
33
34 <description>
35 <p><file>pasuspender</file> is a tool that can be used to tell a
36 local PulseAudio sound server to temporarily suspend access to the
37 audio devices, to allow other
38 applications access them directly. <file>pasuspender</file> will
39 suspend access to the audio devices, fork a child process, and
40 when the child process terminates, resume access again.</p>
41
42 <p>Make sure to include <opt>--</opt> in
43 your <file>pasuspender</file> command line before passing the
44 subprocess command line (as shown
45 above). Otherwise <file>pasuspender</file> itself might end up
46 interpreting the command line switches and options you intended to
47 pass to the subprocess.</p>
48 </description>
49
50 <options>
51
52 <option>
53 <p><opt>-h | --help</opt></p>
54
55 <optdesc><p>Show help.</p></optdesc>
56 </option>
57
58 <option>
59 <p><opt>--version</opt></p>
60
61 <optdesc><p>Show version information.</p></optdesc>
62 </option>
63
64 <option>
65 <p><opt>-s | --server=</opt><arg>SERVER</arg></p>
66
67 <optdesc><p>Specify the sound server to connect to.</p></optdesc>
68 </option>
69
70 </options>
71
72 <section name="Authors">
73 <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
74 </section>
75
76 <section name="See also">
77 <p>
78 <manref name="pulseaudio" section="1"/>, <manref name="padsp" section="1"/>, <manref name="pacmd" section="1"/>, <manref name="pactl" section="1"/>
79 </p>
80 </section>
81
82 </manpage>