| 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
|---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
|---|
| 5 | %general-entities;
|
|---|
| 6 |
|
|---|
| 7 | <!ENTITY pulseaudio-download-http "http://freedesktop.org/software/pulseaudio/releases/pulseaudio-&pulseaudio-version;.tar.xz">
|
|---|
| 8 | <!ENTITY pulseaudio-download-ftp " ">
|
|---|
| 9 | <!ENTITY pulseaudio-md5sum "17d21df798cee407b769c6355fae397a">
|
|---|
| 10 | <!ENTITY pulseaudio-size "1.2 MB">
|
|---|
| 11 | <!ENTITY pulseaudio-buildsize "75 MB">
|
|---|
| 12 | <!ENTITY pulseaudio-time "1.0 SBU">
|
|---|
| 13 | ]>
|
|---|
| 14 |
|
|---|
| 15 | <sect1 id="pulseaudio" xreflabel="PulseAudio-&pulseaudio-version;">
|
|---|
| 16 | <?dbhtml filename="pulseaudio.html"?>
|
|---|
| 17 |
|
|---|
| 18 | <sect1info>
|
|---|
| 19 | <othername>$LastChangedBy$</othername>
|
|---|
| 20 | <date>$Date$</date>
|
|---|
| 21 | </sect1info>
|
|---|
| 22 |
|
|---|
| 23 | <title>PulseAudio-&pulseaudio-version;</title>
|
|---|
| 24 |
|
|---|
| 25 | <indexterm zone="pulseaudio">
|
|---|
| 26 | <primary sortas="a-PulseAudio">PulseAudio</primary>
|
|---|
| 27 | </indexterm>
|
|---|
| 28 |
|
|---|
| 29 | <sect2 role="package">
|
|---|
| 30 | <title>Introduction to PulseAudio</title>
|
|---|
| 31 |
|
|---|
| 32 | <para>The <application>PulseAudio</application> package is a sound system
|
|---|
| 33 | for POSIX OSes, meaning that it is a proxy for your sound applications. It
|
|---|
| 34 | allows you to do advanced operations on your sound data as it passes between
|
|---|
| 35 | your application and your hardware. Things like transferring the audio to a
|
|---|
| 36 | different machine, changing the sample format or channel count and mixing
|
|---|
| 37 | several sounds into one are easily achieved using a sound server.</para>
|
|---|
| 38 |
|
|---|
| 39 | &lfs70_checked;
|
|---|
| 40 |
|
|---|
| 41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
|---|
| 42 | <itemizedlist spacing="compact">
|
|---|
| 43 | <listitem>
|
|---|
| 44 | <para>Download (HTTP): <ulink url="&pulseaudio-download-http;"/></para>
|
|---|
| 45 | </listitem>
|
|---|
| 46 | <listitem>
|
|---|
| 47 | <para>Download (FTP): <ulink url="&pulseaudio-download-ftp;"/></para>
|
|---|
| 48 | </listitem>
|
|---|
| 49 | <listitem>
|
|---|
| 50 | <para>Download MD5 sum: &pulseaudio-md5sum;</para>
|
|---|
| 51 | </listitem>
|
|---|
| 52 | <listitem>
|
|---|
| 53 | <para>Download size: &pulseaudio-size;</para>
|
|---|
| 54 | </listitem>
|
|---|
| 55 | <listitem>
|
|---|
| 56 | <para>Estimated disk space required: &pulseaudio-buildsize;</para>
|
|---|
| 57 | </listitem>
|
|---|
| 58 | <listitem>
|
|---|
| 59 | <para>Estimated build time: &pulseaudio-time;</para>
|
|---|
| 60 | </listitem>
|
|---|
| 61 | </itemizedlist>
|
|---|
| 62 |
|
|---|
| 63 | <bridgehead renderas="sect3">PulseAudio Dependencies</bridgehead>
|
|---|
| 64 |
|
|---|
| 65 | <bridgehead renderas="sect4">Required</bridgehead>
|
|---|
| 66 | <para role="required"><xref linkend="intltool"/>,
|
|---|
| 67 | <xref linkend="json-c"/>,
|
|---|
| 68 | <xref linkend="libsndfile"/>,
|
|---|
| 69 | <xref linkend="pkgconfig"/> and <!-- required to pick up json-c and libsndfile -->
|
|---|
| 70 | <xref linkend="speex"/></para>
|
|---|
| 71 |
|
|---|
| 72 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
|---|
| 73 | <para role="recommended"><xref linkend="dbus"/></para>
|
|---|
| 74 |
|
|---|
| 75 | <bridgehead renderas="sect4">Recommended (If you are going to use it
|
|---|
| 76 | with GNOME)</bridgehead>
|
|---|
| 77 | <para role="recommended"><xref linkend="alsa-lib"/>,
|
|---|
| 78 | <xref linkend="GConf"/> and <xref linkend="xorg7-lib"/>
|
|---|
| 79 | </para>
|
|---|
| 80 |
|
|---|
| 81 | <!-- pkgconfig (needed to find libsndfile) pulls in glib -->
|
|---|
| 82 | <bridgehead renderas="sect4">Optional</bridgehead>
|
|---|
| 83 | <para role="optional">
|
|---|
| 84 | <xref linkend="avahi"/>,
|
|---|
| 85 | <ulink url="http://www.bluez.org/">BlueZ</ulink>,
|
|---|
| 86 | <ulink url="http://www.fftw.org/">FFTW</ulink>,
|
|---|
| 87 | <xref linkend="gtk2"/>,
|
|---|
| 88 | <ulink url="http://jackit.sourceforge.net/">JACK</ulink>,
|
|---|
| 89 | <ulink url="http://0pointer.de/lennart/projects/libasyncns/">libasyncns</ulink>,
|
|---|
| 90 | <xref linkend="libsamplerate"/>,
|
|---|
| 91 | <ulink url="http://www.lirc.org/">LIRC</ulink>,
|
|---|
| 92 | <xref linkend="openssl"/>,
|
|---|
| 93 | <ulink url="http://code.entropywave.com/projects/orc/">ORC</ulink>,
|
|---|
| 94 | <ulink url="http://tdb.samba.org/">tdb</ulink> and
|
|---|
| 95 | <ulink url="http://valgrind.org/">Valgrind</ulink></para>
|
|---|
| 96 |
|
|---|
| 97 | <para condition="html" role="usernotes">User Notes:
|
|---|
| 98 | <ulink url="&blfs-wiki;/pulseaudio"/></para>
|
|---|
| 99 |
|
|---|
| 100 | </sect2>
|
|---|
| 101 |
|
|---|
| 102 | <sect2 role="installation">
|
|---|
| 103 | <title>Installation of PulseAudio</title>
|
|---|
| 104 |
|
|---|
| 105 | <para>Install <application>PulseAudio</application> by running the following
|
|---|
| 106 | commands:</para>
|
|---|
| 107 |
|
|---|
| 108 | <screen><userinput>./configure --prefix=/usr \
|
|---|
| 109 | --sysconfdir=/etc \
|
|---|
| 110 | --localstatedir=/var \
|
|---|
| 111 | --libexecdir=/usr/lib \
|
|---|
| 112 | --with-module-dir=/usr/lib/pulse/modules &&
|
|---|
| 113 | make</userinput></screen>
|
|---|
| 114 |
|
|---|
| 115 | <para>To test the results, issue: <command>make check</command>.</para>
|
|---|
| 116 |
|
|---|
| 117 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
|---|
| 118 |
|
|---|
| 119 | <screen role="root"><userinput>make install</userinput></screen>
|
|---|
| 120 |
|
|---|
| 121 | </sect2>
|
|---|
| 122 |
|
|---|
| 123 | <sect2 role="commands">
|
|---|
| 124 | <title>Command Explanations</title>
|
|---|
| 125 |
|
|---|
| 126 | <para><parameter>--libexecdir=/usr/lib</parameter>: This
|
|---|
| 127 | parameter ensures that internal <application>PulseAudio</application>
|
|---|
| 128 | helpers are installed in <filename class="directory">/usr/lib/pulse
|
|---|
| 129 | </filename> instead of <filename class="directory">/usr/libexec/pulse
|
|---|
| 130 | </filename>.</para>
|
|---|
| 131 |
|
|---|
| 132 | <para><parameter>---with-module-dir=/usr/lib/pulse/modules</parameter>:
|
|---|
| 133 | This parameter ensures that <application>PulseAudio</application>
|
|---|
| 134 | modules are installed in <filename class="directory">/usr/lib/pulse/modules
|
|---|
| 135 | </filename> instead of <filename class="directory">
|
|---|
| 136 | /usr/lib/pulse-&pulseaudio-version;/modules</filename>.</para>
|
|---|
| 137 |
|
|---|
| 138 | </sect2>
|
|---|
| 139 |
|
|---|
| 140 | <sect2 role="content">
|
|---|
| 141 | <title>Contents</title>
|
|---|
| 142 |
|
|---|
| 143 | <segmentedlist>
|
|---|
| 144 | <segtitle>Installed Programs</segtitle>
|
|---|
| 145 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 146 | <segtitle>Installed Directories</segtitle>
|
|---|
| 147 |
|
|---|
| 148 | <seglistitem>
|
|---|
| 149 | <seg>esdcompat, gconf-helper, pabrowse, pacat, pacmd, pactl, padsp,
|
|---|
| 150 | pamon, paplay, parec, parecord, pasuspender, pax11publish, proximity-helper,
|
|---|
| 151 | pulseaudio, qpaeq, start-pulseaudio-kde and start-pulseaudio-x11</seg>
|
|---|
| 152 | <seg>libalsa-util.so, libavahi-wrap.so, libcli.so, liboss-util.so,
|
|---|
| 153 | libprotocol-cli.so, libprotocol-esound.so, libprotocol-http.so,
|
|---|
| 154 | libprotocol-native.so, libprotocol-simple.so,libpulse-mainloop-glib.so,
|
|---|
| 155 | libpulse-simple.so, libpulse.so, libpulsecommon-1.1.so, libpulsecore-1.1.so,
|
|---|
| 156 | libpulsedsp.so, libraop.so, librtp.so, module-alsa-card.so,
|
|---|
| 157 | module-alsa-sink.so, module-alsa-source.so, module-always-sink.so,
|
|---|
| 158 | module-augment-properties.so, module-card-restore.so,
|
|---|
| 159 | module-cli-protocol-tcp.so, module-cli-protocol-unix.so, module-cli.so,
|
|---|
| 160 | module-combine.so, module-console-kit.so, module-cork-music-on-phone.so,
|
|---|
| 161 | module-default-device-restore.so, module-detect.so,
|
|---|
| 162 | module-device-manager.so, module-device-restore.so,
|
|---|
| 163 | module-echo-cancel.so, module-esound-compat-spawnfd.so,
|
|---|
| 164 | module-esound-compat-spawnpid.so, module-esound-protocol-tcp.so,
|
|---|
| 165 | module-esound-protocol-unix.so, module-esound-sink.so, module-gconf.so,
|
|---|
| 166 | module-hal-detect.so, module-http-protocol-tcp.so,
|
|---|
| 167 | module-http-protocol-unix.so, module-intended-roles.so,
|
|---|
| 168 | module-ladspa-sink.so, module-loopback.so, module-match.so,
|
|---|
| 169 | module-mmkbd-evdev.so, module-native-protocol-fd.so,
|
|---|
| 170 | module-native-protocol-tcp.so, module-native-protocol-unix.so,
|
|---|
| 171 | module-null-sink.so, module-oss.so, module-pipe-sink.so,
|
|---|
| 172 | module-pipe-source.so, module-position-event-sounds.so,
|
|---|
| 173 | module-raop-discover.so, module-raop-sink.so, module-remap-sink.so,
|
|---|
| 174 | module-rescue-streams.so, module-rtp-recv.so, module-rtp-send.so,
|
|---|
| 175 | module-rygel-media-server.so, module-simple-protocol-tcp.so,
|
|---|
| 176 | module-simple-protocol-unix.so, module-sine-source.so, module-sine.so,
|
|---|
| 177 | module-stream-restore.so, module-suspend-on-idle.so,
|
|---|
| 178 | module-tunnel-sink.so, module-tunnel-source.so, module-udev-detect.so,
|
|---|
| 179 | module-volume-restore.so, module-x11-bell.so,
|
|---|
| 180 | module-x11-cork-request.so, module-x11-publish.so, module-x11-xsmp.so,
|
|---|
| 181 | module-zeroconf-discover.so, and module-zeroconf-publish.so</seg>
|
|---|
| 182 | <seg>/etc/{pulse,xdg/autostart}, /usr/{include/pulse,
|
|---|
| 183 | lib/pulse/modules,share/pulseaudio/alsa-mixer/{paths,profile-sets}}</seg>
|
|---|
| 184 | </seglistitem>
|
|---|
| 185 | </segmentedlist>
|
|---|
| 186 |
|
|---|
| 187 | <variablelist>
|
|---|
| 188 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 189 | <?dbfo list-presentation="list"?>
|
|---|
| 190 | <?dbhtml list-presentation="table"?>
|
|---|
| 191 |
|
|---|
| 192 | <varlistentry id="esdcompat">
|
|---|
| 193 | <term><command>esdcompat</command></term>
|
|---|
| 194 | <listitem>
|
|---|
| 195 | <para>is a <application>PulseAudio</application> ESD wrapper
|
|---|
| 196 | script.</para>
|
|---|
| 197 | <indexterm zone="pulseaudio esdcompat">
|
|---|
| 198 | <primary sortas="b-esdcompat">esdcompat</primary>
|
|---|
| 199 | </indexterm>
|
|---|
| 200 | </listitem>
|
|---|
| 201 | </varlistentry>
|
|---|
| 202 |
|
|---|
| 203 | <varlistentry id="gconf-helper">
|
|---|
| 204 | <term><command>gconf-helper</command></term>
|
|---|
| 205 | <listitem>
|
|---|
| 206 | <para>is helper for <application>PulseAudio
|
|---|
| 207 | </application> GConf module.</para>
|
|---|
| 208 | <indexterm zone="pulseaudio gconf-helper">
|
|---|
| 209 | <primary sortas="b-gconf-helper">gconf-helper</primary>
|
|---|
| 210 | </indexterm>
|
|---|
| 211 | </listitem>
|
|---|
| 212 | </varlistentry>
|
|---|
| 213 |
|
|---|
| 214 | <varlistentry id="pacat">
|
|---|
| 215 | <term><command>pacat</command></term>
|
|---|
| 216 | <listitem>
|
|---|
| 217 | <para>Plays back or records raw or encoded audio streams on a
|
|---|
| 218 | <application>PulseAudio</application> sound server.</para>
|
|---|
| 219 | <indexterm zone="pulseaudio pacat">
|
|---|
| 220 | <primary sortas="b-pacat">pacat</primary>
|
|---|
| 221 | </indexterm>
|
|---|
| 222 | </listitem>
|
|---|
| 223 | </varlistentry>
|
|---|
| 224 |
|
|---|
| 225 | <varlistentry id="pacmd">
|
|---|
| 226 | <term><command>pacmd</command></term>
|
|---|
| 227 | <listitem>
|
|---|
| 228 | <para>is a tool to reconfigure a <application>PulseAudio</application>
|
|---|
| 229 | sound server during runtime.</para>
|
|---|
| 230 | <indexterm zone="pulseaudio pacmd">
|
|---|
| 231 | <primary sortas="b-pacmd">pacmd</primary>
|
|---|
| 232 | </indexterm>
|
|---|
| 233 | </listitem>
|
|---|
| 234 | </varlistentry>
|
|---|
| 235 |
|
|---|
| 236 | <varlistentry id="pactl">
|
|---|
| 237 | <term><command>pactl</command></term>
|
|---|
| 238 | <listitem>
|
|---|
| 239 | <para>controls a running <application>PulseAudio</application> sound
|
|---|
| 240 | server.</para>
|
|---|
| 241 | <indexterm zone="pulseaudio pactl">
|
|---|
| 242 | <primary sortas="b-pactl">pactl</primary>
|
|---|
| 243 | </indexterm>
|
|---|
| 244 | </listitem>
|
|---|
| 245 | </varlistentry>
|
|---|
| 246 |
|
|---|
| 247 | <varlistentry id="padsp">
|
|---|
| 248 | <term><command>padsp</command></term>
|
|---|
| 249 | <listitem>
|
|---|
| 250 | <para>is a <application>PulseAudio</application> OSS Wrapper.</para>
|
|---|
| 251 | <indexterm zone="pulseaudio padsp">
|
|---|
| 252 | <primary sortas="b-padsp">padsp</primary>
|
|---|
| 253 | </indexterm>
|
|---|
| 254 | </listitem>
|
|---|
| 255 | </varlistentry>
|
|---|
| 256 |
|
|---|
| 257 | <varlistentry id="pamon">
|
|---|
| 258 | <term><command>pamon</command></term>
|
|---|
| 259 | <listitem>
|
|---|
| 260 | <para>is a symbolic link to pacat.</para>
|
|---|
| 261 | <indexterm zone="pulseaudio pamon">
|
|---|
| 262 | <primary sortas="b-pamon">pamon</primary>
|
|---|
| 263 | </indexterm>
|
|---|
| 264 | </listitem>
|
|---|
| 265 | </varlistentry>
|
|---|
| 266 |
|
|---|
| 267 | <varlistentry id="paplay">
|
|---|
| 268 | <term><command>paplay</command></term>
|
|---|
| 269 | <listitem>
|
|---|
| 270 | <para>plays audio files on <application>PulseAudio</application>
|
|---|
| 271 | sound server.</para>
|
|---|
| 272 | <indexterm zone="pulseaudio paplay">
|
|---|
| 273 | <primary sortas="b-paplay">paplay</primary>
|
|---|
| 274 | </indexterm>
|
|---|
| 275 | </listitem>
|
|---|
| 276 | </varlistentry>
|
|---|
| 277 |
|
|---|
| 278 | <varlistentry id="parec">
|
|---|
| 279 | <term><command>parec</command></term>
|
|---|
| 280 | <listitem>
|
|---|
| 281 | <para>is a symbolic link to pacat.</para>
|
|---|
| 282 | <indexterm zone="pulseaudio parec">
|
|---|
| 283 | <primary sortas="b-parec">parec</primary>
|
|---|
| 284 | </indexterm>
|
|---|
| 285 | </listitem>
|
|---|
| 286 | </varlistentry>
|
|---|
| 287 |
|
|---|
| 288 | <varlistentry id="parecord">
|
|---|
| 289 | <term><command>parecord</command></term>
|
|---|
| 290 | <listitem>
|
|---|
| 291 | <para>is a symbolic link to pacat.</para>
|
|---|
| 292 | <indexterm zone="pulseaudio parecord">
|
|---|
| 293 | <primary sortas="b-parecord">parecord</primary>
|
|---|
| 294 | </indexterm>
|
|---|
| 295 | </listitem>
|
|---|
| 296 | </varlistentry>
|
|---|
| 297 |
|
|---|
| 298 | <varlistentry id="pasuspender">
|
|---|
| 299 | <term><command>pasuspender</command></term>
|
|---|
| 300 | <listitem>
|
|---|
| 301 | <para>is a tool that can be used to tell a local
|
|---|
| 302 | <application>PulseAudio</application> sound server to temporarily
|
|---|
| 303 | suspend access to the audio devices, to allow other applications
|
|---|
| 304 | access them directly.</para>
|
|---|
| 305 | <indexterm zone="pulseaudio pasuspender">
|
|---|
| 306 | <primary sortas="b-pasuspender">pasuspender</primary>
|
|---|
| 307 | </indexterm>
|
|---|
| 308 | </listitem>
|
|---|
| 309 | </varlistentry>
|
|---|
| 310 |
|
|---|
| 311 | <varlistentry id="pax11publish">
|
|---|
| 312 | <term><command>pax11publish</command></term>
|
|---|
| 313 | <listitem>
|
|---|
| 314 | <para>is <application>PulseAudio</application>
|
|---|
| 315 | X11 Credential Utility.</para>
|
|---|
| 316 | <indexterm zone="pulseaudio pax11publish">
|
|---|
| 317 | <primary sortas="b-pax11publish">pax11publish</primary>
|
|---|
| 318 | </indexterm>
|
|---|
| 319 | </listitem>
|
|---|
| 320 | </varlistentry>
|
|---|
| 321 |
|
|---|
| 322 | <varlistentry id="pulseaudio-prog">
|
|---|
| 323 | <term><command>pulseaudio</command></term>
|
|---|
| 324 | <listitem>
|
|---|
| 325 | <para>is a networked low-latency sound server for Linux.</para>
|
|---|
| 326 | <indexterm zone="pulseaudio pulseaudio-prog">
|
|---|
| 327 | <primary sortas="b-pulseaudio-prog">pulseaudio-prog</primary>
|
|---|
| 328 | </indexterm>
|
|---|
| 329 | </listitem>
|
|---|
| 330 | </varlistentry>
|
|---|
| 331 |
|
|---|
| 332 | <varlistentry id="qpaeq">
|
|---|
| 333 | <term><command>qpaeq</command></term>
|
|---|
| 334 | <listitem>
|
|---|
| 335 | <para>is a equalizer interface for
|
|---|
| 336 | <application>PulseAudio</application> equalizer sinks.</para>
|
|---|
| 337 | <indexterm zone="pulseaudio qpaeq">
|
|---|
| 338 | <primary sortas="b-qpaeq">qpaeq</primary>
|
|---|
| 339 | </indexterm>
|
|---|
| 340 | </listitem>
|
|---|
| 341 | </varlistentry>
|
|---|
| 342 |
|
|---|
| 343 | <varlistentry id="start-pulseaudio-kde">
|
|---|
| 344 | <term><command>start-pulseaudio-kde</command></term>
|
|---|
| 345 | <listitem>
|
|---|
| 346 | <para>Starts <application>PulseAudio</application> and registers it to
|
|---|
| 347 | the X11 session manager.</para>
|
|---|
| 348 | <indexterm zone="pulseaudio start-pulseaudio-kde">
|
|---|
| 349 | <primary sortas="b-start-pulseaudio-kde">start-pulseaudio-kde</primary>
|
|---|
| 350 | </indexterm>
|
|---|
| 351 | </listitem>
|
|---|
| 352 | </varlistentry>
|
|---|
| 353 |
|
|---|
| 354 | <varlistentry id="start-pulseaudio-x11">
|
|---|
| 355 | <term><command>start-pulseaudio-x11</command></term>
|
|---|
| 356 | <listitem>
|
|---|
| 357 | <para>Starts <application>PulseAudio</application> and loads
|
|---|
| 358 | module-device-manager to use KDE routing policies.</para>
|
|---|
| 359 | <indexterm zone="pulseaudio start-pulseaudio-x11">
|
|---|
| 360 | <primary sortas="b-start-pulseaudio-x11">start-pulseaudio-x11</primary>
|
|---|
| 361 | </indexterm>
|
|---|
| 362 | </listitem>
|
|---|
| 363 | </varlistentry>
|
|---|
| 364 |
|
|---|
| 365 | <varlistentry id="modules">
|
|---|
| 366 | <term><filename class='libraryfile'>module-*.so</filename></term>
|
|---|
| 367 | <listitem>
|
|---|
| 368 | <para>Various library modules.</para>
|
|---|
| 369 | <indexterm zone="pulseaudio modules">
|
|---|
| 370 | <primary sortas="c-modules">module-*.so</primary>
|
|---|
| 371 | </indexterm>
|
|---|
| 372 | </listitem>
|
|---|
| 373 | </varlistentry>
|
|---|
| 374 |
|
|---|
| 375 | </variablelist>
|
|---|
| 376 |
|
|---|
| 377 | </sect2>
|
|---|
| 378 |
|
|---|
| 379 | </sect1>
|
|---|
