Man page from help2man...
authorjmvalin <jmvalin@0101bb08-14d6-0310-b084-bc0e0c8e3800>
Mon, 16 Sep 2002 00:55:32 +0000 (00:55 +0000)
committerjmvalin <jmvalin@0101bb08-14d6-0310-b084-bc0e0c8e3800>
Mon, 16 Sep 2002 00:55:32 +0000 (00:55 +0000)
git-svn-id: http://svn.xiph.org/trunk/speex@3912 0101bb08-14d6-0310-b084-bc0e0c8e3800

src/speexdec.1 [new file with mode: 0644]
src/speexdec.c
src/speexenc.1 [new file with mode: 0644]
src/speexenc.c

diff --git a/src/speexdec.1 b/src/speexdec.1
new file mode 100644 (file)
index 0000000..2c4559d
--- /dev/null
@@ -0,0 +1,60 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.29.
+.TH SPEEX "1" "September 2002" "Speex decoder version 1.0beta1 (compiled Sep 15 2002)" "User Commands"
+.SH NAME
+Speex \- manual page for Speex decoder version 1.0beta1 (compiled Sep 15 2002)
+.SH SYNOPSIS
+.B speexdec
+[\fIoptions\fR] \fIinput_file.spx\fR
+.br
+.B speexdec
+[\fIoptions\fR] \fIinput_file.spx output_file.wav\fR
+.SH DESCRIPTION
+Decodes a Speex file and produce a WAV file or raw file
+.SS "input_file can be:"
+.TP
+filename.spx
+regular Speex file
+.TP
+-
+stdin
+.SS "output_file can be:"
+.TP
+filename.wav
+wav file
+.TP
+filename.*
+raw PCM file (any extension other that .wav)
+.TP
+-
+stdout
+.TP
+(nothing)
+will be played to soundcard
+.SH OPTIONS
+.TP
+\fB\-\-enh\fR
+Enable perceptual enhancement
+.TP
+\fB\-\-no\-enh\fR
+Disable perceptual enhancement (default FOR NOW)
+.TP
+\fB\-\-force\-nb\fR
+Force decoding in narrowband, even for wideband
+.TP
+\fB\-\-force\-wb\fR
+Force decoding in wideband, even for narrowband
+.TP
+\fB\-V\fR
+Verbose mode (show bit-rate)
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+This help
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Version information
+.TP
+\fB\-\-pf\fR
+Deprecated, use \fB\-\-pf\fR instead
+.TP
+\fB\-\-no\-pf\fR
+Deprecated, use \fB\-\-no\-pf\fR instead
index 9dd76cb..d9bb7e0 100644 (file)
@@ -155,36 +155,38 @@ FILE *out_file_open(char *outFile, int rate)
 
 void usage()
 {
-   fprintf (stderr, "Speex decoder version " VERSION " (compiled " __DATE__ ")\n");
-   fprintf (stderr, "\n");
-   fprintf (stderr, "usage: speexdec [options] input_file.spx\n");
-   fprintf (stderr, "       speexdec [options] input_file.spx output_file.wav\n");
-   fprintf (stderr, "\n");
-   fprintf (stderr, "input_file can be:\n");
-   fprintf (stderr, "  filename.spx          regular Speex file\n");
-   fprintf (stderr, "  -                     stdin\n");
-   fprintf (stderr, "\n");  
-   fprintf (stderr, "output_file can be:\n");
-   fprintf (stderr, "  filename.wav          wav file\n");
-   fprintf (stderr, "  filename.*            raw PCM file (any extension other that .wav)\n");
-   fprintf (stderr, "  -                     stdout\n");
-   fprintf (stderr, "  (nothing)             will be played to soundcard\n");
-   fprintf (stderr, "\n");  
-   fprintf (stderr, "options:\n");
-   fprintf (stderr, "  --enh                 Enable perceptual enhancement\n");
-   fprintf (stderr, "  --no-enh              Disable perceptual enhancement (default FOR NOW)\n");
-   fprintf (stderr, "  --force-nb            Force decoding in narrowband, even for wideband\n");
-   fprintf (stderr, "  --force-wb            Force decoding in wideband, even for narrowband\n");
-   fprintf (stderr, "  -V                    Verbose mode (show bit-rate)\n"); 
-   fprintf (stderr, "  --help       -h       This help\n");
-   fprintf (stderr, "  --version    -v       Version information\n");
-   fprintf (stderr, "  --pf                  Deprecated, use --pf instead\n");
-   fprintf (stderr, "  --no-pf               Deprecated, use --no-pf instead\n");
+   /*printf ("Speex decoder version " VERSION " (compiled " __DATE__ ")\n");
+   printf ("\n");*/
+   printf ("Usage: speexdec [options] input_file.spx\n");
+   printf ("       speexdec [options] input_file.spx output_file.wav\n");
+   printf ("\n");
+   printf ("Decodes a Speex file and produce a WAV file or raw file\n");
+   printf ("\n");
+   printf ("input_file can be:\n");
+   printf ("  filename.spx          regular Speex file\n");
+   printf ("  -                     stdin\n");
+   printf ("\n");  
+   printf ("output_file can be:\n");
+   printf ("  filename.wav          wav file\n");
+   printf ("  filename.*            raw PCM file (any extension other that .wav)\n");
+   printf ("  -                     stdout\n");
+   printf ("  (nothing)             will be played to soundcard\n");
+   printf ("\n");  
+   printf ("Options:\n");
+   printf (" --enh                 Enable perceptual enhancement\n");
+   printf (" --no-enh              Disable perceptual enhancement (default FOR NOW)\n");
+   printf (" --force-nb            Force decoding in narrowband, even for wideband\n");
+   printf (" --force-wb            Force decoding in wideband, even for narrowband\n");
+   printf (" -V                    Verbose mode (show bit-rate)\n"); 
+   printf (" -h, --help            This help\n");
+   printf (" -v, --version         Version information\n");
+   printf (" --pf                  Deprecated, use --pf instead\n");
+   printf (" --no-pf               Deprecated, use --no-pf instead\n");
 }
 
 void version()
 {
-   fprintf (stderr, "Speex decoder version " VERSION " (compiled " __DATE__ ")\n");
+   printf ("Speex decoder version " VERSION " (compiled " __DATE__ ")\n");
 }
 
 static void *process_header(ogg_packet *op, int enh_enabled, int *frame_size, int *rate, int *nframes, int forceMode)
