source: multimedia/libdriv/pulseaudio.xml@ a6ff6760

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY pulseaudio-download-http
           "http://freedesktop.org/software/pulseaudio/releases/pulseaudio-&pulseaudio-version;.tar.xz">
  <!ENTITY pulseaudio-download-ftp  " ">
  <!ENTITY pulseaudio-md5sum        "b691e83b7434c678dffacfa3a027750e">
  <!ENTITY pulseaudio-size          "1.4 MB">
  <!ENTITY pulseaudio-buildsize     "95 MB">
  <!ENTITY pulseaudio-time          "1.0 SBU (additional 0.6 SBU for tests)">
]>

<sect1 id="pulseaudio" xreflabel="PulseAudio-&pulseaudio-version;">
  <?dbhtml filename="pulseaudio.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>PulseAudio-&pulseaudio-version;</title>

  <indexterm zone="pulseaudio">
    <primary sortas="a-PulseAudio">PulseAudio</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to PulseAudio</title>

    <para>
      <application>PulseAudio</application> is a sound system for POSIX OSes,
      meaning that it is a proxy for sound applications. It allows you to do
      advanced operations on your sound data as it passes between your
      application and your hardware. Things like transferring the audio to a
      different machine, changing the sample format or channel count and mixing
      several sounds into one are easily achieved using a sound server.
    </para>

    &lfs77_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&pulseaudio-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&pulseaudio-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &pulseaudio-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &pulseaudio-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &pulseaudio-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &pulseaudio-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">PulseAudio Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="json-c"/> and
      <xref linkend="libsndfile"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="alsa-lib"/>,
      <xref linkend="dbus"/>,
      <xref linkend="glib2"/>,
      <xref linkend="libcap-pam"/>,
      <xref linkend="openssl"/>,
      <xref linkend="speex"/> and
      <xref linkend="xorg7-lib"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="avahi"/>,
      <xref linkend="bluez"/> (runtime),
      <xref linkend="check"/>,
      <xref linkend="consolekit"/> (runtime),
      <xref linkend="GConf"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="libsamplerate"/>,
      <xref linkend="sbc"/> (Bluetooth support),
      <xref linkend="valgrind"/>,
      <ulink url="http://www.fftw.org/">FFTW</ulink>,
      <ulink url="http://www.jackaudio.org/">JACK</ulink>,
      <ulink url="http://0pointer.de/lennart/projects/libasyncns/">libasyncns</ulink>,
      <ulink url="http://www.lirc.org/">LIRC</ulink>,
      <ulink url="http://code.entropywave.com/projects/orc/">ORC</ulink>,
      <ulink url="http://tdb.samba.org/">TDB</ulink>,
      <ulink url="http://freedesktop.org/software/pulseaudio/webrtc-audio-processing/">
      WebRTC AudioProcessing</ulink> and
      <ulink url="http://www.xen.org/">XEN</ulink>
    </para>

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/pulseaudio"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of PulseAudio</title>

    <para>
      Install <application>PulseAudio</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr        \
            --sysconfdir=/etc    \
            --localstatedir=/var \
            --disable-bluez4     \
            --disable-rpath      &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

    <!-- http://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SystemWide/ -->
    <para>
      While still as the <systemitem class="username">root</systemitem>
      user, remove the <application>D-Bus</application> configuration file
      for the system wide daemon to avoid creating unnecessary system
      users and groups:
    </para>

