source: multimedia/libdriv/pulseaudio.xml@ 902fb47

10.0 10.1 11.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus perl-modules qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 902fb47 was 902fb47, checked in by DJ Lucas <dj@…>, 4 years ago

More tags.

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

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