source: multimedia/libdriv/alsa-utils.xml

trunk
Last change on this file was 1241ea19, checked in by Bruce Dubbs <bdubbs@…>, 2 months ago

Tag xfce and dependencies

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