source: multimedia/libdriv/pulseaudio.xml@ 64135787

kde5-14269
Last change on this file since 64135787 was 64135787, checked in by Xi Ruoyao <xry111@…>, 3 years ago

Begin manually (while modifying stuff) merging trunk and systemd branches since revision 14087.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/kde5@14270 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 15.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 &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="openssl"/>,
92 <xref linkend="speex"/> and
93 <xref linkend="xorg7-lib"/>
94 </para>
95
96 <bridgehead renderas="sect4">Optional</bridgehead>
97 <para role="optional">
98 <xref linkend="avahi"/>,
99 <xref linkend="bluez"/> (runtime),
100 <xref linkend="check"/>,
101 <xref linkend="GConf"/>,
102 <xref linkend="gtk3"/>,
103 <xref linkend="libsamplerate"/>,
104 <xref linkend="sbc"/> (Bluetooth support),
105 <xref linkend="valgrind"/>,
106 <ulink url="http://www.fftw.org/">FFTW</ulink>,
107 <ulink url="http://www.jackaudio.org/">JACK</ulink>,
108<!-- <ulink url="http://0pointer.de/lennart/projects/libasyncns/">libasyncns</ulink>,-->
109 <ulink url="&fedora-http-repo;/libasyncns/">libasyncns</ulink>,
110 <ulink url="http://www.lirc.org/">LIRC</ulink>,
111 <ulink url="http://code.entropywave.com/projects/orc/">ORC</ulink>,
112 <ulink url="http://tdb.samba.org/">TDB</ulink>,
113 <ulink url="http://freedesktop.org/software/pulseaudio/webrtc-audio-processing/">
114 WebRTC AudioProcessing</ulink> and
115 <ulink url="http://www.xen.org/">XEN</ulink>
116 </para>
117
118 <para condition="html" role="usernotes">User Notes:
119 <ulink url="&blfs-wiki;/pulseaudio"/>
120 </para>
121 </sect2>
122
123 <sect2 role="installation">
124 <title>Installation of PulseAudio</title>
125
126 <para>
127 Install <application>PulseAudio</application> by running the following
128 commands:
129 </para>
130
131<screen><userinput>find . -name "Makefile.in" | xargs sed -i "s|(libdir)/@PACKAGE@|(libdir)/pulse|" &amp;&amp;
132./configure --prefix=/usr \
133 --sysconfdir=/etc \
134 --localstatedir=/var \
135 --disable-bluez4 \
136 --disable-rpath \
137 --with-module-dir=/usr/lib/pulse/modules &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 -fv /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 <command>find . -name Makefile.in ...</command>: This sed changes
167 the build system to install <application>PulseAudio</application>
168 private libraries into
169 <filename class="directory">/usr/lib/pulse</filename> instead of
170 <filename class="directory">/usr/lib/pulseaudio</filename>.
171 </para>
172
173 <para>
174 <parameter>--disable-bluez4</parameter>: This switch disables
175 support for <application>BlueZ</application> version 4 in favour
176 of <application>BlueZ</application> version 5 since the latter
177 also installs compatibility library for the earlier version.
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 <para>
187 <parameter>--with-module-dir=/usr/lib/pulse/modules</parameter>:
188 This parameter ensures that <application>PulseAudio</application>
189 modules are installed in <filename class="directory">/usr/lib/pulse/modules
190 </filename> instead of <filename class="directory">
191 /usr/lib/pulse-&pulseaudio-major-version;/modules</filename>.
192 </para>
193
194 </sect2>
195
196 <sect2 role="configuration">
197 <title>Configuring PulseAudio</title>
198
199 <sect3 id="pulseaudio-config">
200 <title>Config Files</title>
201
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
231 </sect3>
232
233 </sect2>
234
235 <sect2 role="content">
236 <title>Contents</title>
237
238 <segmentedlist>
239 <segtitle>Installed Programs</segtitle>
240 <segtitle>Installed Libraries</segtitle>
241 <segtitle>Installed Directories</segtitle>
242
243 <seglistitem>
244 <seg>
245 esdcompat, pacat, pacmd, pactl, padsp, pamon (symlink),
246 paplay (symlink), parec (symlink), parecord (symlink), pasuspender,
247 pax11publish, pulseaudio, qpaeq,
248 start-pulseaudio-kde and start-pulseaudio-x11
249 </seg>
250 <seg>
251 libpulsecore-&pulseaudio-major-version;.so, libpulse-mainloop-glib.so,
252 libpulse-simple.so and libpulse.so
253 </seg>
254 <seg>
255 /etc/pulse,
256 /usr/include/pulse,
257 /usr/lib/cmake/PulseAudio,
258 /usr/lib/pulse, and
259 /usr/share/pulseaudio
260 </seg>
261 </seglistitem>
262 </segmentedlist>
263
264 <variablelist>
265 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
266 <?dbfo list-presentation="list"?>
267 <?dbhtml list-presentation="table"?>
268
269 <varlistentry id="esdcompat">
270 <term><command>esdcompat</command></term>
271 <listitem>
272 <para>
273 is the <application>PulseAudio</application> ESD wrapper script.
274 </para>
275 <indexterm zone="pulseaudio esdcompat">
276 <primary sortas="b-esdcompat">esdcompat</primary>
277 </indexterm>
278 </listitem>
279 </varlistentry>
280
281 <varlistentry id="pacat">
282 <term><command>pacat</command></term>
283 <listitem>
284 <para>
285 Plays back or records raw or encoded audio streams on a
286 <application>PulseAudio</application> sound server.
287 </para>
288 <indexterm zone="pulseaudio pacat">
289 <primary sortas="b-pacat">pacat</primary>
290 </indexterm>
291 </listitem>
292 </varlistentry>
293
294 <varlistentry id="pacmd">
295 <term><command>pacmd</command></term>
296 <listitem>
297 <para>
298 is a tool used to reconfigure a <application>PulseAudio</application>
299 sound server during runtime.
300 </para>
301 <indexterm zone="pulseaudio pacmd">
302 <primary sortas="b-pacmd">pacmd</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>
306
307 <varlistentry id="pactl">
308 <term><command>pactl</command></term>
309 <listitem>
310 <para>
311 is used to control a running <application>PulseAudio</application>
312 sound server.
313 </para>
314 <indexterm zone="pulseaudio pactl">
315 <primary sortas="b-pactl">pactl</primary>
316 </indexterm>
317 </listitem>
318 </varlistentry>
319
320 <varlistentry id="padsp">
321 <term><command>padsp</command></term>
322 <listitem>
323 <para>
324 is the <application>PulseAudio</application> OSS Wrapper.
325 </para>
326 <indexterm zone="pulseaudio padsp">
327 <primary sortas="b-padsp">padsp</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="pamon">
333 <term><command>pamon</command></term>
334 <listitem>
335 <para>
336 is a symbolic link to <command>pacat</command>.
337 </para>
338 <indexterm zone="pulseaudio pamon">
339 <primary sortas="b-pamon">pamon</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="paplay">
345 <term><command>paplay</command></term>
346 <listitem>
347 <para>
348 is used to play audio files on a
349 <application>PulseAudio</application> sound server.
350 </para>
351 <indexterm zone="pulseaudio paplay">
352 <primary sortas="b-paplay">paplay</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="parec">
358 <term><command>parec</command></term>
359 <listitem>
360 <para>
361 is a symbolic link to <command>pacat</command>.
362 </para>
363 <indexterm zone="pulseaudio parec">
364 <primary sortas="b-parec">parec</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry id="parecord">
370 <term><command>parecord</command></term>
371 <listitem>
372 <para>
373 is a symbolic link to <command>pacat</command>.
374 </para>
375 <indexterm zone="pulseaudio parecord">
376 <primary sortas="b-parecord">parecord</primary>
377 </indexterm>
378 </listitem>
379 </varlistentry>
380
381 <varlistentry id="pasuspender">
382 <term><command>pasuspender</command></term>
383 <listitem>
384 <para>
385 is a tool that can be used to tell a local
386 <application>PulseAudio</application> sound server to temporarily
387 suspend access to the audio devices, to allow other applications
388 to access them directly.
389 </para>
390 <indexterm zone="pulseaudio pasuspender">
391 <primary sortas="b-pasuspender">pasuspender</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 <varlistentry id="pax11publish">
397 <term><command>pax11publish</command></term>
398 <listitem>
399 <para>
400 is the <application>PulseAudio</application>
401 X11 Credential Utility.
402 </para>
403 <indexterm zone="pulseaudio pax11publish">
404 <primary sortas="b-pax11publish">pax11publish</primary>
405 </indexterm>
406 </listitem>
407 </varlistentry>
408
409 <varlistentry id="pulseaudio-prog">
410 <term><command>pulseaudio</command></term>
411 <listitem>
412 <para>
413 is a networked low-latency sound server for Linux.
414 </para>
415 <indexterm zone="pulseaudio pulseaudio-prog">
416 <primary sortas="b-pulseaudio">pulseaudio</primary>
417 </indexterm>
418 </listitem>
419 </varlistentry>
420
421 <varlistentry id="qpaeq">
422 <term><command>qpaeq</command></term>
423 <listitem>
424 <para>
425 is an equalizer interface for
426 <application>PulseAudio</application> equalizer sinks.
427 </para>
428 <indexterm zone="pulseaudio qpaeq">
429 <primary sortas="b-qpaeq">qpaeq</primary>
430 </indexterm>
431 </listitem>
432 </varlistentry>
433
434 <varlistentry id="start-pulseaudio-kde">
435 <term><command>start-pulseaudio-kde</command></term>
436 <listitem>
437 <para>
438 Starts <application>PulseAudio</application> and loads
439 module-device-manager to use KDE routing policies.
440 </para>
441 <indexterm zone="pulseaudio start-pulseaudio-kde">
442 <primary sortas="b-start-pulseaudio-kde">start-pulseaudio-kde</primary>
443 </indexterm>
444 </listitem>
445 </varlistentry>
446
447 <varlistentry id="start-pulseaudio-x11">
448 <term><command>start-pulseaudio-x11</command></term>
449 <listitem>
450 <para>
451 Starts <application>PulseAudio</application> and registers it to
452 the X11 session manager.
453 </para>
454 <indexterm zone="pulseaudio start-pulseaudio-x11">
455 <primary sortas="b-start-pulseaudio-x11">start-pulseaudio-x11</primary>
456 </indexterm>
457 </listitem>
458 </varlistentry>
459
460 </variablelist>
461
462 </sect2>
463
464</sect1>
Note: See TracBrowser for help on using the repository browser.