source: multimedia/libdriv/pulseaudio.xml@ 6176e47

trunk
Last change on this file since 6176e47 was d3fbf9e, checked in by Xi Ruoyao <xry111@…>, 2 weeks ago

pulseaudio: Fix a typo

Reported-by: Jamie Gibbs <jimgibbs@…>

  • Property mode set to 100644
File size: 17.9 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
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 "https://www.freedesktop.org/software/pulseaudio/releases/pulseaudio-&pulseaudio-version;.tar.xz">
9 <!ENTITY pulseaudio-download-ftp " ">
10 <!ENTITY pulseaudio-md5sum "c4a3596a26ff4b9dcd0c394dd1d4f8ee">
11 <!ENTITY pulseaudio-size "1.5 MB">
12 <!ENTITY pulseaudio-buildsize "42 MB (with tests)">
13 <!ENTITY pulseaudio-time "0.2 SBU (Using parallelism=4; add 0.2 SBU for tests)">
14]>
15
16<sect1 id="pulseaudio" xreflabel="PulseAudio-&pulseaudio-version;">
17 <?dbhtml filename="pulseaudio.html"?>
18
19
20 <title>PulseAudio-&pulseaudio-version;</title>
21
22 <indexterm zone="pulseaudio">
23 <primary sortas="a-PulseAudio">PulseAudio</primary>
24 </indexterm>
25
26 <sect2 role="package">
27 <title>Introduction to PulseAudio</title>
28
29 <para>
30 <application>PulseAudio</application> is a sound system for POSIX OSes,
31 meaning that it is a proxy for sound applications. It allows you to do
32 advanced operations on your sound data as it passes between your
33 application and your hardware. Operations such as transferring
34 the audio to a different machine, changing the sample format or channel
35 count, and mixing several sounds into one are easily achieved using a
36 sound server.
37 </para>
38
39 &lfs122_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&pulseaudio-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&pulseaudio-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &pulseaudio-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &pulseaudio-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &pulseaudio-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &pulseaudio-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">PulseAudio Dependencies</bridgehead>
76
77 <bridgehead renderas="sect4">Required</bridgehead>
78 <para role="required">
79 <xref linkend="libsndfile"/>
80 </para>
81
82 <bridgehead renderas="sect4">Recommended</bridgehead>
83 <para role="recommended">
84 <xref linkend="alsa-lib"/>,
85 <xref linkend="dbus"/>,
86 <phrase revision="sysv"><xref linkend="elogind"/>,</phrase>
87 <xref linkend="glib2"/>,
88 <xref linkend="speex"/> and
89 <xref linkend="xorg7-lib"/>
90 </para>
91
92 <bridgehead renderas="sect4">Optional</bridgehead>
93 <para role="optional">
94 <xref linkend="avahi"/>,
95 <xref linkend="bluez"/>,
96 <xref linkend="doxygen"/> (for documentation),
97 <xref linkend="fftw"/>,
98 <xref linkend="gtk3"/>,
99 <xref linkend="libsamplerate"/>,
100 <xref linkend="sbc"/> (Bluetooth support),
101 <xref linkend="valgrind"/>,
102 <ulink url="https://jackaudio.org/">JACK</ulink>,
103 <ulink url="https://0pointer.de/lennart/projects/libasyncns/">libasyncns</ulink>,
104 <ulink url="https://www.lirc.org/">LIRC</ulink>,
105 <ulink url="https://gstreamer.freedesktop.org/src/orc/">ORC</ulink>,
106 <ulink url="https://sourceforge.net/projects/soxr/">soxr</ulink>,
107 <ulink url="https://tdb.samba.org/">TDB</ulink>, and
108 <ulink url="https://www.freedesktop.org/software/pulseaudio/webrtc-audio-processing/">
109 WebRTC AudioProcessing</ulink>
110 <!--<ulink url="http://www.xenproject.org/">XEN</ulink>-->
111 </para>
112
113 </sect2>
114
115 <sect2 role="installation">
116 <title>Installation of PulseAudio</title>
117<!--
118 <para>
119 If <xref linkend="doxygen"/> is not installed, workaround a building
120 issue because of the changes in meson-0.57.2:
121 </para>
122
123<screen><userinput>sed '/doxygen/d' -i meson.build</userinput></screen>
124-->
125 <para>
126 Install <application>PulseAudio</application> by running the following
127 commands:
128 </para>
129
130<screen><userinput>mkdir build &amp;&amp;
131cd build &amp;&amp;
132
133meson setup --prefix=/usr \
134 --buildtype=release \
135 -D database=gdbm \
136 -D doxygen=false \
137 -D bluez5=disabled \
138 .. &amp;&amp;
139ninja</userinput></screen>
140
141 <para>
142 To test the results, issue: <command>ninja test</command>. One test
143 fails if the tests are not run as the root user, but this can be ignored.
144 </para>
145
146 <para>
147 Now, as the <systemitem class="username">root</systemitem> user:
148 </para>
149
150<screen role="root"><userinput>ninja install</userinput></screen>
151
152 <!-- http://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SystemWide/ -->
153 <para>Running PulseAudio as a system-wide daemon is possible but not
154 recommended. See <ulink
155 url="https://www.freedesktop.org/wiki/Software/PulseAudio/Documentation/User/SystemWide/"/>
156 for more information.
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 /usr/share/dbus-1/system.d/pulseaudio-system.conf</userinput></screen>
164
165 </sect2>
166 <sect2 role="commands">
167 <title>Command Explanations</title>
168
169 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
170 href="../../xincludes/meson-buildtype-release.xml"/>
171
172 <para>
173 <parameter>-D bluez5=disabled</parameter>: This switch prevents
174 a runtime error if <xref linkend="dbus"/> and <xref linkend="sbc"/>
175 are both installed but <xref linkend="bluez"/> is not installed.
176 Remove this if you have installed all three packages.
177 </para>
178
179 <para>
180 <parameter>-D doxygen=false</parameter>: This allows the package to
181 compile if <xref linkend="doxygen"/> is not installed. Remove this
182 if you have installed this and wish to build the documentation.
183 </para>
184<!--
185 <para>
186 <parameter>- -disable-rpath</parameter>: This switch prevents
187 linker from adding a hardcoded runtime path to the installed
188 programs and libraries.
189 </para>-->
190
191 </sect2>
192 <sect2 role="configuration">
193 <title>Configuring PulseAudio</title>
194
195 <sect3 id="pulseaudio-config">
196 <title>Config Files</title>
197 <para>
198 There are system wide configuration files:
199 <filename>/etc/pulse/daemon.conf</filename>,
200 <filename>/etc/pulse/client.conf</filename>,
201 <filename>/etc/pulse/default.pa</filename>, and user configuration
202 files with the same names in
203 <filename class="directory">~/.config/pulse</filename>. User
204 configuration files take precedence over system wide ones.
205 </para>
206
207 <indexterm zone="pulseaudio pulseaudio-config">
208 <primary sortas="e-AA.config-pulse">~/.config/pulse</primary>
209 </indexterm>
210
211 <indexterm zone="pulseaudio pulseaudio-config">
212 <primary
213 sortas="e-etc-pulse-daemon.conf">/etc/pulse/daemon.conf</primary>
214 </indexterm>
215
216 <indexterm zone="pulseaudio pulseaudio-config">
217 <primary
218 sortas="e-etc-pulse-client.conf">/etc/pulse/client.conf</primary>
219 </indexterm>
220
221 <indexterm zone="pulseaudio pulseaudio-config">
222 <primary
223 sortas="e-etc-pulse-default.pa">/etc/pulse/default.pa</primary>
224 </indexterm>
225 </sect3>
226
227 <sect3><title>Configuration Information</title>
228<!--
229 <para>
230 The default configuration files allow setting up a working installation.
231 However, a reference to Console-Kit needs to be removed.
232 Issue the following command as the
233 <systemitem class="username">root</systemitem> user:
234 </para>
235
236<screen role="root"><userinput>sed -i '/load-module module-console-kit/s/^/#/' /etc/pulse/default.pa</userinput></screen>
237
238 In 13.0 this is protected via .ifexists module-console-kit.so
239-->
240 <para>
241 You may have to configure the audio system. You can start
242 <application>pulseaudio</application> in command line mode using
243 <command>pulseaudio -C</command> and then list various
244 information and change settings. See
245 <command>man pulse-cli-syntax</command>.
246 </para>
247
248 <para>
249 If <application>pulseaudio</application> was working but you no-longer
250 have sound, after checking for hardware issues (speakers or headphones
251 not connected, external amplifier not connected) you may need to fix it.
252 </para>
253
254 <para>
255 One suggestion is to close the application, such as
256 <application>firefox</application> where sound has stopped working, then
257 run: <command>pactl list short sinks</command> followed by:
258 <command>pacmd set-default-sink &lt;sink #&gt;</command> and then
259 restart the application.
260 </para>
261
262 <para>
263 If that does not work, a more drastic approach often works. After closing
264 the application, close pulseaudio, either using <command>pulseaudio
265 --kill</command> or, if that fails, <command>killall -KILL
266 pulseaudio</command> and then <command>rm -rf
267 ~/.config/pulse/*</command> (and perhaps also
268 <command>rm -rf ~/.pulse/*</command> if you have used a very old version
269 of pulse on this machine), then run <command>pulseaudio
270 --verbose</command> to restart it. If the daemon starts, restart the
271 application. See <command>man pulseaudio</command> for more options.
272 </para>
273
274 </sect3>
275 </sect2>
276
277 <sect2 role="content">
278 <title>Contents</title>
279
280 <segmentedlist>
281 <segtitle>Installed Programs</segtitle>
282 <segtitle>Installed Libraries</segtitle>
283 <segtitle>Installed Directories</segtitle>
284
285 <seglistitem>
286 <seg>
287 <!--esdcompat,--> pacat, pacmd, pactl, padsp,
288 pamon (symlink to pacat), paplay (symlink to pacat),
289 parec (symlink to pacat), parecord (symlink to pacat), qpaeq,
290 pasuspender, pax11publish, pulseaudio, and
291 <!-- it looks like the equalizer needs FFTW: qpaeq, -->
292 start-pulseaudio-x11
293 </seg>
294 <seg>
295 libpulse.so,
296 libpulse-mainloop-glib.so,
297 libpulse-simple.so,
298 libpulsecommon-&pulseaudio-major-version;.so,
299 libpulsecore-&pulseaudio-major-version;.so, and
300 libpulsedsp.so
301 </seg>
302 <seg>
303 /etc/pulse,
304 /usr/include/pulse,
305 /usr/lib/cmake/PulseAudio,
306 /usr/lib/{pulseaudio,pulse-&pulseaudio-major-version;},
307 /usr/libexec/pulse, and
308 /usr/share/pulseaudio
309 </seg>
310 </seglistitem>
311 </segmentedlist>
312
313 <variablelist>
314 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
315 <?dbfo list-presentation="list"?>
316 <?dbhtml list-presentation="table"?>
317
318<!--
319 <varlistentry id="esdcompat">
320 <term><command>esdcompat</command></term>
321 <listitem>
322 <para>
323 is the <application>PulseAudio</application> ESD wrapper script.
324 </para>
325 <indexterm zone="pulseaudio esdcompat">
326 <primary sortas="b-esdcompat">esdcompat</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330-->
331
332 <varlistentry id="pacat">
333 <term><command>pacat</command></term>
334 <listitem>
335 <para>
336 plays back or records raw or encoded audio streams on a
337 <application>PulseAudio</application> sound server
338 </para>
339 <indexterm zone="pulseaudio pacat">
340 <primary sortas="b-pacat">pacat</primary>
341 </indexterm>
342 </listitem>
343 </varlistentry>
344
345 <varlistentry id="pacmd">
346 <term><command>pacmd</command></term>
347 <listitem>
348 <para>
349 is a tool used to reconfigure a <application>PulseAudio</application>
350 sound server during runtime
351 </para>
352 <indexterm zone="pulseaudio pacmd">
353 <primary sortas="b-pacmd">pacmd</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry id="pactl">
359 <term><command>pactl</command></term>
360 <listitem>
361 <para>
362 is used to control a running <application>PulseAudio</application>
363 sound server
364 </para>
365 <indexterm zone="pulseaudio pactl">
366 <primary sortas="b-pactl">pactl</primary>
367 </indexterm>
368 </listitem>
369 </varlistentry>
370
371 <varlistentry id="padsp">
372 <term><command>padsp</command></term>
373 <listitem>
374 <para>
375 is the <application>PulseAudio</application> OSS Wrapper
376 </para>
377 <indexterm zone="pulseaudio padsp">
378 <primary sortas="b-padsp">padsp</primary>
379 </indexterm>
380 </listitem>
381 </varlistentry>
382
383 <varlistentry id="pamon">
384 <term><command>pamon</command></term>
385 <listitem>
386 <para>
387 is a symbolic link to <command>pacat</command>
388 </para>
389 <indexterm zone="pulseaudio pamon">
390 <primary sortas="b-pamon">pamon</primary>
391 </indexterm>
392 </listitem>
393 </varlistentry>
394
395 <varlistentry id="paplay">
396 <term><command>paplay</command></term>
397 <listitem>
398 <para>
399 is used to play audio files on a
400 <application>PulseAudio</application> sound server
401 </para>
402 <indexterm zone="pulseaudio paplay">
403 <primary sortas="b-paplay">paplay</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry id="parec">
409 <term><command>parec</command></term>
410 <listitem>
411 <para>
412 is a symbolic link to <command>pacat</command>
413 </para>
414 <indexterm zone="pulseaudio parec">
415 <primary sortas="b-parec">parec</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry id="parecord">
421 <term><command>parecord</command></term>
422 <listitem>
423 <para>
424 is a symbolic link to <command>pacat</command>
425 </para>
426 <indexterm zone="pulseaudio parecord">
427 <primary sortas="b-parecord">parecord</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 <varlistentry id="pasuspender">
433 <term><command>pasuspender</command></term>
434 <listitem>
435 <para>
436 is a tool that can be used to tell a local
437 <application>PulseAudio</application> sound server to temporarily
438 suspend access to the audio devices, which allows other applications
439 to access them directly
440 </para>
441 <indexterm zone="pulseaudio pasuspender">
442 <primary sortas="b-pasuspender">pasuspender</primary>
443 </indexterm>
444 </listitem>
445 </varlistentry>
446
447 <varlistentry id="pax11publish">
448 <term><command>pax11publish</command></term>
449 <listitem>
450 <para>
451 is the <application>PulseAudio</application>
452 X11 Credential Utility
453 </para>
454 <indexterm zone="pulseaudio pax11publish">
455 <primary sortas="b-pax11publish">pax11publish</primary>
456 </indexterm>
457 </listitem>
458 </varlistentry>
459
460 <varlistentry id="pa-info">
461 <term><command>pa-info</command></term>
462 <listitem>
463 <para>
464 is a shell script that prints various information relating to the
465 <application>Pulseaudio</application> server currently in use
466 </para>
467 <indexterm zone="pulseaudio pa-info">
468 <primary sortas="b-pa-info">pa-info</primary>
469 </indexterm>
470 </listitem>
471 </varlistentry>
472
473 <varlistentry id="pulseaudio-prog">
474 <term><command>pulseaudio</command></term>
475 <listitem>
476 <para>
477 is a networked low-latency sound server for Linux
478 </para>
479 <indexterm zone="pulseaudio pulseaudio-prog">
480 <primary sortas="b-pulseaudio">pulseaudio</primary>
481 </indexterm>
482 </listitem>
483 </varlistentry>
484
485<!-- only installed if FFTW is present -->
486 <varlistentry id="qpaeq">
487 <term><command>qpaeq</command></term>
488 <listitem>
489 <para>
490 is an equalizer interface for
491 <application>PulseAudio</application> equalizer sinks
492 (Requires <xref linkend="fftw"/> at build time)
493 </para>
494 <indexterm zone="pulseaudio qpaeq">
495 <primary sortas="b-qpaeq">qpaeq</primary>
496 </indexterm>
497 </listitem>
498 </varlistentry>
499
500<!-- Not found in PA 7.0
501 <varlistentry id="start-pulseaudio-kde">
502 <term><command>start-pulseaudio-kde</command></term>
503 <listitem>
504 <para>
505 Starts <application>PulseAudio</application> and loads
506 module-device-manager to use KDE routing policies.
507 </para>
508 <indexterm zone="pulseaudio start-pulseaudio-kde">
509 <primary sortas="b-start-pulseaudio-kde">start-pulseaudio-kde</primary>
510 </indexterm>
511 </listitem>
512 </varlistentry>
513-->
514 <varlistentry id="start-pulseaudio-x11">
515 <term><command>start-pulseaudio-x11</command></term>
516 <listitem>
517 <para>
518 starts <application>PulseAudio</application> and registers it to
519 the X11 session manager
520 </para>
521 <indexterm zone="pulseaudio start-pulseaudio-x11">
522 <primary sortas="b-start-pulseaudio-x11">start-pulseaudio-x11</primary>
523 </indexterm>
524 </listitem>
525 </varlistentry>
526
527 </variablelist>
528
529 </sect2>
530
531</sect1>
Note: See TracBrowser for help on using the repository browser.