source: multimedia/libdriv/alsa-utils.xml@ f6c28f4

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since f6c28f4 was b36aabe, checked in by Tim Tassonis <stuff@…>, 14 months ago

Update to alsa-lib alsa-utils 1.2.9.

  • Property mode set to 100644
File size: 15.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 alsa-utils-download-http "&alsa-download-http;/utils/alsa-utils-&alsa-utils-version;.tar.bz2">
8 <!ENTITY alsa-utils-download-ftp "&alsa-download-ftp;/utils/alsa-utils-&alsa-utils-version;.tar.bz2">
9 <!ENTITY alsa-utils-md5sum "095a31a5924695a7cc5b40f9574ba85e">
10 <!ENTITY alsa-utils-size "1.6 MB">
11 <!ENTITY alsa-utils-buildsize "16 MB">
12 <!ENTITY alsa-utils-time "0.2 SBU">
13]>
14
15<sect1 id="alsa-utils" xreflabel="alsa-utils-&alsa-utils-version;">
16 <?dbhtml filename="alsa-utils.html"?>
17
18
19 <title>alsa-utils-&alsa-utils-version;</title>
20
21 <indexterm zone="alsa-utils">
22 <primary sortas="a-alsa-utils">alsa-utils</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to ALSA Utilities</title>
27
28 <para>
29 The <application>ALSA Utilities</application> package contains
30 various utilities which are useful for controlling your sound
31 card.
32 </para>
33
34 &lfs113_checked;
35
36 <bridgehead renderas="sect3">Package Information</bridgehead>
37 <itemizedlist spacing="compact">
38 <listitem>
39 <para>
40 Download (HTTP): <ulink url="&alsa-utils-download-http;"/>
41 </para>
42 </listitem>
43 <listitem>
44 <para>
45 Download (FTP): <ulink url="&alsa-utils-download-ftp;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download MD5 sum: &alsa-utils-md5sum;
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download size: &alsa-utils-size;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Estimated disk space required: &alsa-utils-buildsize;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated build time: &alsa-utils-time;
66 </para>
67 </listitem>
68 </itemizedlist>
69
70 <bridgehead renderas="sect3">ALSA Utilities Dependencies</bridgehead>
71
72 <bridgehead renderas="sect4">Required</bridgehead>
73 <para role="required">
74 <xref linkend="alsa-lib"/>
75 </para>
76
77 <bridgehead renderas="sect4">Optional</bridgehead>
78 <para role="optional">
79 <xref linkend="docutils"/>,
80 <xref linkend="fftw"/>,
81 <xref linkend="libsamplerate"/>,
82 <xref linkend="xmlto"/>, and
83 <ulink url="https://hightek.org/projects/dialog/">Dialog</ulink>
84 </para>
85
86 <para condition="html" role="usernotes">User Notes:
87 <ulink url="&blfs-wiki;/alsa-utils"/>
88 </para>
89 </sect2>
90
91 <sect2 role="installation">
92 <title>Installation of ALSA Utilities</title>
93
94 <para>
95 Install <application>ALSA Utilities</application> by
96 running the following commands:
97 </para>
98
99<screen><userinput>./configure --disable-alsaconf \
100 --disable-bat \
101 --disable-xmlto \
102 --with-curses=ncursesw &amp;&amp;
103make</userinput></screen>
104
105 <para>
106 This package does not come with a test suite.
107 </para>
108
109 <para>
110 Now, as the <systemitem class="username">root</systemitem> user:
111 </para>
112
113<screen role="root"><userinput>make install</userinput></screen>
114
115 </sect2>
116
117 <sect2 role="commands">
118 <title>Command Explanations</title>
119
120 <para>
121 <parameter>--disable-alsaconf</parameter>: This switch disables building
122 the <command>alsaconf</command> configuration tool which is incompatible
123 with <application>Udev</application>.
124 </para>
125
126 <para>
127 <parameter>--disable-xmlto</parameter>: Omit this switch if you have
128 installed <xref linkend="xmlto"/> and wish to regenerate the man pages.
129 </para>
130
131 <para>
132 <parameter>--disable-bat</parameter>: Omit this switch if you have
133 installed <xref linkend="fftw"/> and wish to
134 install the Basic Audio Tester (BAT).
135 </para>
136
137 <para>
138 <parameter>--with-curses=ncursesw</parameter>: This switch forces the
139 use of wide-character ncurses libraries.
140 </para>
141
142 </sect2>
143
144 <sect2 role="configuration">
145 <title>Configuring ALSA Utilities</title>
146
147 <sect3 id="alsa-utils-config">
148 <title>Config Files</title>
149
150 <para>
151 <filename>/var/lib/alsa/asound.state</filename>
152 </para>
153
154 <indexterm zone="alsa-utils alsa-utils-config">
155 <primary sortas="e-var-lib-alsa-asound.state">/var/lib/alsa/asound.state</primary>
156 </indexterm>
157
158 </sect3>
159
160 <sect3>
161 <title>Configuration Information</title>
162
163 <para>
164 Note that all channels of your sound card are muted by default.
165 You can use the <command>alsamixer</command> program to change
166 this. Use <command>speaker-test</command> to check that your
167 settings have been applied correctly. You should hear
168 <quote>pink noise</quote> on your speakers.
169 </para>
170
171 <para>
172 The <filename>alsactl</filename> program is normally run from a
173 standard <application>udev</application> rule. The first time it
174 is run, it will complain that there is no state in
175 <filename>/var/lib/alsa/asound.state</filename>. You can prevent
176 this by running the following command as the
177 <systemitem class="username">root</systemitem> user:
178 </para>
179
180<screen role="root"><userinput>alsactl -L store</userinput></screen>
181
182 <para>
183 The volume settings should be restored from the saved state by
184 <application>Udev</application> when the device is detected
185 (during boot or when plugged in for USB devices).
186 </para>
187<!-- not needed with elogind or systemd-logind
188 <para>
189 All sound devices are not accessible for any user except
190 <systemitem class="username">root</systemitem> and members of the
191 <systemitem class="groupname">audio</systemitem> group. Add any
192 users that might use the sound devices to that group:
193 </para>
194
195<screen role="root"><userinput>usermod -a -G audio <replaceable>&lt;username&gt;</replaceable></userinput></screen>
196
197 <note>
198 <para>
199 You may need to log out and back in again to refresh your group
200 memberships. '<command>su <replaceable>&lt;username&gt;</replaceable></command>'
201 should work as well.
202 </para>
203 </note>
204-->
205 <para>
206 On systems which have multiple sound cards, you may need to adjust the
207 default audio device so that you can get output from your speakers.
208 To set the default device, first check the
209 <filename>/proc/asound/cards</filename> file to determine which number
210 you need to set. After you know this information, set the default card
211 with the following command as the
212 <systemitem class="username">root</systemitem> user:
213 </para>
214
215<screen role="nodump"><userinput>cat &gt; /etc/asound.conf &lt;&lt; "EOF"
216<literal># Begin /etc/asound.conf
217
218defaults.pcm.card 1
219defaults.ctl.card 1
220
221# End /etc/asound.conf</literal>
222EOF</userinput></screen>
223
224 </sect3>
225
226 <sect3 id="alsa-utils-init" revision="sysv">
227 <title>Boot Script</title>
228
229 <indexterm zone="alsa-utils alsa-utils-init">
230 <primary sortas="f-alsa">alsa</primary>
231 </indexterm>
232
233 <para>
234 To automatically store and restore volume settings (if the udev rule
235 doesn't work for you) when the system is rebooted, install the
236 <filename>/etc/rc.d/init.d/alsa</filename> boot script from the
237 <xref linkend="bootscripts" revision="sysv"/>
238 <xref linkend="systemd-units" revision="systemd"/> package.
239 </para>
240
241<screen role="root"><userinput>make install-alsa</userinput></screen>
242
243 </sect3>
244
245 </sect2>
246
247 <sect2 role="content">
248 <title>Contents</title>
249
250 <segmentedlist>
251 <segtitle>Installed Programs</segtitle>
252 <segtitle>Installed Libraries</segtitle>
253 <segtitle>Installed Directories</segtitle>
254
255 <seglistitem>
256 <seg>
257 aconnect, alsactl, alsaloop, alsamixer, alsatplg,
258 alsaucm, alsa-info.sh, amidi, amixer, aplay, aplaymidi,
259 arecord (symlink), arecordmidi, aseqdump, aseqnet, axfer,
260 iecset, and speaker-test
261 </seg>
262 <seg>
263 None
264 </seg>
265 <seg>
266 /usr/share/sounds/alsa and /var/lib/alsa
267 </seg>
268 </seglistitem>
269 </segmentedlist>
270
271 <variablelist>
272 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
273 <?dbfo list-presentation="list"?>
274 <?dbhtml list-presentation="table"?>
275
276 <varlistentry id="aconnect">
277 <term><command>aconnect</command></term>
278 <listitem>
279 <para>
280 is a utility for connecting and disconnecting two
281 existing ports in the ALSA sequencer system
282 </para>
283 <indexterm zone="alsa-utils aconnect">
284 <primary sortas="b-aconnect">aconnect</primary>
285 </indexterm>
286 </listitem>
287 </varlistentry>
288
289 <varlistentry id="alsactl">
290 <term><command>alsactl</command></term>
291 <listitem>
292 <para>
293 is used to control advanced settings for ALSA sound card drivers.
294 Use this if alsamixer cannot utilize all of your sound card's
295 features
296 </para>
297 <indexterm zone="alsa-utils alsactl">
298 <primary sortas="b-alsactl">alsactl</primary>
299 </indexterm>
300 </listitem>
301 </varlistentry>
302
303 <varlistentry id="alsaloop">
304 <term><command>alsaloop</command></term>
305 <listitem>
306 <para>
307 allows creation of a PCM loopback between a PCM capture
308 device and a PCM playback device
309 </para>
310 <indexterm zone="alsa-utils alsaloop">
311 <primary sortas="b-alsaloop">alsaloop</primary>
312 </indexterm>
313 </listitem>
314 </varlistentry>
315
316 <varlistentry id="alsamixer">
317 <term><command>alsamixer</command></term>
318 <listitem>
319 <para>
320 is an Ncurses based mixer program for use with
321 the ALSA sound card drivers
322 </para>
323 <indexterm zone="alsa-utils alsamixer">
324 <primary sortas="b-alsamixer">alsamixer</primary>
325 </indexterm>
326 </listitem>
327 </varlistentry>
328
329 <varlistentry id="alsatplg">
330 <term><command>alsatplg</command></term>
331 <listitem>
332 <para>
333 is a utility used to compile topology configuration files into
334 binary files for kernel drivers
335 </para>
336 <indexterm zone="alsa-utils alsatplg">
337 <primary sortas="b-alsatplg">alsatplg</primary>
338 </indexterm>
339 </listitem>
340 </varlistentry>
341
342 <varlistentry id="alsaucm">
343 <term><command>alsaucm</command></term>
344 <listitem>
345 <para>
346 allows applications to access the hardware in an abstracted manner
347 </para>
348 <indexterm zone="alsa-utils alsaucm">
349 <primary sortas="b-alsaucm">alsaucm</primary>
350 </indexterm>
351 </listitem>
352 </varlistentry>
353
354 <varlistentry id="amidi">
355 <term><command>amidi</command></term>
356 <listitem>
357 <para>
358 is used to read from and write to ALSA
359 RawMIDI ports
360 </para>
361 <indexterm zone="alsa-utils amidi">
362 <primary sortas="b-amidi">amidi</primary>
363 </indexterm>
364 </listitem>
365 </varlistentry>
366
367 <varlistentry id="amixer">
368 <term><command>amixer</command></term>
369 <listitem>
370 <para>
371 allows command-line control of the mixers for the
372 ALSA sound card drivers
373 </para>
374 <indexterm zone="alsa-utils amixer">
375 <primary sortas="b-amixer">amixer</primary>
376 </indexterm>
377 </listitem>
378 </varlistentry>
379
380 <varlistentry id="aplay">
381 <term><command>aplay</command></term>
382 <listitem>
383 <para>
384 is a command-line soundfile player for the
385 ALSA sound card drivers
386 </para>
387 <indexterm zone="alsa-utils aplay">
388 <primary sortas="b-aplay">aplay</primary>
389 </indexterm>
390 </listitem>
391 </varlistentry>
392
393 <varlistentry id="aplaymidi">
394 <term><command>aplaymidi</command></term>
395 <listitem>
396 <para>
397 is a command-line utility that plays the specified
398 MIDI file(s) to one or more ALSA sequencer ports
399 </para>
400 <indexterm zone="alsa-utils aplaymidi">
401 <primary sortas="b-aplaymidi">aplaymidi</primary>
402 </indexterm>
403 </listitem>
404 </varlistentry>
405
406 <varlistentry id="arecord">
407 <term><command>arecord</command></term>
408 <listitem>
409 <para>
410 is a command-line soundfile recorder for the
411 ALSA sound card drivers
412 </para>
413 <indexterm zone="alsa-utils arecord">
414 <primary sortas="b-arecord">arecord</primary>
415 </indexterm>
416 </listitem>
417 </varlistentry>
418
419 <varlistentry id="arecordmidi">
420 <term><command>arecordmidi</command></term>
421 <listitem>
422 <para>
423 is a command-line utility that records a standard
424 MIDI file from one or more ALSA sequencer ports
425 </para>
426 <indexterm zone="alsa-utils arecordmidi">
427 <primary sortas="b-arecordmidi">arecordmidi</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 <varlistentry id="aseqdump">
433 <term><command>aseqdump</command></term>
434 <listitem>
435 <para>
436 is a command-line utility that prints the sequencer events it
437 receives as text
438 </para>
439 <indexterm zone="alsa-utils aseqdump">
440 <primary sortas="b-aseqdump">aseqdump</primary>
441 </indexterm>
442 </listitem>
443 </varlistentry>
444
445 <varlistentry id="aseqnet">
446 <term><command>aseqnet</command></term>
447 <listitem>
448 <para>
449 is an ALSA sequencer client which sends and
450 receives event packets over a network
451 </para>
452 <indexterm zone="alsa-utils aseqnet">
453 <primary sortas="b-aseqnet">aseqnet</primary>
454 </indexterm>
455 </listitem>
456 </varlistentry>
457
458 <varlistentry id="axfer">
459 <term><command>axfer</command></term>
460 <listitem>
461 <para>
462 is a command-line recorder and player used to transfer audio frames
463 between sound devices and files
464 </para>
465 <indexterm zone="alsa-utils axfer">
466 <primary sortas="b-axfer">axfer</primary>
467 </indexterm>
468 </listitem>
469 </varlistentry>
470
471 <varlistentry id="iecset">
472 <term><command>iecset</command></term>
473 <listitem>
474 <para>
475 is a small utility to set or dump the IEC958 (or so-called
476 <quote>S/PDIF</quote>) status bits of the specified sound
477 card via the ALSA control API
478 </para>
479 <indexterm zone="alsa-utils iecset">
480 <primary sortas="b-iecset">iecset</primary>
481 </indexterm>
482 </listitem>
483 </varlistentry>
484
485 <varlistentry id="speaker-test">
486 <term><command>speaker-test</command></term>
487 <listitem>
488 <para>
489 is a command-line speaker test tone generator for ALSA
490 </para>
491 <indexterm zone="alsa-utils speaker-test">
492 <primary sortas="b-speaker-test">speaker-test</primary>
493 </indexterm>
494 </listitem>
495 </varlistentry>
496
497 </variablelist>
498
499 </sect2>
500
501</sect1>
Note: See TracBrowser for help on using the repository browser.