Misc stuff for beta 3
[speexdsp.git] / src / speexenc.1
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.29.
2 .TH SPEEXENC "1" "November 2002" "speexenc version 1.0beta3" "User Commands"
3 .SH NAME
4 speexenc \- manual page for speexenc version 1.0beta3
5 .SH SYNOPSIS
6 .B speexenc
7 [\fIoptions\fR] \fIinput_file output_file\fR
8 .SH DESCRIPTION
9 Encodes input_file using Speex. It can read the WAV or raw files.
10 .SS "input_file can be:"
11 .TP
12 filename.wav
13 wav file
14 .TP
15 filename.*
16 Raw PCM file (any extension other than .wav)
17 .TP
18 -
19 stdin
20 .SS "output_file can be:"
21 .TP
22 filename.spx
23 Speex file
24 .TP
25 -
26 stdout
27 .SH OPTIONS
28 .TP
29 \fB\-n\fR, \fB\-\-narrowband\fR
30 Narrowband (8 kHz) input file
31 .TP
32 \fB\-w\fR, \fB\-\-wideband\fR
33 Wideband (16 kHz) input file
34 .HP
35 \fB\-u\fR, \fB\-\-ultra\-wideband\fR "Ultra-wideband" (32 kHz) input file
36 .TP
37 \fB\-\-quality\fR n
38 Encoding quality (0-10), default 3
39 .TP
40 \fB\-\-bitrate\fR n
41 Encoding bit-rate (use bit-rate n or lower)
42 .TP
43 \fB\-\-vbr\fR
44 Enable variable bit-rate (VBR)
45 .TP
46 \fB\-\-comp\fR n
47 Set encoding complexity (0-10), default 3
48 .TP
49 \fB\-\-nframes\fR n
50 Number of frames per Ogg packet (1-10), default 1
51 .TP
52 \fB\-\-comment\fR
53 Add the given string as an extra comment. This may be
54 used multiple times.
55 .TP
56 \fB\-\-author\fR
57 Author of this track.
58 .TP
59 \fB\-\-title\fR
60 Title for this track.
61 .TP
62 \fB\-h\fR, \fB\-\-help\fR
63 This help
64 .TP
65 \fB\-v\fR, \fB\-\-version\fR
66 Version information
67 .TP
68 \fB\-V\fR
69 Verbose mode (show bit-rate)
70 .SS "Raw input options:"
71 .TP
72 \fB\-\-rate\fR n
73 Sampling rate for raw input
74 .TP
75 \fB\-\-stereo\fR
76 Consider raw input as stereo
77 .TP
78 \fB\-\-le\fR
79 Raw input is little-endian
80 .TP
81 \fB\-\-be\fR
82 Raw input is big-endian
83 .TP
84 \fB\-\-8bit\fR
85 Raw input is 8-bit unsigned
86 .TP
87 \fB\-\-16bit\fR
88 Raw input is 16-bit signed
89 .PP
90 Default raw PCM input is 16-bit, little-endian, mono
91 .PP
92 More information is available from the Speex site: http://www.speex.org
93 .PP
94 Please report bugs to the mailing list `speex-dev@xiph.org'.
95 .SH COPYRIGHT
96 Copyright \(co 2002 Jean-Marc Valin