<screen role="root"><userinput>rm /etc/dbus-1/system.d/pulseaudio-system.conf</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>--disable-bluez4</parameter>: This switch disables
      support for <application>BlueZ</application> version 4 in favour
      of <application>BlueZ</application> version 5 since the latter
      also installs compatibility library for the earlier version.
    </para>

    <para>
      <parameter>--disable-rpath</parameter>: This switch prevents
      linker from adding a hardcoded runtime path to the installed
      programs and libraries.
    </para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring PulseAudio</title>

    <sect3 id="pulseaudio-config">
      <title>Config Files</title>
      <para>
        There are system wide configuration files:
        <filename>/etc/pulse/daemon.conf</filename>,
        <filename>/etc/pulse/client.conf</filename>,
        <filename>/etc/pulse/default.pa</filename>, and user configuration
        files with the same names in
        <filename class="directory">~/.config/pulse</filename>. User
        configuration files take precedence over system wide ones.
      </para>

      <indexterm zone="pulseaudio pulseaudio-config">
        <primary sortas="e-AA.config-pulse">~/.config/pulse</primary>
      </indexterm>

      <indexterm zone="pulseaudio pulseaudio-config">
        <primary
        sortas="e-etc-pulse-daemon.conf">/etc/pulse/daemon.conf</primary>
      </indexterm>

      <indexterm zone="pulseaudio pulseaudio-config">
        <primary
        sortas="e-etc-pulse-client.conf">/etc/pulse/client.conf</primary>
      </indexterm>

      <indexterm zone="pulseaudio pulseaudio-config">
        <primary
        sortas="e-etc-pulse-default.pa">/etc/pulse/default.pa</primary>
      </indexterm>
    </sect3>

    <sect3><title>Configuration Information</title>

      <para>
        The default configuration files allow to set up a working installation,
        except that you need to remove a reference to Console-Kit if it is
        not installed. For example, issue the following command as the
        <systemitem class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>sed '/load-module module-console-kit/s/^/#/' \
                    -i /etc/pulse/default.pa</userinput></screen>

      <para>
        You may also have to configure the audio system. You may start
        <application>pulseaudio</application> in command line mode using
        <command>pulseaudio -C</command>. You can then list various
        informations and change some settings. See
        <command>man pulse-cli-syntax</command>.
      </para>
    </sect3>
  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          esdcompat, pacat, pacmd, pactl, padsp, pamon (symlink),
          paplay (symlink), parec (symlink), parecord (symlink), pasuspender,
          pax11publish, pulseaudio, and
          <!-- it looks like the equalizer needs FFTW: qpaeq, -->
          start-pulseaudio-x11
        </seg>
        <seg>
          libpulse.so,
          libpulse-mainloop-glib.so,
          libpulse-simple.so, and
          libpulsecore-&pulseaudio-major-version;.so 
        </seg>
        <seg>
          /etc/pulse,
          /usr/include/pulse,
          /usr/lib/{pulseaudio,pulse-6.0},
          /usr/lib/cmake/PulseAudio,
          /usr/libexec/pulse, and
          /usr/share/pulseaudio
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="esdcompat">
        <term><command>esdcompat</command></term>
        <listitem>
          <para>
            is the <application>PulseAudio</application> ESD wrapper script.
          </para>
          <indexterm zone="pulseaudio esdcompat">
            <primary sortas="b-esdcompat">esdcompat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pacat">
        <term><command>pacat</command></term>
        <listitem>
          <para>
            plays back or records raw or encoded audio streams on a
            <application>PulseAudio</application> sound server.
          </para>
          <indexterm zone="pulseaudio pacat">
            <primary sortas="b-pacat">pacat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pacmd">
        <term><command>pacmd</command></term>
        <listitem>
          <para>
            is a tool used to reconfigure a <application>PulseAudio</application>
            sound server during runtime.
          </para>
          <indexterm zone="pulseaudio pacmd">
            <primary sortas="b-pacmd">pacmd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pactl">
        <term><command>pactl</command></term>
        <listitem>
          <para>
            is used to control a running <application>PulseAudio</application>
            sound server.
          </para>
          <indexterm zone="pulseaudio pactl">
            <primary sortas="b-pactl">pactl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="padsp">
        <term><command>padsp</command></term>
        <listitem>
          <para>
            is the <application>PulseAudio</application> OSS Wrapper.
          </para>
          <indexterm zone="pulseaudio padsp">
            <primary sortas="b-padsp">padsp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pamon">
        <term><command>pamon</command></term>
        <listitem>
          <para>
            is a symbolic link to <command>pacat</command>.
           </para>
          <indexterm zone="pulseaudio pamon">
            <primary sortas="b-pamon">pamon</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="paplay">
        <term><command>paplay</command></term>
        <listitem>
          <para>
            is used to play audio files on a
            <application>PulseAudio</application> sound server.
          </para>
          <indexterm zone="pulseaudio paplay">
            <primary sortas="b-paplay">paplay</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="parec">
        <term><command>parec</command></term>
        <listitem>
          <para>
            is a symbolic link to <command>pacat</command>.
          </para>
          <indexterm zone="pulseaudio parec">
            <primary sortas="b-parec">parec</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="parecord">
        <term><command>parecord</command></term>
        <listitem>
          <para>
            is a symbolic link to <command>pacat</command>.
          </para>
          <indexterm zone="pulseaudio parecord">
            <primary sortas="b-parecord">parecord</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pasuspender">
        <term><command>pasuspender</command></term>
        <listitem>
          <para>
            is a tool that can be used to tell a local
            <application>PulseAudio</application> sound server to temporarily
            suspend access to the audio devices, to allow other applications
            to access them directly.
          </para>
          <indexterm zone="pulseaudio pasuspender">
            <primary sortas="b-pasuspender">pasuspender</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pax11publish">
        <term><command>pax11publish</command></term>
        <listitem>
          <para>
            is the <application>PulseAudio</application>
            X11 Credential Utility.
          </para>
          <indexterm zone="pulseaudio pax11publish">
            <primary sortas="b-pax11publish">pax11publish</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pulseaudio-prog">
        <term><command>pulseaudio</command></term>
        <listitem>
          <para>
            is a networked low-latency sound server for Linux.
          </para>
          <indexterm zone="pulseaudio pulseaudio-prog">
            <primary sortas="b-pulseaudio">pulseaudio</primary>
          </indexterm>
        </listitem>
      </varlistentry>

<!-- only installed if FFTW is present
      <varlistentry id="qpaeq">
        <term><command>qpaeq</command></term>
        <listitem>
          <para>
            is an equalizer interface for
            <application>PulseAudio</application> equalizer sinks.
          </para>
          <indexterm zone="pulseaudio qpaeq">
            <primary sortas="b-qpaeq">qpaeq</primary>
          </indexterm>
        </listitem>
      </varlistentry>
-->
      <varlistentry id="start-pulseaudio-kde">
        <term><command>start-pulseaudio-kde</command></term>
        <listitem>
          <para>
            Starts <application>PulseAudio</application> and loads
            module-device-manager to use KDE routing policies.
          </para>
          <indexterm zone="pulseaudio start-pulseaudio-kde">
            <primary sortas="b-start-pulseaudio-kde">start-pulseaudio-kde</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="start-pulseaudio-x11">
        <term><command>start-pulseaudio-x11</command></term>
        <listitem>
          <para>
            starts <application>PulseAudio</application> and registers it to
            the X11 session manager.
          </para>
          <indexterm zone="pulseaudio start-pulseaudio-x11">
            <primary sortas="b-start-pulseaudio-x11">start-pulseaudio-x11</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>