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 [\-options]
  19
  20 .SH DESCRIPTION
  21 \fBspeaker\-test\fP generates a tone that can be used to test the speakers of a computer.
  22
  23 .SH OPTIONS
  24
  25 .TP
  26 \fB\-c\fP | \fB\-\-channels\fP \fINUM\fP
  27 \fINUM\fP channels in stream
  28
  29 .TP
  30 \fB\-D\fP | \fB\-\-device\fP \fINAME\fP
  31 PCM device name \fINAME\fP
  32
  33 .TP
  34 \fB\-f\fP | \fB\-\-frequency\fP \fIFREQ\fP
  35 sine wave of \fIFREQ\fP Hz
  36
  37 .TP
  38 \fB\-\-help\fP
  39 Print usage help
  40
  41 .TP
  42 \fB\-b\fP | \fB\-\-buffer\fP \fITIME\fP
  43 Use buffer size of \fITIME\fP microseconds.
  44 When 0 is given, use the maximal buffer size.
  45 The default value is 0.
  46
  47 .TP
  48 \fB\-p\fP | \fB\-\-period\fP \fITIME\fP
  49 Use period size of \fITIME\fP microseconds.
  50 When 0 is given, the periods given by \fB\-P\fP option is used.
  51 The default value is 0.
  52
  53 .TP
  54 \fB\-P\fP | \fB\-\-nperiods\fP \fPERIODS\fP
  55 Use number of periods.  The default value is 4.
  56
  57 .TP
  58 \fB\-r\fP | \fB\-\-rate\fP \fIRATE\fP
  59 stream of \fIRATE\fP Hz
  60
  61 .TP
  62 \fB\-t\fP | \fB\-\-test\fP \fBpink\fP|\fBsine\fP|\fBwav\fP
  63 \fB\-t pink\fP means use pink noise (default).
  64
  65 Pink noise is perceptually uniform noise -- that is, it sounds like every frequency at once.  If you can hear any tone it may indicate resonances in your speaker system or room.
  66
  67 \fB\-t sine\fP means to use sine wave.
  68
  69 \fB\-t wav\fP means to play WAV files, either pre-defined files or given via \fB\-w\fP option.
  70
  71 You can pass the number from 1 to 3 as a backward compatibility.
  72
  73 .TP
  74 \fB\-l\fP | \fB\-\-nloops\fP \fBCOUNT\fP
  75
  76 Specifies the number of loops.  Zero means to run infinitely.
  77
  78 When \fB\-s\fP option below with a valid channel is given, \fBspeaker\-test\fP will perform
  79 always a single-shot without looping.
  80
  81 .TP
  82 \fB\-s\fP | \fB\-\-speaker\fP \fBCHANNEL\fP
  83 Do a single-shot speaker test for the given channel.  The channel number starts from 1.
  84 The channel number corresponds to left, right, rear-left, rear-right, center, LFE,
  85 side-left, side-right, and so on.
  86
  87 For example, when 1 is passed, it tests the left channel only once rather than both channels
  88 with looping.
  89
  90 .TP
  91 \fB\-w\fP | \fB\-\-wavfile\fP
  92 Use the given WAV file for the playback instead of pre-defined WAV files.
  93
  94 .TP
  95 \fB\-W\fP | \fB\-\-wavdir\fP
  96 Specify the directory containing WAV files for playback.
  97 The default path is \fI/usr/share/sounds/alsa\fP.
  98
  99
 100 .SH USAGE EXAMPLES
 101
 102 Produce stereo sound from one stereo jack:
 103 .EX
 104   speaker-test -Dplug:front -c2
 105 .EE
 106
 107 Produce 4 speaker sound from two stereo jacks:
 108 .EX
 109   speaker-test -Dplug:surround40 -c4
 110 .EE
 111
 112 Produce 5.1 speaker sound from three stereo jacks:
 113 .EX
 114   speaker-test -Dplug:surround51 -c6
 115 .EE
 116
 117 To send a nice low 75Hz tone to the Woofer and then exit without touching any other speakers:
 118 .EX
 119   speaker-test -Dplug:surround51 -c6 -s1 -f75
 120 .EE
 121
 122 .SH AUTHOR
 123 The speaker-test program was written by James Courtier-Dutton.
 124 Pink noise support was added by Nathan Hurst.
 125 Further extensions by Takashi Iwai.