OSDN Git Service

adopt readme changes in manpage
[android-x86/external-alsa-utils.git] / speaker-test / speaker-test.1
1 .\" -*- nroff -*-
2 .\" macros
3 .de EX \" Begin Example
4 .  IP
5 .  ft CW
6 .  nf
7 .  ne \\$1
8 ..
9 .de EE \" End Example
10 .  ft P
11 .  fi
12 .  PP
13 ..
14 .TH SPEAKER\-TEST 1 "20 September 2004" speaker-test
15 .SH NAME
16 speaker\-test \- command-line speaker test tone generator for ALSA 
17 .SH SYNOPSIS
18 .B speaker\-test
19 .BR "" [ \-D | \-\-device 
20 .IR FILE ]
21 .BR "" [ \-r | \-\-rate
22 .IR RATE ]
23 .BR "" [ \-c | \-\-channels
24 .IR NUM ]
25 .BR "" [ \-f | \-\-frequency
26 .IR FREQ ]
27 .BR "" [ \-p | \-\-period
28 .IR TIME ]
29 .BR "" [ \-s | \-\-speaker " " "1|2" ]
30 .P
31 .B speaker\-test
32 .B \-\-help
33
34 .SH DESCRIPTION
35 \fBspeaker\-test\fP generates a tone that can be used to test the speakers of a computer.
36
37 .SH OPTIONS
38
39 .TP
40 \fB\-c\fP | \fB\-\-channels\fP \fINUM\fP
41 \fINUM\fP channels in stream
42
43 .TP
44 \fB\-D\fP | \fB\-\-device\fP \fINAME\fP
45 PCM device name \fINAME\fP
46
47 .TP
48 \fB\-f\fP | \fB\-\-frequency\fP \fIFREQ\fP
49 sine wave of \fIFREQ\fP Hz
50
51 .TP
52 \fB\-\-help\fP
53 Print usage help
54
55 .TP
56 \fB\-p\fP | \fB\-\-period\fP \fITIME\fP
57 period size of \fITIME\fP microseconds
58
59 .TP
60 \fB\-r\fP | \fB\-\-rate\fP \fIRATE\fP
61 stream of \fIRATE\fP Hz
62
63 .TP
64 \fB\-s\fP | \fB\-\-speaker\fP \fB1\fP|\fB2\fP
65 Test speaker 1 or speaker 2 only, rather than both
66
67 .SH USAGE EXAMPLES
68
69 Produce stereo sound from one stereo jack:
70 .EX
71   speaker-test -Dplug:front -c2
72 .EE
73
74 Produce 4 speaker sound from two stereo jacks:
75 .EX
76   speaker-test -Dplug:surround40 -c4
77 .EE
78
79 Produce 5.1 speaker sound from three stereo jacks:
80 .EX
81   speaker-test -Dplug:surround51 -c6
82 .EE
83
84 To send a nice low 75Hz tone to the Woofer and then exit without touching any other speakers:
85 .EX
86   speaker-test -Dplug:surround51 -c6 -s1 -f75
87 .EE
88
89 .SH AUTHOR
90 The speaker-test program was written by James Courtier-Dutton.