Preparing for rc2
[speexdsp.git] / src / speexenc.1
index 14eb2dc..5e4dce5 100644 (file)
@@ -1,7 +1,7 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.29.
-.TH SPEEX "1" "September 2002" "Speex encoder version 1.0beta1 (compiled Sep 15 2002)" "User Commands"
+.TH SPEEXENC "1" "December 2002" "speexenc version 1.0rc2" "User Commands"
 .SH NAME
-Speex \- manual page for Speex encoder version 1.0beta1 (compiled Sep 15 2002)
+speexenc \- manual page for speexenc version 1.0rc2
 .SH SYNOPSIS
 .B speexenc
 [\fIoptions\fR] \fIinput_file output_file\fR
@@ -13,7 +13,7 @@ filename.wav
 wav file
 .TP
 filename.*
-raw PCM file (any extension other than .wav)
+Raw PCM file (any extension other than .wav)
 .TP
 -
 stdin
@@ -31,16 +31,27 @@ Narrowband (8 kHz) input file
 .TP
 \fB\-w\fR, \fB\-\-wideband\fR
 Wideband (16 kHz) input file
+.HP
+\fB\-u\fR, \fB\-\-ultra\-wideband\fR "Ultra-wideband" (32 kHz) input file
 .TP
 \fB\-\-quality\fR n
 Encoding quality (0-10), default 3
 .TP
-\fB\-\-lbr\fR
-Low bit-rate mode (equivalent to \fB\-\-quality\fR 3)
+\fB\-\-bitrate\fR n
+Encoding bit-rate (use bit-rate n or lower)
 .TP
 \fB\-\-vbr\fR
 Enable variable bit-rate (VBR)
 .TP
+\fB\-\-abr\fR rate
+Enable average bit-rate (ABR) at rate bps
+.TP
+\fB\-\-vad\fR
+Enable voice activity detection (VAD)
+.TP
+\fB\-\-dtx\fR
+Enable file-based discontinuous transmission (DTX)
+.TP
 \fB\-\-comp\fR n
 Set encoding complexity (0-10), default 3
 .TP
@@ -67,6 +78,12 @@ Version information
 Verbose mode (show bit-rate)
 .SS "Raw input options:"
 .TP
+\fB\-\-rate\fR n
+Sampling rate for raw input
+.TP
+\fB\-\-stereo\fR
+Consider raw input as stereo
+.TP
 \fB\-\-le\fR
 Raw input is little-endian
 .TP
@@ -79,4 +96,10 @@ Raw input is 8-bit unsigned
 \fB\-\-16bit\fR
 Raw input is 16-bit signed
 .PP
-Default Raw PCM input is 16-bit, little-endian, mono
+Default raw PCM input is 16-bit, little-endian, mono
+.PP
+More information is available from the Speex site: http://www.speex.org
+.PP
+Please report bugs to the mailing list `speex-dev@xiph.org'.
+.SH COPYRIGHT
+Copyright \(co 2002 Jean-Marc Valin