.\"                                      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 TONETRAIN 1 "Feb 2, 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
tonetrain \- Analyse telephony signal tones for the libvpb programmable detector
.SH SYNOPSIS
.B tonetrain
.RI [ options ] " file"
.SH DESCRIPTION
The \fBtonetrain\fP utility analyses a recorded signal from \fIfile\fP to
determine the best tone detector parameters for recognising it.

.SH OPTIONS
The following options are available:
.TP
.B \-V
Be more verbose during execution.

.SS Input options
.TP
.B \-w
Use wav file format for input.  This is the default.
.TP
.B \-v
Use vox file format for input.
.TP
.BR \-s " sec"
Skip the first \fIsec\fP seconds of the recording.  Useful if the tone does
not begin cleanly at the start of the recording.
.TP
.BR \-t " sec"
Train using \fIsec\fP seconds of the recording.  Useful if only a portion
of the recording actually contains the desired to to train for.

.SS Output options
.TP
.B \-p
Output the results in plain english.  This is the default.
.TP
.B \-e
Output the results in a form suitable for use with the VPB_TONE enviroment
variable for libvpb.
.TP
.B \-c
Output the results as a C source code snippet.


.SH SEE ALSO
.BR tonedebug (1)
.SH AUTHOR
Ron Lee,
Ben Kramer,
David Rowe,
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).