source: multimedia/libdriv/pulseaudio.xml@ e5d2270e

10.0 10.1 11.0 7.10 7.6 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt krejzi/svn lazarus nosym perl-modules qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since e5d2270e was e5d2270e, checked in by Pierre Labastie <pieere@…>, 7 years ago

Add configuration instructions to PulseAudio.

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

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