source: multimedia/libdriv/alsa-utils.xml@ 54aaa89

systemd-13485
Last change on this file since 54aaa89 was 54aaa89, checked in by Douglas R. Reno <renodr@…>, 8 years ago

Sync to trunk r17213
Added entity for GNOME-3.20

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@17328 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 12.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 "f8d00ad5fba757b4c3735d066cc288e2">
10 <!ENTITY alsa-utils-size "1.1 MB">
11 <!ENTITY alsa-utils-buildsize "9.4 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 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>alsa-utils-&alsa-utils-version;</title>
24
25 <indexterm zone="alsa-utils">
26 <primary sortas="a-alsa-utils">alsa-utils</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to ALSA Utilities</title>
31
32 <para>
33 The <application>ALSA Utilities</application> package contains
34 various utilities which are useful for controlling your sound
35 card.
36 </para>
37
38 &lfs78_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&alsa-utils-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&alsa-utils-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &alsa-utils-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &alsa-utils-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &alsa-utils-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &alsa-utils-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73
74 <bridgehead renderas="sect3">ALSA Utilities Dependencies</bridgehead>
75
76 <bridgehead renderas="sect4">Required</bridgehead>
77 <para role="required">
78 <xref linkend="alsa-lib"/>
79 </para>
80
81 <bridgehead renderas="sect4">Optional</bridgehead>
82 <para role="optional">
83 <xref linkend="libsamplerate"/>,
84 <xref linkend="xmlto"/>,
85 <ulink url="http://hightek.org/dialog/">Dialog</ulink>, and
86 <ulink url="http://www.fftw.org/">FFTW</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 <option>--disable-alsaconf</option>: This switch disables building the
125 <command>alsaconf</command> configuration tool which is incompatible with
126 <application>Udev</application>.
127 </para>
128
129 <para>
130 <option>--disable-xmlto</option>: Omit this switch if you have installed
131 <xref linkend="xmlto"/> and want to regenerate the man pages.
132 </para>
133
134 <para>
135 <option>--disable-bat</option>: Omit this switch if you have installed
136 <ulink url="http://www.fftw.org/">FFTW</ulink> and wish to install
137 the Basic Audio Tester (BAT).
138 </para>
139
140 <para>
141 <option>--with-curses=ncursesw</option>: This switch forces the use of
142 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 commands 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 </sect2>
211
212 <sect2 role="content">
213 <title>Contents</title>
214
215 <segmentedlist>
216 <segtitle>Installed Programs</segtitle>
217 <segtitle>Installed Libraries</segtitle>
218 <segtitle>Installed Directories</segtitle>
219
220 <seglistitem>
221 <seg>
222 aconnect, alsaloop, alsamixer, alsatplg,
223 alsaucm, amidi, amixer, aplay, aplaymidi, arecord (symlink),
224 arecordmidi, aseqdump, iaseqnet, iecset, and speaker-test
225 </seg>
226 <seg>
227 None
228 </seg>
229 <seg>
230 /usr/share/sounds/alsa and /var/lib/alsa
231 </seg>
232 </seglistitem>
233 </segmentedlist>
234
235 <variablelist>
236 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
237 <?dbfo list-presentation="list"?>
238 <?dbhtml list-presentation="table"?>
239
240 <varlistentry id="aconnect">
241 <term><command>aconnect</command></term>
242 <listitem>
243 <para>
244 is a utility for connecting and disconnecting two
245 existing ports in the ALSA sequencer system.
246 </para>
247 <indexterm zone="alsa-utils aconnect">
248 <primary sortas="b-aconnect">aconnect</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="alsaloop">
254 <term><command>alsaloop</command></term>
255 <listitem>
256 <para>
257 allows creation of a PCM loopback between a PCM capture
258 device and a PCM playback device.
259 </para>
260 <indexterm zone="alsa-utils alsaloop">
261 <primary sortas="b-alsaloop">alsaloop</primary>
262 </indexterm>
263 </listitem>
264 </varlistentry>
265
266 <varlistentry id="alsamixer">
267 <term><command>alsamixer</command></term>
268 <listitem>
269 <para>
270 is an Ncurses based mixer program for use with
271 the ALSA sound card drivers.
272 </para>
273 <indexterm zone="alsa-utils alsamixer">
274 <primary sortas="b-alsamixer">alsamixer</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278
279 <varlistentry id="alsaucm">
280 <term><command>alsaucm</command></term>
281 <listitem>
282 <para>
283 allows applications to access the hardware in an abstracted manner
284 </para>
285 <indexterm zone="alsa-utils alsaucm">
286 <primary sortas="b-alsaucm">alsaucm</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="amidi">
292 <term><command>amidi</command></term>
293 <listitem>
294 <para>
295 is used to read from and write to ALSA
296 RawMIDI ports.
297 </para>
298 <indexterm zone="alsa-utils amidi">
299 <primary sortas="b-amidi">amidi</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="amixer">
305 <term><command>amixer</command></term>
306 <listitem>
307 <para> allows command-line control of the mixers for the
308 ALSA sound card drivers.</para>
309 <indexterm zone="alsa-utils amixer">
310 <primary sortas="b-amixer">amixer</primary>
311 </indexterm>
312 </listitem>
313 </varlistentry>
314
315 <varlistentry id="aplay">
316 <term><command>aplay</command></term>
317 <listitem>
318 <para>
319 is a command-line soundfile player for the
320 ALSA sound card drivers.
321 </para>
322 <indexterm zone="alsa-utils aplay">
323 <primary sortas="b-aplay">aplay</primary>
324 </indexterm>
325 </listitem>
326 </varlistentry>
327
328 <varlistentry id="aplaymidi">
329 <term><command>aplaymidi</command></term>
330 <listitem>
331 <para>
332 is a command-line utility that plays the specified
333 MIDI file(s) to one or more ALSA sequencer ports.
334 </para>
335 <indexterm zone="alsa-utils aplaymidi">
336 <primary sortas="b-aplaymidi">aplaymidi</primary>
337 </indexterm>
338 </listitem>
339 </varlistentry>
340
341 <varlistentry id="arecord">
342 <term><command>arecord</command></term>
343 <listitem>
344 <para>
345 is a command-line soundfile recorder for the
346 ALSA sound card drivers.
347 </para>
348 <indexterm zone="alsa-utils arecord">
349 <primary sortas="b-arecord">arecord</primary>
350 </indexterm>
351 </listitem>
352 </varlistentry>
353
354 <varlistentry id="arecordmidi">
355 <term><command>arecordmidi</command></term>
356 <listitem>
357 <para>
358 is a command-line utility that records a standard
359 MIDI file from one or more ALSA sequencer ports.
360 </para>
361 <indexterm zone="alsa-utils arecordmidi">
362 <primary sortas="b-arecordmidi">arecordmidi</primary>
363 </indexterm>
364 </listitem>
365 </varlistentry>
366
367 <varlistentry id="aseqdump">
368 <term><command>aseqdump</command></term>
369 <listitem>
370 <para>
371 is a command-line utility that prints the sequencer events it
372 receives as text.
373 </para>
374 <indexterm zone="alsa-utils aseqdump">
375 <primary sortas="b-aseqdump">aseqdump</primary>
376 </indexterm>
377 </listitem>
378 </varlistentry>
379
380 <varlistentry id="aseqnet">
381 <term><command>aseqnet</command></term>
382 <listitem>
383 <para>
384 is an ALSA sequencer client which sends and
385 receives event packets over a network.
386 </para>
387 <indexterm zone="alsa-utils aseqnet">
388 <primary sortas="b-aseqnet">aseqnet</primary>
389 </indexterm>
390 </listitem>
391 </varlistentry>
392
393 <varlistentry id="iecset">
394 <term><command>iecset</command></term>
395 <listitem>
396 <para>
397 is a small utility to set or dump the IEC958 (or so-called
398 <quote>S/PDIF</quote>) status bits of the specified sound
399 card via the ALSA control API.
400 </para>
401 <indexterm zone="alsa-utils iecset">
402 <primary sortas="b-iecset">iecset</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="speaker-test">
408 <term><command>speaker-test</command></term>
409 <listitem>
410 <para>
411 is a command-line speaker test tone generator for ALSA.
412 </para>
413 <indexterm zone="alsa-utils speaker-test">
414 <primary sortas="b-speaker-test">speaker-test</primary>
415 </indexterm>
416 </listitem>
417 </varlistentry>
418
419 </variablelist>
420
421 </sect2>
422
423</sect1>
Note: See TracBrowser for help on using the repository browser.