Imported Upstream version 1.0.28
[platform/upstream/alsa-utils.git] / speaker-test / speaker-test.1
index 6ef0814..add6b21 100644 (file)
 .  fi
 .  PP
 ..
-.TH SPEAKER\-TEST 1 "April 2nd, 2011" speaker-test
+.TH SPEAKER\-TEST 1 "April 2nd, 2011" speaker\-test
 .SH NAME
-speaker\-test \- command-line speaker test tone generator for ALSA 
+speaker\-test \- command\-line speaker test tone generator for ALSA
 .SH SYNOPSIS
 .B speaker\-test [\-options]
 
 .SH DESCRIPTION
 \fBspeaker\-test\fP generates a tone that can be used to test the speakers of a computer.
 
-\fBspeaker-test\fP by default will test the \fIdefault\fP device. If you
+\fBspeaker\-test\fP by default will test the \fIdefault\fP device. If you
 want to test another sound device you will have first to get a list of
 all of the sound cards in your system and the devices associated with
 those cards. Notice that there might be for example, one device for
 analog sound, one for digital sound and one for HDMI sound.
-To get the list of available cards and devices you can run \fBaplay -L\fR.
+To get the list of available cards and devices you can run \fBaplay \-L\fR.
 
 .P \fBaplay\fR's output will be similar to this one:
 
 .nf
-$ aplay -L
+$ aplay \-L
 null
     Discard all samples (playback) or generate zero samples (capture)
 default:CARD=ICH5
@@ -47,8 +47,8 @@ surround40:CARD=ICH5,DEV=0
 
 .P Each of the devices is listed in the beginning of the definition so,
 in the above example, there are four devices listed: null, default, front
-and surround40. So, if you want to test the last device you can 
-run \fBspeaker-test -Dsurround40:ICH5 -c 6\fR. The \fB-c\fR option will
+and surround40. So, if you want to test the last device you can
+run \fBspeaker\-test \-Dsurround40:ICH5 \-c 6\fR. The \fB\-c\fR option will
 indicate that the six audio channels in the device have to be tested.
 
 
@@ -86,7 +86,7 @@ When 0 is given, the periods given by \fB\-P\fP option is used.
 The default value is 0.
 
 .TP
-\fB\-P\fP | \fB\-\-nperiods\fP \fPERIODS\fP
+\fB\-P\fP | \fB\-\-nperiods\fP \fIPERIODS\fP
 Use number of periods.  The default value is 4.
 
 .TP
@@ -106,7 +106,7 @@ Pink noise is perceptually uniform noise -- that is, it sounds like every freque
 You can pass the number from 1 to 3 as a backward compatibility.
 
 .TP
-\fB\-l\fP | \fB\-\-nloops\fP \fBCOUNT\fP
+\fB\-l\fP | \fB\-\-nloops\fP \fICOUNT\fP
 
 Specifies the number of loops.  Zero means to run infinitely.
 
@@ -114,7 +114,7 @@ When \fB\-s\fP option below with a valid channel is given, \fBspeaker\-test\fP w
 always a single-shot without looping.
 
 .TP
-\fB\-s\fP | \fB\-\-speaker\fP \fBCHANNEL\fP
+\fB\-s\fP | \fB\-\-speaker\fP \fICHANNEL\fP
 Do a single-shot speaker test for the given channel.  The channel number starts from 1.
 The channel number corresponds to left, right, rear-left, rear-right, center, LFE,
 side-left, side-right, and so on.
@@ -123,47 +123,60 @@ For example, when 1 is passed, it tests the left channel only once rather than b
 with looping.
 
 .TP
-\fB\-w\fP | \fB\-\-wavfile\fP
+\fB\-w\fP | \fB\-\-wavfile\fP \fIFILE\fP
 Use the given WAV file for the playback instead of pre-defined WAV files.
 
 .TP
-\fB\-W\fP | \fB\-\-wavdir\fP
+\fB\-W\fP | \fB\-\-wavdir\fP \fIDIRECTORY\fP
 Specify the directory containing WAV files for playback.
 The default path is \fI/usr/share/sounds/alsa\fP.
 
+.TP
+\fB\-m\fP | \fB\-\-chmap\fP \fIMAP\fP
+Pass the channel map to override.
+If the playback in a specific channel order or channel positions is
+required, pass the channel position strings to this option.
+
+.TP
+\fB\-X\fP | \fB\-\-force-frequency\fP
+Allow supplied \fIFREQ\fP to be outside the default range of 30-8000Hz. A minimum of 1Hz is still enforced.
 
 .SH USAGE EXAMPLES
 
 Produce stereo sound from one stereo jack:
 .EX
-  speaker-test -Dplug:front -c2
+  speaker\-test \-Dplug:front \-c2
 .EE
 
 Produce 4 speaker sound from two stereo jacks:
 .EX
-  speaker-test -Dplug:surround40 -c4
+  speaker\-test \-Dplug:surround40 \-c4
 .EE
 
 Produce 5.1 speaker sound from three stereo jacks:
 .EX
-  speaker-test -Dplug:surround51 -c6
+  speaker\-test \-Dplug:surround51 \-c6
 .EE
 
 To send a nice low 75Hz tone to the Woofer and then exit without touching any other speakers:
 .EX
-  speaker-test -Dplug:surround51 -c6 -s1 -f75
+  speaker\-test \-Dplug:surround51 \-c6 \-s1 \-f75
 .EE
 
-To do a 2-speaker test using the spdif (coax or optical) output:
+To do a 2\-speaker test using the spdif (coax or optical) output:
 .EX
-  speaker-test -Dplug:spdif -c2
+  speaker\-test \-Dplug:spdif \-c2
 .EE
 
+Play in the order of front\-right and front-left from the front PCM
+.EX
+  speaker\-test \-Dplug:front \-c2 \-mFR,FL
+.EE
 
 .SH SEE ALSO
 .BR aplay(1)
 
 .SH AUTHOR
-The speaker-test program was written by James Courtier-Dutton.
+The speaker\-test program was written by James Courtier-Dutton.
 Pink noise support was added by Nathan Hurst.
 Further extensions by Takashi Iwai.