diff --git a/src/speexenc.1 b/src/speexenc.1
new file mode 100644 (file)
index 0000000..14eb2dc
--- /dev/null
@@ -0,0 +1,82 @@
+.\" 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"
+.SH NAME
+Speex \- manual page for Speex encoder version 1.0beta1 (compiled Sep 15 2002)
+.SH SYNOPSIS
+.B speexenc
+[\fIoptions\fR] \fIinput_file output_file\fR
+.SH DESCRIPTION
+Encodes input_file using Speex. It can read the WAV or raw files.
+.SS "input_file can be:"
+.TP
+filename.wav
+wav file
+.TP
+filename.*
+raw PCM file (any extension other than .wav)
+.TP
+-
+stdin
+.SS "output_file can be:"
+.TP
+filename.spx
+Speex file
+.TP
+-
+stdout
+.SH OPTIONS
+.TP
+\fB\-n\fR, \fB\-\-narrowband\fR
+Narrowband (8 kHz) input file
+.TP
+\fB\-w\fR, \fB\-\-wideband\fR
+Wideband (16 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)
+.TP
+\fB\-\-vbr\fR
+Enable variable bit-rate (VBR)
+.TP
+\fB\-\-comp\fR n
+Set encoding complexity (0-10), default 3
+.TP
+\fB\-\-nframes\fR n
+Number of frames per Ogg packet (1-10), default 1
+.TP
+\fB\-\-comment\fR
+Add the given string as an extra comment. This may be
+used multiple times.
+.TP
+\fB\-\-author\fR
+Author of this track.
+.TP
+\fB\-\-title\fR
+Title for this track.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+This help
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Version information
+.TP
+\fB\-V\fR
+Verbose mode (show bit-rate)
+.SS "Raw input options:"
+.TP
+\fB\-\-le\fR
+Raw input is little-endian
+.TP
+\fB\-\-be\fR
+Raw input is big-endian
+.TP
+\fB\-\-8bit\fR
+Raw input is 8-bit unsigned
+.TP
+\fB\-\-16bit\fR
+Raw input is 16-bit signed
+.PP
+Default Raw PCM input is 16-bit, little-endian, mono
index 18c65a5..ea01570 100644 (file)
@@ -107,45 +107,47 @@ int read_samples(FILE *fin,int frame_size, int bits, int channels, int lsb, floa
 
 void usage()
 {
-   fprintf (stderr, "Speex encoder version " VERSION " (compiled " __DATE__ ")\n");
-   fprintf (stderr, "\n");
-   fprintf (stderr, "usage: speexenc [options] input_file output_file\n");
-   fprintf (stderr, "\n");
-   fprintf (stderr, "input_file can be:\n");
-   fprintf (stderr, "  filename.wav          wav file\n");
-   fprintf (stderr, "  filename.*            raw PCM file (any extension other than .wav)\n");
-   fprintf (stderr, "  -                     stdin\n");
-   fprintf (stderr, "\n");  
-   fprintf (stderr, "output_file can be:\n");
-   fprintf (stderr, "  filename.spx          Speex file\n");
-   fprintf (stderr, "  -                     stdout\n");
-   fprintf (stderr, "\n");  
-   fprintf (stderr, "options:\n");
-   fprintf (stderr, "  --narrowband -n    Narrowband (8 kHz) input file\n"); 
-   fprintf (stderr, "  --wideband   -w    Wideband (16 kHz) input file\n"); 
-   fprintf (stderr, "  --quality n        Encoding quality (0-10), default 3\n"); 
-   fprintf (stderr, "  --lbr              Low bit-rate mode (equivalent to --quality 3)\n"); 
-   fprintf (stderr, "  --vbr              Enable variable bit-rate (VBR)\n"); 
-   fprintf (stderr, "  --comp n           Set encoding complexity (0-10), default 3\n"); 
-   fprintf (stderr, "  --nframes n        Number of frames per Ogg packet (1-10), default 1\n"); 
-   fprintf (stderr, "  --comment          Add the given string as an extra comment. This may be\n                     used multiple times.\n");
-   fprintf (stderr, "  --author           Author of this track.\n");
-   fprintf (stderr, "  --title            Title for this track.\n");
-   fprintf (stderr, "  --help       -h    This help\n"); 
-   fprintf (stderr, "  --version    -v    Version information\n"); 
-   fprintf (stderr, "  -V                 Verbose mode (show bit-rate)\n"); 
-   fprintf (stderr, "raw input options:\n");
-   fprintf (stderr, "  --le               Raw input is little-endian\n"); 
-   fprintf (stderr, "  --be               Raw input is big-endian\n"); 
-   fprintf (stderr, "  --8bit             Raw input is 8-bit unsigned\n"); 
-   fprintf (stderr, "  --16bit            Raw input is 16-bit signed\n"); 
-   fprintf (stderr, "\n");  
-   fprintf (stderr, "Default Raw PCM input is 16-bit, little-endian, mono\n"); 
+   /*printf ("Speex encoder version " VERSION " (compiled " __DATE__ ")\n");
+   printf ("\n");*/
+   printf ("Usage: speexenc [options] input_file output_file\n");
+   printf ("\n");
+   printf ("Encodes input_file using Speex. It can read the WAV or raw files.\n");
+   printf ("\n");
+   printf ("input_file can be:\n");
+   printf ("  filename.wav          wav file\n");
+   printf ("  filename.*            raw PCM file (any extension other than .wav)\n");
+   printf ("  -                     stdin\n");
+   printf ("\n");  
+   printf ("output_file can be:\n");
+   printf ("  filename.spx          Speex file\n");
+   printf ("  -                     stdout\n");
+   printf ("\n");  
+   printf ("Options:\n");
+   printf (" -n, --narrowband   Narrowband (8 kHz) input file\n"); 
+   printf (" -w, --wideband     Wideband (16 kHz) input file\n"); 
+   printf (" --quality n        Encoding quality (0-10), default 3\n"); 
+   printf (" --lbr              Low bit-rate mode (equivalent to --quality 3)\n"); 
+   printf (" --vbr              Enable variable bit-rate (VBR)\n"); 
+   printf (" --comp n           Set encoding complexity (0-10), default 3\n"); 
+   printf (" --nframes n        Number of frames per Ogg packet (1-10), default 1\n"); 
+   printf (" --comment          Add the given string as an extra comment. This may be\n                     used multiple times.\n");
+   printf (" --author           Author of this track.\n");
+   printf (" --title            Title for this track.\n");
+   printf (" -h, --help         This help\n"); 
+   printf (" -v, --version      Version information\n"); 
+   printf (" -V                 Verbose mode (show bit-rate)\n"); 
+   printf ("Raw input options:\n");
+   printf (" --le               Raw input is little-endian\n"); 
+   printf (" --be               Raw input is big-endian\n"); 
+   printf (" --8bit             Raw input is 8-bit unsigned\n"); 
+   printf (" --16bit            Raw input is 16-bit signed\n"); 
+   printf ("\n");  
+   printf ("Default Raw PCM input is 16-bit, little-endian, mono\n"); 
 }
 
 void version()
 {
-   fprintf (stderr, "Speex encoder version " VERSION " (compiled " __DATE__ ")\n");
+   printf ("Speex encoder version " VERSION " (compiled " __DATE__ ")\n");
 }
 
 int main(int argc, char **argv)