Gentoo Archives: gentoo-doc-cvs

From: Josh Saddler <nightmorph@××××××××××××.org>
To: gentoo-doc-cvs@l.g.o
Subject: [gentoo-doc-cvs] cvs commit: alsa-guide.xml
Date: Sat, 19 May 2007 03:00:48
Message-Id: E1HpFBF-00029r-HP@stork.gentoo.org
1 nightmorph 07/05/19 03:00:29
2
3 Modified: alsa-guide.xml
4 Log:
5 spacing fixes by pva, bug 177969. no content change.
6
7 Revision Changes Path
8 1.80 xml/htdocs/doc/en/alsa-guide.xml
9
10 file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/alsa-guide.xml?rev=1.80&view=markup
11 plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/alsa-guide.xml?rev=1.80&content-type=text/plain
12 diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/alsa-guide.xml?r1=1.79&r2=1.80
13
14 Index: alsa-guide.xml
15 ===================================================================
16 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/alsa-guide.xml,v
17 retrieving revision 1.79
18 retrieving revision 1.80
19 diff -u -r1.79 -r1.80
20 --- alsa-guide.xml 7 May 2007 07:08:24 -0000 1.79
21 +++ alsa-guide.xml 19 May 2007 03:00:29 -0000 1.80
22 @@ -1,5 +1,5 @@
23 <?xml version='1.0' encoding="UTF-8"?>
24 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/alsa-guide.xml,v 1.79 2007/05/07 07:08:24 nightmorph Exp $ -->
25 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/alsa-guide.xml,v 1.80 2007/05/19 03:00:29 nightmorph Exp $ -->
26
27 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
28
29 @@ -34,18 +34,18 @@
30 <body>
31
32 <p>
33 -ALSA, which stands for <e>Advanced Linux Sound Architecture</e>, provides
34 -audio and MIDI (<e>Musical Instrument Digital Interface</e>) functionality to
35 -the Linux operating system. ALSA is the default sound subsystem in the 2.6
36 -kernel thereby replacing OSS (<e>Open Sound System</e>), which was used in the
37 +ALSA, which stands for <e>Advanced Linux Sound Architecture</e>, provides
38 +audio and MIDI (<e>Musical Instrument Digital Interface</e>) functionality to
39 +the Linux operating system. ALSA is the default sound subsystem in the 2.6
40 +kernel thereby replacing OSS (<e>Open Sound System</e>), which was used in the
41 2.4 kernels.
42 </p>
43
44 <p>
45 -ALSA's main features include efficient support for all types of audio
46 -interfaces ranging from consumer sound cards to professional sound
47 -equipment, fully modularized drivers, SMP and thread safety, backward
48 -compatibility with OSS and a user-space library <c>alsa-lib</c> to make
49 +ALSA's main features include efficient support for all types of audio
50 +interfaces ranging from consumer sound cards to professional sound
51 +equipment, fully modularized drivers, SMP and thread safety, backward
52 +compatibility with OSS and a user-space library <c>alsa-lib</c> to make
53 application development a breeze.
54 </p>
55
56 @@ -56,9 +56,9 @@
57 <body>
58
59 <p>
60 -One of Gentoo's main strengths lies in giving the user maximum control over
61 -how a system is installed/configured. ALSA on Gentoo follows the same
62 -principle. There are two ways you can get ALSA support up and running on your
63 +One of Gentoo's main strengths lies in giving the user maximum control over
64 +how a system is installed/configured. ALSA on Gentoo follows the same
65 +principle. There are two ways you can get ALSA support up and running on your
66 system. We shall look at them in detail in the next chapter.
67 </p>
68
69 @@ -73,7 +73,7 @@
70 <body>
71
72 <warn>
73 -The methods shown below are mutually exclusive. You cannot have ALSA compiled
74 +The methods shown below are mutually exclusive. You cannot have ALSA compiled
75 in your kernel and use <c>media-sound/alsa-driver</c>. It <e>will</e> fail.
76 </warn>
77
78 @@ -99,7 +99,7 @@
79 </p>
80
81 <p>
82 -If you were to use ALSA provided by the kernel, the following are the pros and
83 +If you were to use ALSA provided by the kernel, the following are the pros and
84 cons:
85 </p>
86
87 @@ -174,14 +174,14 @@
88 <body>
89
90 <p>
91 -Whichever method of install you choose, you need to know what drivers your
92 +Whichever method of install you choose, you need to know what drivers your
93 sound card uses. In most cases, sound cards (onboard and otherwise) are PCI
94 -based and <c>lspci</c> will help you in digging out the required information.
95 +based and <c>lspci</c> will help you in digging out the required information.
96 Please <c>emerge sys-apps/pciutils</c> to get <c>lspci</c>, if you don't have it
97 installed already. In case you have a USB sound card, <c>lsusb</c> from
98 <c>sys-apps/usbutils</c> <e>might</e> be of help. For ISA cards, try using
99 <c>sys-apps/isapnptools</c>. Also, the following pages <e>may</e> help users
100 -with ISA based sound cards.
101 +with ISA based sound cards:
102 </p>
103
104 <ul>
105 @@ -217,10 +217,10 @@
106 We now know that the sound card on the machine is a Sound Blaster Live! and the
107 card manufacturer is Creative Labs. Head over to the <uri
108 link="http://bugtrack.alsa-project.org/main/index.php/Matrix:Main">ALSA
109 -Soundcard Matrix</uri> page and select Creative Labs from the drop down menu.
110 -You will be taken to the Creative Labs matrix page where you can see that the SB
111 -Live! uses the <c>emu10k1</c> module. That is the information we need for now.
112 -If you are interested in detailed information, you can click on the link next to
113 +Soundcard Matrix</uri> page and select Creative Labs from the list. You will
114 +be taken to the Creative Labs matrix page where you can see that the SB Live!
115 +uses the <c>emu10k1</c> module. That is the information we need for now. If
116 +you are interested in detailed information, you can click on the link next to
117 the "Details" and that will take you to the <c>emu10k1</c> specific page.
118 </p>
119
120 @@ -272,7 +272,7 @@
121 </p>
122
123 <p>
124 -Please note that for ease of use, all examples show ALSA built as modules. It
125 +Please note that for ease of use, all examples show ALSA built as modules. It
126 is advisable to follow the same as it then allows the use of <c>alsaconf</c>
127 which is a boon when you want to configure your card. Please do <e>not</e> skip
128 the <uri link="#alsa-config">Configuration</uri> section of this document. If
129 @@ -301,10 +301,10 @@
130 &lt;M&gt; OSS PCM (digital audio) API
131
132 <comment>(You now have a choice of devices to enable support for. Generally,
133 -you will have one type of device and not more. If you have more than one
134 +you will have one type of device and not more. If you have more than one
135 sound card, please enable them all here.)</comment>
136
137 -<comment>(Mostly for testing and development purposes, not needed for normal
138 +<comment>(Mostly for testing and development purposes, not needed for normal
139 users unless you know what you are doing.)</comment>
140 Generic devices ---&gt;
141
142 @@ -313,7 +313,7 @@
143 <comment>(IF you had the Gravis, you would select this option)</comment>
144 &lt;M&gt; Gravis UltraSound Extreme
145
146 -<comment>(Move one level back and into PCI devices. Most sound cards today are
147 +<comment>(Move one level back and into PCI devices. Most sound cards today are
148 PCI devices)</comment>
149 PCI devices ---&gt;
150 <comment>(We now select the emu10k1 driver for our card)</comment>
151 @@ -331,7 +331,7 @@
152 Now that your options are set, you can (re)compile the kernel and ALSA support
153 for your card should be functional once you reboot into the new kernel. Don't
154 forget to update your GRUB configuration to use the newly built kernel.
155 -You can now proceed to <uri link="#alsa-utilities">ALSA Utilities</uri> and
156 +You can now proceed to <uri link="#alsa-utilities">ALSA Utilities</uri> and
157 see if everything is working as it should.
158 </p>
159
160 @@ -342,16 +342,16 @@
161 <body>
162
163 <p>
164 -So you've decided to go the <c>alsa-driver</c> way. Let's get started then.
165 -There are a few minor things to be done to ensure only the drivers for your
166 -sound card are compiled. Although this is not really necessary, it cuts down
167 +So you've decided to go the <c>alsa-driver</c> way. Let's get started then.
168 +There are a few minor things to be done to ensure only the drivers for your
169 +sound card are compiled. Although this is not really necessary, it cuts down
170 on the unnecessary drivers that will be compiled otherwise.
171 </p>
172
173 <p>
174 -If you don't have an idea of what drivers your sound card might need, please
175 -take a look at the <uri link="#lspci">lspci</uri> section of this guide. Once
176 -you have your driver name (<c>emu10k1</c> in our example), edit
177 +If you don't have an idea of what drivers your sound card might need, please
178 +take a look at the <uri link="#lspci">lspci</uri> section of this guide. Once
179 +you have your driver name (<c>emu10k1</c> in our example), edit
180 <path>/etc/make.conf</path> and add a variable, <c>ALSA_CARDS</c>.
181 </p>
182
183 @@ -363,8 +363,8 @@
184 </pre>
185
186 <p>
187 -If you have compiled your kernel and want to use <c>alsa-driver</c>, please
188 -ensure the following before proceeding, else <c>alsa-driver</c> is likely to
189 +If you have compiled your kernel and want to use <c>alsa-driver</c>, please
190 +ensure the following before proceeding, else <c>alsa-driver</c> is likely to
191 fail. The next code listing gives you one way of performing the checks.
192 </p>
193
194 @@ -431,8 +431,8 @@
195 <body>
196
197 <p>
198 -<c>alsa-utils</c> forms an integral part of ALSA as it has a truckload of
199 -programs that are highly useful, including the ALSA Initscripts. Hence we
200 +<c>alsa-utils</c> forms an integral part of ALSA as it has a truckload of
201 +programs that are highly useful, including the ALSA Initscripts. Hence we
202 strongly recommend that you install <c>alsa-utils</c>
203 </p>
204
205 @@ -441,10 +441,10 @@
206 </pre>
207
208 <note>
209 -If you activated ALSA in your <uri link="#kernel">kernel</uri> <e>and</e> did
210 -not compile ALSA as modules, please proceed to the
211 -<uri link="#initscript">ALSA Initscript</uri> section. The rest of you need
212 -to configure ALSA. This is made very easy by the existence of the
213 +If you activated ALSA in your <uri link="#kernel">kernel</uri> <e>and</e> did
214 +not compile ALSA as modules, please proceed to the
215 +<uri link="#initscript">ALSA Initscript</uri> section. The rest of you need
216 +to configure ALSA. This is made very easy by the existence of the
217 <c>alsaconf</c> tool provided by <c>alsa-utils</c>.
218 </note>
219
220 @@ -462,13 +462,12 @@
221 </p>
222
223 <note>
224 -Please shut down any programs that <e>might</e> access the sound card while
225 +Please shut down any programs that <e>might</e> access the sound card while
226 running <c>alsaconf</c>.
227 </note>
228
229 <p>
230 -Another way to configure your sound card is to run <c>alsaconf</c>. Just type
231 -<c>alsaconf</c> in a shell as root.
232 +To configure your sound card just type <c>alsaconf</c> in a shell as root.
233 </p>
234
235 <pre caption="Invoking alsaconf">
236 @@ -476,10 +475,10 @@
237 </pre>
238
239 <p>
240 -You will now see a neat menu guided interface that will automatically probe
241 -your devices and try to find out your sound card. You will be asked to pick
242 -your sound card from a list. Once that's done, it will ask you permission to
243 -automatically make required changes to <path>/etc/modules.d/alsa</path>.
244 +You will now see a neat menu guided interface that will automatically probe
245 +your devices and try to find out your sound card. You will be asked to pick
246 +your sound card from a list. Once that's done, it will ask you permission to
247 +automatically make required changes to <path>/etc/modules.d/alsa</path>.
248 It will then adjust your volume settings to optimum levels, run
249 <c>update-modules</c> and start the <path>/etc/init.d/alsasound</path> service.
250 Once <c>alsaconf</c> exits, you can proceed with setting up the ALSA
251 @@ -493,9 +492,9 @@
252 <body>
253
254 <p>
255 -We're now almost all setup. Whichever method you chose to install ALSA, you'll
256 -need to have something load your modules or initialize ALSA and restore your
257 -volume settings when your system comes up. The ALSA Initscript handles all of
258 +We're now almost all setup. Whichever method you chose to install ALSA, you'll
259 +need to have something load your modules or initialize ALSA and restore your
260 +volume settings when your system comes up. The ALSA Initscript handles all of
261 this for you and is called <c>alsasound</c>. Add it to the boot runlevel.
262 </p>
263
264 @@ -506,8 +505,8 @@
265 </pre>
266
267 <p>
268 -Next, just check the <path>/etc/conf.d/alsasound</path> file and ensure that
269 -SAVE_ON_STOP variable is set to yes. This saves your sound settings when you
270 +Next, just check the <path>/etc/conf.d/alsasound</path> file and ensure that
271 +SAVE_ON_STOP variable is set to yes. This saves your sound settings when you
272 shutdown your system.
273 </p>
274
275 @@ -541,17 +540,17 @@
276 <body>
277
278 <p>
279 -We've completed all the setups and prerequisites, so let's fire up ALSA. If
280 -you ran <c>alsaconf</c>, you can skip this step, since <c>alsaconf</c> already
281 +We've completed all the setups and prerequisites, so let's fire up ALSA. If
282 +you ran <c>alsaconf</c>, you can skip this step, since <c>alsaconf</c> already
283 does this for you.
284 </p>
285
286 <pre caption="Start the service">
287 -# <i>/etc/init.d/alsasound start</i>
288 +# <i>/etc/init.d/alsasound start</i>
289 </pre>
290
291 <p>
292 -Now that the required things have been taken care of, we need to check up on
293 +Now that the required things have been taken care of, we need to check up on
294 the volume as in certain cases, it is muted. We use <c>alsamixer</c> for this
295 purpose.
296 </p>
297 @@ -570,9 +569,9 @@
298 </impo>
299
300 <p>
301 -This is how the ALSA Mixer <e>might</e> look the first time you open it. Pay
302 -attention to the Master and PCM channels which both have an MM below them.
303 -That means they are muted. If you try to play anything with <c>alsamixer</c>
304 +This is how the ALSA Mixer <e>might</e> look the first time you open it. Pay
305 +attention to the Master and PCM channels which both have an MM below them.
306 +That means they are muted. If you try to play anything with <c>alsamixer</c>
307 in this state, you will not hear anything on your speakers.
308 </p>
309
310 @@ -589,28 +588,28 @@
311
312 <ul>
313 <li>
314 - To move between channels, use your left and right arrow keys. (&lt;-
315 + To move between channels, use your left and right arrow keys. (&lt;-
316 &amp; -&gt;)
317 </li>
318 <li>
319 - To toggle mute, move to the specific channel, for example Master and press
320 - the <e>m</e> key on the keyboard.
321 + To toggle mute, move to the specific channel, for example Master and press
322 + the <e>m</e> key on the keyboard.
323 </li>
324 <li>
325 - To increase and decrease the volume levels, use the up and down arrow keys
326 + To increase and decrease the volume levels, use the up and down arrow keys
327 respectively.
328 </li>
329 </ul>
330
331 <note>
332 -Be careful when setting your Bass and Treble values. 50 is usually a good
333 -number for both. Extremely high values of Bass may cause <e>jarring</e>
334 +Be careful when setting your Bass and Treble values. 50 is usually a good
335 +number for both. Extremely high values of Bass may cause <e>jarring</e>
336 on speakers that are not designed to handle them.
337 </note>
338
339 <p>
340 -After you're all done, your ALSA Mixer should look similar to the one below.
341 -Note the 00 instead of the MM and also the volume levels for some optimum
342 +After you're all done, your ALSA Mixer should look similar to the one below.
343 +Note the 00 instead of the MM and also the volume levels for some optimum
344 settings.
345 </p>
346
347 @@ -686,20 +685,20 @@
348 <body>
349
350 <p>
351 -If for some reason you're unable to hear sound, the first thing to do would
352 -be to check your <uri link="#doc_chap3_pre6">alsamixer</uri> settings. 80% of
353 -the issues lie with muted channels or low volume. Also check your Window
354 +If for some reason you're unable to hear sound, the first thing to do would
355 +be to check your <uri link="#doc_chap3_pre6">alsamixer</uri> settings. 80% of
356 +the issues lie with muted channels or low volume. Also check your Window
357 Manager's sound applet and verify that volumes are set to audible levels.
358 </p>
359
360 <p>
361 -<path>/proc</path> is your friend. And in this case, <path>/proc/asound</path>
362 -is your best friend. We shall just take a short look at how much info is made
363 +<path>/proc</path> is your friend. And in this case, <path>/proc/asound</path>
364 +is your best friend. We shall just take a short look at how much info is made
365 available to us there.
366 </p>
367
368 <pre caption="Fun with /proc/asound">
369 -<comment>(First and foremost, if /proc/asound/cards shows your card, ALSA has
370 +<comment>(First and foremost, if /proc/asound/cards shows your card, ALSA has
371 picked up your sound card fine.)</comment>
372 # <i>cat /proc/asound/cards</i>
373 0 [Live ]: EMU10K1 - Sound Blaster Live!
374 @@ -844,11 +843,11 @@
375 </p>
376
377 <p>
378 -If your sound card is one of those that come with on-board MIDI synthesizers
379 -and you would like to listen to some .mid files, you have to install
380 -<c>awesfx</c> which is basically a set of utilities for controlling the AWE32
381 -driver. We need to install it first. If you don't have a hardware synthesizer,
382 -you can use a virtual one. Please see the section on
383 +If your sound card is one of those that come with on-board MIDI synthesizers
384 +and you would like to listen to some .mid files, you have to install
385 +<c>awesfx</c> which is basically a set of utilities for controlling the AWE32
386 +driver. We need to install it first. If you don't have a hardware synthesizer,
387 +you can use a virtual one. Please see the section on
388 <uri link="#vsynth">Virtual Synthesizers</uri> for more information.
389 </p>
390
391 @@ -857,21 +856,21 @@
392 </pre>
393
394 <note>
395 -You will need to copy over SoundFont (SF2) files from your sound card's driver
396 -CD or a Windows installation into <path>/usr/share/sounds/sf2/</path>. For
397 +You will need to copy over SoundFont (SF2) files from your sound card's driver
398 +CD or a Windows installation into <path>/usr/share/sounds/sf2/</path>. For
399 example a sound font file for the Creative SBLive! card would be 8MBGMSFX.SF2.
400 </note>
401
402 <p>
403 After copying over the Soundfont files, we can then play a midi file as shown.
404 -You can also add the <c>asfxload</c> command to
405 -<path>/etc/conf.d/local.start</path>, so that the sound font is loaded
406 +You can also add the <c>asfxload</c> command to
407 +<path>/etc/conf.d/local.start</path>, so that the sound font is loaded
408 every time the system starts up.
409 </p>
410
411 <note>
412 -<path>/mnt</path> paths mentioned in the code listing(s) below will <e>not</e>
413 -be the same in your machine. They are just an example. Please be careful to
414 +<path>/mnt</path> paths mentioned in the code listing(s) below will <e>not</e>
415 +be the same in your machine. They are just an example. Please be careful to
416 change the path to suit your machine.
417 </note>
418
419 @@ -885,8 +884,8 @@
420 </pre>
421
422 <p>
423 -You can now play midi files using a program like <c>aplaymidi</c>. Run
424 -<c>aplaymidi -l</c> to get a list of available ports and then pick one
425 +You can now play midi files using a program like <c>aplaymidi</c>. Run
426 +<c>aplaymidi -l</c> to get a list of available ports and then pick one
427 to play the file on.
428 </p>
429
430 @@ -923,7 +922,7 @@
431 install some sound font packages for you. There are a few other font packages
432 available in Portage, such as <c>timidity-freepats</c> and
433 <c>timidity-eawpatches</c>. You can have multiple sound font configurations
434 -installed, and you can place your own in <path>/usr/share/timidity/</path>. To
435 +installed, and you can place your own in <path>/usr/share/timidity/</path>. To
436 switch between different timidity configurations, you should use
437 <c>eselect</c>.
438 </p>
439 @@ -971,7 +970,7 @@
440 <p>
441 You can have more than one sound card in your system simultaneously, provided
442 that you have built ALSA as modules in your kernel (or have installed
443 -<c>alsa-driver</c> instead). You just need to specify which should be started
444 +<c>alsa-driver</c> instead). You just need to specify which should be started
445 first in <path>/etc/modules.d/alsa</path>. Your cards are identified by their
446 driver names inside this file. 0 is the first card, 1 is the second, and so on.
447 Here's an example for a system with two sound cards.
448 @@ -1020,7 +1019,7 @@
449
450 <p>
451 Everyone who contributed to the earlier version of the Gentoo ALSA Guide:
452 -Vincent Verleye, Grant Goodyear, Arcady Genkin, Jeremy Huddleston,
453 +Vincent Verleye, Grant Goodyear, Arcady Genkin, Jeremy Huddleston,
454 John P. Davis, Sven Vermeulen, Benny Chuang, Tiemo Kieft and Erwin.
455 </p>
456
457
458
459
460 --
461 gentoo-doc-cvs@g.o mailing list