xref: /third_party/pulseaudio/man/pacmd.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="pacmd" section="1" desc="Reconfigure a PulseAudio sound server during runtime">

  <synopsis>
    <cmd>pacmd</cmd>
    <cmd>pacmd <opt>--help</opt></cmd>
    <cmd>pacmd <opt>--version</opt></cmd>
  </synopsis>

  <description>
    <p>This tool can be used to introspect or reconfigure a running
    PulseAudio sound server during runtime. It connects to the sound
    server and offers a simple live shell that can be used to enter
    the commands also understood in the <file>default.pa</file>
    configuration scripts.</p>

    <p>To exit the live shell, use ctrl+d. Note that the 'exit' command
    inside the shell will tell the PulseAudio daemon itself to shutdown!</p>

    <p>If any arguments are passed on the command line, they will be
    passed into the live shell which will process the command and exit.</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>

  </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="pulse-cli-syntax" section="5"/>,
      <manref name="pulseaudio" section="1"/>,
      <manref name="pactl" section="1"/>,
      <manref name="default.pa" section="5"/>
    </p>
  </section>

</manpage>