Man page from help2man...
[speexdsp.git] / src / speexenc.1
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.29.
2 .TH SPEEX "1" "September 2002" "Speex encoder version 1.0beta1 (compiled Sep 15 2002)" "User Commands"
3 .SH NAME
4 Speex \- manual page for Speex encoder version 1.0beta1 (compiled Sep 15 2002)
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 .TP
35 \fB\-\-quality\fR n
36 Encoding quality (0-10), default 3
37 .TP
38 \fB\-\-lbr\fR
39 Low bit-rate mode (equivalent to \fB\-\-quality\fR 3)
40 .TP
41 \fB\-\-vbr\fR
42 Enable variable bit-rate (VBR)
43 .TP
44 \fB\-\-comp\fR n
45 Set encoding complexity (0-10), default 3
46 .TP
47 \fB\-\-nframes\fR n
48 Number of frames per Ogg packet (1-10), default 1
49 .TP
50 \fB\-\-comment\fR
51 Add the given string as an extra comment. This may be
52 used multiple times.
53 .TP
54 \fB\-\-author\fR
55 Author of this track.
56 .TP
57 \fB\-\-title\fR
58 Title for this track.
59 .TP
60 \fB\-h\fR, \fB\-\-help\fR
61 This help
62 .TP
63 \fB\-v\fR, \fB\-\-version\fR
64 Version information
65 .TP
66 \fB\-V\fR
67 Verbose mode (show bit-rate)
68 .SS "Raw input options:"
69 .TP
70 \fB\-\-le\fR
71 Raw input is little-endian
72 .TP
73 \fB\-\-be\fR
74 Raw input is big-endian
75 .TP
76 \fB\-\-8bit\fR
77 Raw input is 8-bit unsigned
78 .TP
79 \fB\-\-16bit\fR
80 Raw input is 16-bit signed
81 .PP
82 Default Raw PCM input is 16-bit, little-endian, mono