source: multimedia/libdriv/pulseaudio.xml@ f1ce80b

10.0 10.1 11.0 7.10 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 xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since f1ce80b was f1ce80b, checked in by DJ Lucas <dj@…>, 5 years ago

[systemd-merge] - Section II layout

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

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