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

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 e1e58be was e1e58be, checked in by Pierre Labastie <pierre.labastie@…>, 8 months ago

Remove all ftp urls

neither firefox nor epiphany can download them, and they are not
well maintained, because rarely tested.
This is WIP because the "(HTTP)" part of "Download (HTTP)" will
need to be removed too.
But let's see what users think first...

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