source: multimedia/libdriv/pulseaudio.xml@ fd968dd

systemd-11177
Last change on this file since fd968dd was fd968dd, checked in by Krejzi <krejzi@…>, 11 years ago

Drop pkg-config from systemd branch.

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

  • Property mode set to 100644
File size: 13.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 "http://freedesktop.org/software/pulseaudio/releases/pulseaudio-&pulseaudio-version;.tar.xz">
8 <!ENTITY pulseaudio-download-ftp " ">
9 <!ENTITY pulseaudio-md5sum "47fd7eca8479c757822bee68a1feef25">
10 <!ENTITY pulseaudio-size "1.4 MB">
11 <!ENTITY pulseaudio-buildsize "105 MB">
12 <!ENTITY pulseaudio-time "1.6 SBU">
13]>
14
15<sect1 id="pulseaudio" xreflabel="PulseAudio-&pulseaudio-version;">
16 <?dbhtml filename="pulseaudio.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>PulseAudio-&pulseaudio-version;</title>
24
25 <indexterm zone="pulseaudio">
26 <primary sortas="a-PulseAudio">PulseAudio</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to PulseAudio</title>
31
32 <para>
33 <application>PulseAudio</application> is a sound system for POSIX OSes,
34 meaning that it is a proxy for sound applications. It allows you to do
35 advanced operations on your sound data as it passes between your application
36 and your hardware. Things like transferring the audio to a different machine,
37 changing the sample format or channel count and mixing several sounds into
38 one are easily achieved using a sound server.
39 </para>
40
41 &lfs73_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>
47 Download (HTTP): <ulink url="&pulseaudio-download-http;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download (FTP): <ulink url="&pulseaudio-download-ftp;"/>
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download MD5 sum: &pulseaudio-md5sum;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Download size: &pulseaudio-size;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated disk space required: &pulseaudio-buildsize;
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Estimated build time: &pulseaudio-time;
73 </para>
74 </listitem>
75 </itemizedlist>
76
77 <bridgehead renderas="sect3">PulseAudio Dependencies</bridgehead>
78
79 <bridgehead renderas="sect4">Required</bridgehead>
80 <para role="required">
81 <xref linkend="intltool"/>,
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="libcap2"/>,
91 <xref linkend="openssl"/>,
92 <xref linkend="speex"/> and
93 <xref linkend="xorg7-lib"/> <!-- Useful for KDE, too -->
94 </para>
95
96 <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
97 <para role="optional">
98 <xref linkend="GConf"/>,
99 <xref linkend="glib2"/> and
100 <xref linkend="gtk2"/>
101 </para>
102
103 <bridgehead renderas="sect4">Optional</bridgehead>
104 <para role="optional">
105 <xref linkend="avahi"/>,
106 <xref linkend="bluez"/> and <xref linkend="sbc"/>,
107 <xref linkend="check"/>,
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 <xref linkend="libsamplerate"/>,
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://valgrind.org/">Valgrind</ulink>,
116 <ulink url="http://freedesktop.org/software/pulseaudio/webrtc-audio-processing/">
117 WebRTC AudioProcessing</ulink> and
118 <ulink url="http://www.xen.org/">XEN</ulink>
119 </para>
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 In order for <application>PulseAudio</application> to communicate
130 properly with D-BUS, create a unique user. As the <systemitem
131 class="username">root</systemitem> user, run:
132 </para>
133
134<screen role="root"><userinput>groupadd -g 58 pulse &amp;&amp;
135groupadd -g 59 pulse-access &amp;&amp;
136useradd -c "Pulseaudio User" -d /var/run/pulse -g pulse \
137 -s /bin/false -u 58 pulse &amp;&amp;
138usermod -a -G audio pulse</userinput></screen>
139
140 <para>
141 Install <application>PulseAudio</application> by running the following
142 commands:
143 </para>
144
145<screen><userinput>find . -name "Makefile.in" | xargs sed -i "s|(libdir)/@PACKAGE@|(libdir)/pulse|" &amp;&amp;
146sed -i "s@json >= 0.9@json-c >= 0.11@g" configure &amp;&amp;
147./configure --prefix=/usr \
148 --sysconfdir=/etc \
149 --localstatedir=/var \
150 --libexecdir=/usr/lib \
151 --with-module-dir=/usr/lib/pulse/modules &amp;&amp;
152make</userinput></screen>
153
154 <para>
155 To test the results, issue: <command>make check</command>.
156 </para>
157
158 <para>
159 Now, as the <systemitem class="username">root</systemitem> user:
160 </para>
161
162<screen role="root"><userinput>make install</userinput></screen>
163
164 </sect2>
165
166 <sect2 role="commands">
167 <title>Command Explanations</title>
168
169 <para>
170 <command>find . -name Makefile.in ...</command>: This sed changes
171 the build system to install <application>PulseAudio</application>
172 private libraries into
173 <filename class="directory">/usr/lib/pulse</filename> instead of
174 <filename class="directory">/usr/lib/pulseaudio</filename>.
175 </para>
176
177 <para>
178 <command>sed -i "s@json >= 0.9@json-c >= 0.11@g" configure</command>:
179 This sed fixes building with <application>JSON-C</application> 0.11.
180 </para>
181
182 <para>
183 <parameter>--with-module-dir=/usr/lib/pulse/modules</parameter>:
184 This parameter ensures that <application>PulseAudio</application>
185 modules are installed in <filename class="directory">/usr/lib/pulse/modules
186 </filename> instead of <filename class="directory">
187 /usr/lib/pulse-&pulseaudio-version;/modules</filename>.
188 </para>
189
190 </sect2>
191
192 <sect2 role="content">
193 <title>Contents</title>
194
195 <segmentedlist>
196 <segtitle>Installed Programs</segtitle>
197 <segtitle>Installed Libraries</segtitle>
198 <segtitle>Installed Directories</segtitle>
199
200 <seglistitem>
201 <seg>
202 esdcompat, pacat, pacmd, pactl, padsp, pamon, paplay, parec,
203 parecord, pasuspender, pax11publish, pulseaudio, qpaeq,
204 start-pulseaudio-kde and start-pulseaudio-x11
205 </seg>
206 <seg>
207 libpulsecore-&pulseaudio-version;.so, libpulse-mainloop-glib.so,
208 libpulse-simple.so and libpulse.so
209 </seg>
210 <seg>
211 /etc/pulse,
212 /usr/include/pulse,
213 /usr/lib/cmake/PulseAudio,
214 /usr/lib/pulse and
215 /usr/share/pulseaudio
216 </seg>
217 </seglistitem>
218 </segmentedlist>
219
220 <variablelist>
221 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
222 <?dbfo list-presentation="list"?>
223 <?dbhtml list-presentation="table"?>
224
225 <varlistentry id="esdcompat">
226 <term><command>esdcompat</command></term>
227 <listitem>
228 <para>
229 is the <application>PulseAudio</application> ESD wrapper script.
230 </para>
231 <indexterm zone="pulseaudio esdcompat">
232 <primary sortas="b-esdcompat">esdcompat</primary>
233 </indexterm>
234 </listitem>
235 </varlistentry>
236
237 <varlistentry id="pacat">
238 <term><command>pacat</command></term>
239 <listitem>
240 <para>
241 Plays back or records raw or encoded audio streams on a
242 <application>PulseAudio</application> sound server.
243 </para>
244 <indexterm zone="pulseaudio pacat">
245 <primary sortas="b-pacat">pacat</primary>
246 </indexterm>
247 </listitem>
248 </varlistentry>
249
250 <varlistentry id="pacmd">
251 <term><command>pacmd</command></term>
252 <listitem>
253 <para>
254 is a tool used to reconfigure a <application>PulseAudio</application>
255 sound server during runtime.
256 </para>
257 <indexterm zone="pulseaudio pacmd">
258 <primary sortas="b-pacmd">pacmd</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>
262
263 <varlistentry id="pactl">
264 <term><command>pactl</command></term>
265 <listitem>
266 <para>
267 is used to control a running <application>PulseAudio</application>
268 sound server.
269 </para>
270 <indexterm zone="pulseaudio pactl">
271 <primary sortas="b-pactl">pactl</primary>
272 </indexterm>
273 </listitem>
274 </varlistentry>
275
276 <varlistentry id="padsp">
277 <term><command>padsp</command></term>
278 <listitem>
279 <para>
280 is the <application>PulseAudio</application> OSS Wrapper.
281 </para>
282 <indexterm zone="pulseaudio padsp">
283 <primary sortas="b-padsp">padsp</primary>
284 </indexterm>
285 </listitem>
286 </varlistentry>
287
288 <varlistentry id="pamon">
289 <term><command>pamon</command></term>
290 <listitem>
291 <para>
292 is a symbolic link to <command>pacat</command>.
293 </para>
294 <indexterm zone="pulseaudio pamon">
295 <primary sortas="b-pamon">pamon</primary>
296 </indexterm>
297 </listitem>
298 </varlistentry>
299
300 <varlistentry id="paplay">
301 <term><command>paplay</command></term>
302 <listitem>
303 <para>
304 is used to play audio files on a
305 <application>PulseAudio</application> sound server.
306 </para>
307 <indexterm zone="pulseaudio paplay">
308 <primary sortas="b-paplay">paplay</primary>
309 </indexterm>
310 </listitem>
311 </varlistentry>
312
313 <varlistentry id="parec">
314 <term><command>parec</command></term>
315 <listitem>
316 <para>
317 is a symbolic link to <command>pacat</command>.
318 </para>
319 <indexterm zone="pulseaudio parec">
320 <primary sortas="b-parec">parec</primary>
321 </indexterm>
322 </listitem>
323 </varlistentry>
324
325 <varlistentry id="parecord">
326 <term><command>parecord</command></term>
327 <listitem>
328 <para>
329 is a symbolic link to <command>pacat</command>.
330 </para>
331 <indexterm zone="pulseaudio parecord">
332 <primary sortas="b-parecord">parecord</primary>
333 </indexterm>
334 </listitem>
335 </varlistentry>
336
337 <varlistentry id="pasuspender">
338 <term><command>pasuspender</command></term>
339 <listitem>
340 <para>
341 is a tool that can be used to tell a local
342 <application>PulseAudio</application> sound server to temporarily
343 suspend access to the audio devices, to allow other applications
344 to access them directly.
345 </para>
346 <indexterm zone="pulseaudio pasuspender">
347 <primary sortas="b-pasuspender">pasuspender</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="pax11publish">
353 <term><command>pax11publish</command></term>
354 <listitem>
355 <para>
356 is the <application>PulseAudio</application>
357 X11 Credential Utility.
358 </para>
359 <indexterm zone="pulseaudio pax11publish">
360 <primary sortas="b-pax11publish">pax11publish</primary>
361 </indexterm>
362 </listitem>
363 </varlistentry>
364
365 <varlistentry id="pulseaudio-prog">
366 <term><command>pulseaudio</command></term>
367 <listitem>
368 <para>
369 is a networked low-latency sound server for Linux.
370 </para>
371 <indexterm zone="pulseaudio pulseaudio-prog">
372 <primary sortas="b-pulseaudio">pulseaudio</primary>
373 </indexterm>
374 </listitem>
375 </varlistentry>
376
377 <varlistentry id="qpaeq">
378 <term><command>qpaeq</command></term>
379 <listitem>
380 <para>
381 is an equalizer interface for
382 <application>PulseAudio</application> equalizer sinks.
383 </para>
384 <indexterm zone="pulseaudio qpaeq">
385 <primary sortas="b-qpaeq">qpaeq</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry id="start-pulseaudio-kde">
391 <term><command>start-pulseaudio-kde</command></term>
392 <listitem>
393 <para>
394 Starts <application>PulseAudio</application> and loads
395 module-device-manager to use KDE routing policies.
396 </para>
397 <indexterm zone="pulseaudio start-pulseaudio-kde">
398 <primary sortas="b-start-pulseaudio-kde">start-pulseaudio-kde</primary>
399 </indexterm>
400 </listitem>
401 </varlistentry>
402
403 <varlistentry id="start-pulseaudio-x11">
404 <term><command>start-pulseaudio-x11</command></term>
405 <listitem>
406 <para>
407 Starts <application>PulseAudio</application> and registers it to
408 the X11 session manager.
409 </para>
410 <indexterm zone="pulseaudio start-pulseaudio-x11">
411 <primary sortas="b-start-pulseaudio-x11">start-pulseaudio-x11</primary>
412 </indexterm>
413 </listitem>
414 </varlistentry>
415
416 </variablelist>
417
418 </sect2>
419
420</sect1>
Note: See TracBrowser for help on using the repository browser.