.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH TONEGEN 1 "Feb 18, 2007" "VPB driver package" "Voicetronix Telephony Tools"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
tonegen \- Test the Voicetronix programmable tone generator
.SH SYNOPSIS
.B tonegen
.RI [ options ]
.SH DESCRIPTION
The \fBtonegen\fP utility uses the programmable tone generator to send tones to
some port.

.SH OPTIONS
The following options are available:
.TP
.BR \-\-card " number"
Explicitly select the card to test.  Default is card 0.
.TP
.BR \-\-port " number"
Explicitly select the port to test. Default is port 0 of the card being tested.
.TP
.BR \-\-toneid " num"
Play a locale specific predefined tone, where 0 <= num < VPB_TONE_ID_MAX.
The locale is decided according to the value of the \fBVPB_COUNTRY\fP
environment variable.
.TP
.BR \-\-tone " n freq mag"
Set a single component for a user defined tone.  This option may be used more
than once with different values of n to set the components of a multi-frequency
tone.  Legal values for the other parameters are 0 < freq <= 4000 (Hz), and
-inf < mag < 0.0 (dB).
.TP
.BR \-\-ontime " ms"
The number of milliseconds that a user defined tone should be on for.
.TP
.BR \-\-offtime " ms"
The number of milliseconds that a user defined tone should be off for.
.TP
.BR \-\-dial " digits"
Generates a dial string using the specified dtmf digits.
.TP
.B \-\-sync
Play tones using the synchronous api functions.  The default is to use the
async api.
.TP
.B \-\-loop
Loop cadenced tones continuously.  Has no effect if a continuous tone has been
specified.
.TP
.BR \-\-recgain " db"
Set software record gain in dB.  Default is 0.0
.TP
.BR \-\-rec " file"
Record audio to a file while playing.
.TP
.B \-\-contest
Do not wait for a tone to complete before starting the next one.  This can be
useful for stress testing the coherency of the tone generator.
.TP
.B \-\-help, \-?
Show summary of these options.

.SH AUTHOR
Ron Lee,
Voicetronix <support@voicetronix.com.au>
.PP
This manual page was written by Ron <ron@debian.org>,
for the Debian project (but may be used by others).