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

11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since eede1a3 was 3d8d1aa9, checked in by Tim Tassonis <stuff@…>, 3 years ago

Update to alsa-lib-1.2.5 alsa-tools-1.2.5 alsa-utils-1.2.5 and alsa-plugins 1.2.5.

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