xref: /third_party/pulseaudio/man/pasuspender.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="pasuspender" section="1" desc="Temporarily suspend PulseAudio">

  <synopsis>
    <cmd>pasuspender [<arg>options</arg>] -- <arg>PROGRAM</arg> [<arg>ARGUMENTS ...</arg>]</cmd>
    <cmd>pasuspender <opt>--help</opt></cmd>
    <cmd>pasuspender <opt>--version</opt></cmd>
  </synopsis>

  <description>
    <p><file>pasuspender</file> is a tool that can be used to tell a
    local PulseAudio sound server to temporarily suspend access to the
    audio devices, to allow other
    applications access them directly. <file>pasuspender</file> will
    suspend access to the audio devices, fork a child process, and
    when the child process terminates, resume access again.</p>

    <p>Make sure to include <opt>--</opt> in
    your <file>pasuspender</file> command line before passing the
    subprocess command line (as shown
    above). Otherwise <file>pasuspender</file> itself might end up
    interpreting the command line switches and options you intended to
    pass to the subprocess.</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>-s | --server=</opt><arg>SERVER</arg></p>

      <optdesc><p>Specify the sound server to connect to.</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="padsp" section="1"/>, <manref name="pacmd" section="1"/>, <manref name="pactl" section="1"/>
    </p>
  </section>

</manpage>