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 <!--
   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, see <http://www.gnu.org/licenses/>.
  20 -->
  21
  22 <manpage name="pasuspender" section="1" desc="Temporarily suspend PulseAudio">
  23
  24   <synopsis>
  25     <cmd>pasuspender [<arg>options</arg>] -- <arg>PROGRAM</arg> [<arg>ARGUMENTS ...</arg>]</cmd>
  26     <cmd>pasuspender <opt>--help</opt></cmd>
  27     <cmd>pasuspender <opt>--version</opt></cmd>
  28   </synopsis>
  29
  30   <description>
  31     <p><file>pasuspender</file> is a tool that can be used to tell a
  32     local PulseAudio sound server to temporarily suspend access to the
  33     audio devices, to allow other
  34     applications access them directly. <file>pasuspender</file> will
  35     suspend access to the audio devices, fork a child process, and
  36     when the child process terminates, resume access again.</p>
  37
  38     <p>Make sure to include <opt>--</opt> in
  39     your <file>pasuspender</file> command line before passing the
  40     subprocess command line (as shown
  41     above). Otherwise <file>pasuspender</file> itself might end up
  42     interpreting the command line switches and options you intended to
  43     pass to the subprocess.</p>
  44   </description>
  45
  46   <options>
  47
  48     <option>
  49       <p><opt>-h | --help</opt></p>
  50
  51       <optdesc><p>Show help.</p></optdesc>
  52     </option>
  53
  54     <option>
  55       <p><opt>--version</opt></p>
  56
  57       <optdesc><p>Show version information.</p></optdesc>
  58     </option>
  59
  60     <option>
  61       <p><opt>-s | --server=</opt><arg>SERVER</arg></p>
  62
  63       <optdesc><p>Specify the sound server to connect to.</p></optdesc>
  64     </option>
  65
  66   </options>
  67
  68   <section name="Authors">
  69     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
  70   </section>
  71
  72   <section name="See also">
  73     <p>
  74       <manref name="pulseaudio" section="1"/>, <manref name="padsp" section="1"/>, <manref name="pacmd" section="1"/>, <manref name="pactl" section="1"/>
  75     </p>
  76   </section>
  77
  78 </manpage>