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

12.0 12.1 12.2 gimp3 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/for-12.3 xry111/llvm18 xry111/spidermonkey128 xry111/xf86-video-removal
Last change on this file since d8e1be0 was d8e1be0, checked in by Xi Ruoyao <xry111@…>, 15 months ago

multimedia: Remove non-exist User Notes link

Part of User Notes removal by
https://www.linuxfromscratch.org/~xry111/remove-nonexist-usernote.sh

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