source: multimedia/libdriv/pulseaudio.xml@ 55a66dab

10.0 10.1 11.0 11.1 11.2 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind lazarus perl-modules plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 55a66dab was 55a66dab, checked in by Bruce Dubbs <bdubbs@…>, 5 years ago

Update to LibRaw-0.18.5.
Update to cmake-3.9.3.
Update to gnupg-2.2.1.
Update to pulseaudio-11.1.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@19288 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 15.7 KB
Line 
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
8 "https://www.freedesktop.org/software/pulseaudio/releases/pulseaudio-&pulseaudio-version;.tar.xz">
9 <!ENTITY pulseaudio-download-ftp " ">
10 <!ENTITY pulseaudio-md5sum "390de38231d5cdd6b43ada8939eb74f1">
11 <!ENTITY pulseaudio-size "1.6 MB">
12 <!ENTITY pulseaudio-buildsize "88 MB (add 2 MB for tests)">
13 <!ENTITY pulseaudio-time "1.5 SBU (add 0.6 SBU for tests)">
14]>
15
16<sect1 id="pulseaudio" xreflabel="PulseAudio-&pulseaudio-version;">
17 <?dbhtml filename="pulseaudio.html"?>
18
19 <sect1info>
20 <othername>$LastChangedBy$</othername>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>PulseAudio-&pulseaudio-version;</title>
25
26 <indexterm zone="pulseaudio">
27 <primary sortas="a-PulseAudio">PulseAudio</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to PulseAudio</title>
32
33 <para>
34 <application>PulseAudio</application> is a sound system for POSIX OSes,
35 meaning that it is a proxy for sound applications. It allows you to do
36 advanced operations on your sound data as it passes between your
37 application and your hardware. Things like transferring the audio to a
38 different machine, changing the sample format or channel count and mixing
39 several sounds into one are easily achieved using a sound server.
40 </para>
41
42 &lfs81_checked;
43
44 <bridgehead renderas="sect3">Package Information</bridgehead>
45 <itemizedlist spacing="compact">
46 <listitem>
47 <para>
48 Download (HTTP): <ulink url="&pulseaudio-download-http;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download (FTP): <ulink url="&pulseaudio-download-ftp;"/>
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download MD5 sum: &pulseaudio-md5sum;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Download size: &pulseaudio-size;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated disk space required: &pulseaudio-buildsize;
69 </para>
70 </listitem>
71 <listitem>
72 <para>
73 Estimated build time: &pulseaudio-time;
74 </para>
75 </listitem>
76 </itemizedlist>
77
78 <bridgehead renderas="sect3">PulseAudio Dependencies</bridgehead>
79
80 <bridgehead renderas="sect4">Required</bridgehead>
81 <para role="required">
82 <xref linkend="json-c"/> and
83 <xref linkend="libsndfile"/>
84 </para>
85
86 <bridgehead renderas="sect4">Recommended</bridgehead>
87 <para role="recommended">
88 <xref linkend="alsa-lib"/>,
89 <xref linkend="dbus"/>,
90 <xref linkend="glib2"/>,
91 <xref linkend="libcap-pam"/>,
92 <xref linkend="openssl"/>,
93 <xref linkend="speex"/> and
94 <xref linkend="xorg7-lib"/>
95 </para>
96
97 <bridgehead renderas="sect4">Optional</bridgehead>
98 <para role="optional">
99 <xref linkend="avahi"/>,
100 <xref linkend="bluez"/>,
101 <xref linkend="check"/>,
102 <phrase revision="sysv">
103 <xref role="runtime" linkend="consolekit"/> (runtime),</phrase>
104 <xref linkend="fftw"/>,
105 <xref linkend="GConf"/>,
106 <xref linkend="gtk3"/>,
107 <xref linkend="libsamplerate"/>,
108 <xref linkend="sbc"/> (Bluetooth support),
109 <xref linkend="valgrind"/>,
110 <ulink url="http://www.jackaudio.org/">JACK</ulink>,
111 <ulink url="http://0pointer.de/lennart/projects/libasyncns/">libasyncns</ulink>,
112 <ulink url="http://www.lirc.org/">LIRC</ulink>,
113 <ulink url="http://gstreamer.freedesktop.org/src/orc/">ORC</ulink>,
114 <ulink url="http://tdb.samba.org/">TDB</ulink>,
115 <ulink url="http://freedesktop.org/software/pulseaudio/webrtc-audio-processing/">
116 WebRTC AudioProcessing</ulink> and
117 <ulink url="http://www.xenproject.org/">XEN</ulink>
118 </para>
119
120 <para condition="html" role="usernotes">User Notes:
121 <ulink url="&blfs-wiki;/pulseaudio"/>
122 </para>
123 </sect2>
124
125 <sect2 role="installation">
126 <title>Installation of PulseAudio</title>
127
128 <para>
129 Install <application>PulseAudio</application> by running the following
130 commands:
131 </para>
132
133<screen><userinput>./configure --prefix=/usr \
134 --sysconfdir=/etc \
135 --localstatedir=/var \
136 --disable-bluez4 \
137 --disable-bluez5 \
138 --disable-rpath &amp;&amp;
139make</userinput></screen>
140
141 <para>
142 To test the results, issue: <command>make check</command>.
143 </para>
144
145 <para>
146 Now, as the <systemitem class="username">root</systemitem> user:
147 </para>
148
149<screen role="root"><userinput>make install</userinput></screen>
150
151 <!-- http://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SystemWide/ -->
152 <para>
153 While still as the <systemitem class="username">root</systemitem>
154 user, remove the <application>D-Bus</application> configuration file
155 for the system wide daemon to avoid creating unnecessary system
156 users and groups:
157 </para>
158
159<screen role="root"><userinput>rm -fv /etc/dbus-1/system.d/pulseaudio-system.conf</userinput></screen>
160
161 </sect2>
162
163 <sect2 role="commands">
164 <title>Command Explanations</title>
165
166 <para>
167 <parameter>--disable-bluez4</parameter>: This switch disables
168 support for <application>BlueZ</application> version 4 in favour
169 of <application>BlueZ</application> version 5 since the latter
170 also installs compatibility library for the earlier version.
171 </para>
172
173 <para>
174 <parameter>--disable-bluez5</parameter>: This switch prevents
175 a runtime error if <xref linkend="dbus"/> and <xref linkend="sbc"/>
176 are both installed but <xref linkend="bluez"/> is not installed.
177 Remove this if you have installed all three packages.
178 </para>
179
180 <para>
181 <parameter>--disable-rpath</parameter>: This switch prevents
182 linker from adding a hardcoded runtime path to the installed
183 programs and libraries.
184 </para>
185
186 </sect2>
187
188 <sect2 role="configuration">
189 <title>Configuring PulseAudio</title>
190
191 <sect3 id="pulseaudio-config">
192 <title>Config Files</title>
193 <para>
194 There are system wide configuration files:
195 <filename>/etc/pulse/daemon.conf</filename>,
196 <filename>/etc/pulse/client.conf</filename>,
197 <filename>/etc/pulse/default.pa</filename>, and user configuration
198 files with the same names in
199 <filename class="directory">~/.config/pulse</filename>. User
200 configuration files take precedence over system wide ones.
201 </para>
202
203 <indexterm zone="pulseaudio pulseaudio-config">
204 <primary sortas="e-AA.config-pulse">~/.config/pulse</primary>
205 </indexterm>
206
207 <indexterm zone="pulseaudio pulseaudio-config">
208 <primary
209 sortas="e-etc-pulse-daemon.conf">/etc/pulse/daemon.conf</primary>
210 </indexterm>
211
212 <indexterm zone="pulseaudio pulseaudio-config">
213 <primary
214 sortas="e-etc-pulse-client.conf">/etc/pulse/client.conf</primary>
215 </indexterm>
216
217 <indexterm zone="pulseaudio pulseaudio-config">
218 <primary
219 sortas="e-etc-pulse-default.pa">/etc/pulse/default.pa</primary>
220 </indexterm>
221 </sect3>
222
223 <sect3><title>Configuration Information</title>
224
225 <para>
226 The default configuration files allow setting up a working installation.
227 However, a reference to Console-Kit needs to be removed if it is
228 not installed. For example, issue the following command as the
229 <systemitem class="username">root</systemitem> user:
230 </para>
231
232<screen role="root"><userinput>sed -i '/load-module module-console-kit/s/^/#/' /etc/pulse/default.pa</userinput></screen>
233
234 <para>
235 You may also have to configure the audio system. You can start
236 <application>pulseaudio</application> in command line mode using
237 <command>pulseaudio -C</command> and then list various
238 information and change settings. See
239 <command>man pulse-cli-syntax</command>.
240 </para>
241 </sect3>
242 </sect2>
243
244 <sect2 role="content">
245 <title>Contents</title>
246
247 <segmentedlist>
248 <segtitle>Installed Programs</segtitle>
249 <segtitle>Installed Libraries</segtitle>
250 <segtitle>Installed Directories</segtitle>
251
252 <seglistitem>
253 <seg>
254 esdcompat, pacat, pacmd, pactl, padsp, pamon (symlink to pacat),
255 paplay (symlink to pacat), parec (symlink to pacat),
256 parecord (symlink to pacat), pasuspender,
257 pax11publish, pulseaudio, and
258 <!-- it looks like the equalizer needs FFTW: qpaeq, -->
259 start-pulseaudio-x11
260 </seg>
261 <seg>
262 libpulse.so
263 libpulse-mainloop-glib.so,
264 libpulse-simple.so,
265 libpulsecommon-&pulseaudio-major-version;.so,
266 libpulsecore-&pulseaudio-major-version;.so, and
267 libpulsedsp.so
268
269 </seg>
270 <seg>
271 /etc/pulse,
272 /usr/include/pulse,
273 /usr/lib/cmake/PulseAudio,
274 /usr/lib/{pulseaudio,pulse-&pulseaudio-major-version;},
275 /usr/libexec/pulse, and
276 /usr/share/pulseaudio
277 </seg>
278 </seglistitem>
279 </segmentedlist>
280
281 <variablelist>
282 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
283 <?dbfo list-presentation="list"?>
284 <?dbhtml list-presentation="table"?>
285
286 <varlistentry id="esdcompat">
287 <term><command>esdcompat</command></term>
288 <listitem>
289 <para>
290 is the <application>PulseAudio</application> ESD wrapper script.
291 </para>
292 <indexterm zone="pulseaudio esdcompat">
293 <primary sortas="b-esdcompat">esdcompat</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="pacat">
299 <term><command>pacat</command></term>
300 <listitem>
301 <para>
302 plays back or records raw or encoded audio streams on a
303 <application>PulseAudio</application> sound server.
304 </para>
305 <indexterm zone="pulseaudio pacat">
306 <primary sortas="b-pacat">pacat</primary>
307 </indexterm>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry id="pacmd">
312 <term><command>pacmd</command></term>
313 <listitem>
314 <para>
315 is a tool used to reconfigure a <application>PulseAudio</application>
316 sound server during runtime.
317 </para>
318 <indexterm zone="pulseaudio pacmd">
319 <primary sortas="b-pacmd">pacmd</primary>
320 </indexterm>
321 </listitem>
322 </varlistentry>
323
324 <varlistentry id="pactl">
325 <term><command>pactl</command></term>
326 <listitem>
327 <para>
328 is used to control a running <application>PulseAudio</application>
329 sound server.
330 </para>
331 <indexterm zone="pulseaudio pactl">
332 <primary sortas="b-pactl">pactl</primary>
333 </indexterm>
334 </listitem>
335 </varlistentry>
336
337 <varlistentry id="padsp">
338 <term><command>padsp</command></term>
339 <listitem>
340 <para>
341 is the <application>PulseAudio</application> OSS Wrapper.
342 </para>
343 <indexterm zone="pulseaudio padsp">
344 <primary sortas="b-padsp">padsp</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348
349 <varlistentry id="pamon">
350 <term><command>pamon</command></term>
351 <listitem>
352 <para>
353 is a symbolic link to <command>pacat</command>.
354 </para>
355 <indexterm zone="pulseaudio pamon">
356 <primary sortas="b-pamon">pamon</primary>
357 </indexterm>
358 </listitem>
359 </varlistentry>
360
361 <varlistentry id="paplay">
362 <term><command>paplay</command></term>
363 <listitem>
364 <para>
365 is used to play audio files on a
366 <application>PulseAudio</application> sound server.
367 </para>
368 <indexterm zone="pulseaudio paplay">
369 <primary sortas="b-paplay">paplay</primary>
370 </indexterm>
371 </listitem>
372 </varlistentry>
373
374 <varlistentry id="parec">
375 <term><command>parec</command></term>
376 <listitem>
377 <para>
378 is a symbolic link to <command>pacat</command>.
379 </para>
380 <indexterm zone="pulseaudio parec">
381 <primary sortas="b-parec">parec</primary>
382 </indexterm>
383 </listitem>
384 </varlistentry>
385
386 <varlistentry id="parecord">
387 <term><command>parecord</command></term>
388 <listitem>
389 <para>
390 is a symbolic link to <command>pacat</command>.
391 </para>
392 <indexterm zone="pulseaudio parecord">
393 <primary sortas="b-parecord">parecord</primary>
394 </indexterm>
395 </listitem>
396 </varlistentry>
397
398 <varlistentry id="pasuspender">
399 <term><command>pasuspender</command></term>
400 <listitem>
401 <para>
402 is a tool that can be used to tell a local
403 <application>PulseAudio</application> sound server to temporarily
404 suspend access to the audio devices, to allow other applications
405 to access them directly.
406 </para>
407 <indexterm zone="pulseaudio pasuspender">
408 <primary sortas="b-pasuspender">pasuspender</primary>
409 </indexterm>
410 </listitem>
411 </varlistentry>
412
413 <varlistentry id="pax11publish">
414 <term><command>pax11publish</command></term>
415 <listitem>
416 <para>
417 is the <application>PulseAudio</application>
418 X11 Credential Utility.
419 </para>
420 <indexterm zone="pulseaudio pax11publish">
421 <primary sortas="b-pax11publish">pax11publish</primary>
422 </indexterm>
423 </listitem>
424 </varlistentry>
425
426 <varlistentry id="pulseaudio-prog">
427 <term><command>pulseaudio</command></term>
428 <listitem>
429 <para>
430 is a networked low-latency sound server for Linux.
431 </para>
432 <indexterm zone="pulseaudio pulseaudio-prog">
433 <primary sortas="b-pulseaudio">pulseaudio</primary>
434 </indexterm>
435 </listitem>
436 </varlistentry>
437
438<!-- only installed if FFTW is present
439 <varlistentry id="qpaeq">
440 <term><command>qpaeq</command></term>
441 <listitem>
442 <para>
443 is an equalizer interface for
444 <application>PulseAudio</application> equalizer sinks.
445 </para>
446 <indexterm zone="pulseaudio qpaeq">
447 <primary sortas="b-qpaeq">qpaeq</primary>
448 </indexterm>
449 </listitem>
450 </varlistentry>
451-->
452<!-- Not found in PA 7.0
453 <varlistentry id="start-pulseaudio-kde">
454 <term><command>start-pulseaudio-kde</command></term>
455 <listitem>
456 <para>
457 Starts <application>PulseAudio</application> and loads
458 module-device-manager to use KDE routing policies.
459 </para>
460 <indexterm zone="pulseaudio start-pulseaudio-kde">
461 <primary sortas="b-start-pulseaudio-kde">start-pulseaudio-kde</primary>
462 </indexterm>
463 </listitem>
464 </varlistentry>
465-->
466 <varlistentry id="start-pulseaudio-x11">
467 <term><command>start-pulseaudio-x11</command></term>
468 <listitem>
469 <para>
470 starts <application>PulseAudio</application> and registers it to
471 the X11 session manager.
472 </para>
473 <indexterm zone="pulseaudio start-pulseaudio-x11">
474 <primary sortas="b-start-pulseaudio-x11">start-pulseaudio-x11</primary>
475 </indexterm>
476 </listitem>
477 </varlistentry>
478
479 </variablelist>
480
481 </sect2>
482
483</sect1>
Note: See TracBrowser for help on using the repository browser.