source: multimedia/libdriv/pulseaudio.xml@ ded78c6

10.0 10.1 11.0 7.10 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 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 ded78c6 was ded78c6, checked in by Bruce Dubbs <bdubbs@…>, 7 years ago

Simplify several urls

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

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