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

12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since b748f98 was b748f98, checked in by Bruce Dubbs <bdubbs@…>, 9 months ago

Update to alsa-lib alsa-utils 1.2.10.

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