source: multimedia/libdriv/alsa-utils.xml@ 6f994f1

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 6f994f1 was cc550bc, checked in by Xi Ruoyao <xry111@…>, 12 months ago

firmware: Add Sound Open Firmware

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