xref: /third_party/pulseaudio/man/default.pa.5.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="default.pa" section="5" desc="PulseAudio Sound Server Startup Script">

  <synopsis>
    <p><file>~/.config/pulse/default.pa</file></p>
    <p><file>@PA_DEFAULT_CONFIG_DIR@/default.pa</file></p>
    <p><file>@PA_DEFAULT_CONFIG_DIR@/system.pa</file></p>
  </synopsis>

  <description>
    <p>The PulseAudio sound server interprets a configuration script on
    startup, which is mainly used to define the set of modules to load. When
    PulseAudio runs in the per-user mode and
    <file>~/.config/pulse/default.pa</file> exists, that file is used. When
    PulseAudio runs in the per-user mode and that file doesn't exist,
    <file>@PA_DEFAULT_CONFIG_DIR@/default.pa</file> is used. When PulseAudio
    runs as a system service, <file>@PA_DEFAULT_CONFIG_DIR@/system.pa</file> is
    used.</p>

    <p>The script should contain directives in the PulseAudio CLI language, as
    documented in <manref name="pulse-cli-syntax" section="5"/>.</p>
  </description>

  <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="pulse-daemon.conf" section="5"/>,
      <manref name="pulseaudio" section="1"/>,
      <manref name="pacmd" section="1"/>
    </p>
  </section>

</manpage>