[xiph-cvs] cvs commit: vorbis-tools/oggenc/man oggenc.1

[Michael Smith]

msmith      00/11/05 05:38:39

  Modified:    oggenc   oggenc.c
               oggenc/man oggenc.1
  Log:
  Help and documentation updates to reflect --bitrate instead of --mode.

Revision  Changes    Path
1.5       +9 -12     vorbis-tools/oggenc/oggenc.c

Index: oggenc.c
===================================================================
RCS file: /usr/local/cvsroot/vorbis-tools/oggenc/oggenc.c,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- oggenc.c	2000/11/05 04:52:21	1.4
+++ oggenc.c	2000/11/05 13:38:38	1.5
@@ -21,6 +21,7 @@
 #include "audio.h"
 
 #define VERSION_STRING "OggEnc v0.5 (libvorbis beta3)\n"
+#define COPYRIGHT "(c) 2000 Michael Smith <msmith at labyrinth.net.au)\n"
 #define CHUNK 4096 /* We do reads, etc. in multiples of this */
 
 /* Define supported formats here */
@@ -66,7 +67,7 @@
 
         if(optind >= argc)
         {
-		fprintf(stderr, "ERROR: No input files specified. Use -h for help.\n");
+		fprintf(stderr, VERSION_STRING COPYRIGHT "\nERROR: No input files specified. Use -h for help.\n");
                 return 1;
         }
         else
@@ -257,7 +258,7 @@
 {
         fprintf(stdout, 
                 VERSION_STRING
-		"(c) 2000 Michael Smith <msmith at labyrinth.net.au)\n"
+		COPYRIGHT
                 "\n"
                 "Usage: oggenc [options] input.wav [...]\n"
                 "\n"
@@ -302,16 +303,12 @@
                 " with -o\n"
                 "\n"
                 "MODES:\n"
-		" OggEnc support multiple different modes. Each of these is a fully VBR mode,\n"
-		" but they vary in intended (average) bitrate. The following table shows \n"
-		" approximate average bitrates (note that mode 3 is the default)\n"
-		"     Mode    |    Bitrate (stereo)\n"
-		"       1     |       N/A\n"
-		"       2     |    128 kbps\n"
-		"      *3     |    160 kbps\n"
-		"       4     |    192 kbps\n"
-		"       5     |    256 kbps\n"
-		"       6     |    350 kbps\n\n");
+		" OggEnc currently supports 5 different modes. Each of these is a fully VBR\n"
+		" (variable bitrate) mode, but they vary in intended average bitrate. The \n"
+		" bitrate option (--bitrate, -b) will choose the mode closest to the chosen\n"
+		" bitrate. The 5 modes are approximately 128,160,192,256, and 350 kbps (for\n"
+		" stereo input. Halve these numbers for mono input).\n"
+		" The default is the 160 kbps mode.\n");
 }
 
 char *generate_name_string(char *format, 

1.2       +6 -6      vorbis-tools/oggenc/man/oggenc.1

Index: oggenc.1
===================================================================
RCS file: /usr/local/cvsroot/vorbis-tools/oggenc/man/oggenc.1,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- oggenc.1	2000/09/11 06:21:16	1.1
+++ oggenc.1	2000/11/05 13:38:38	1.2
@@ -12,8 +12,8 @@
 .B -hrq
 ]
 [
-.B -m
-.I mode 
+.B -b
+.I bitrate 
 ]
 [
 .B -o
@@ -67,8 +67,8 @@
 header information.
 .IP "-q, --quiet"
 Quiet mode.  No messages are displayed.
-.IP "-m n, --mode=n"
-Sets encoding mode to n (n should be between 1 and 6, higher numbers give higher bitrates)
+.IP "-b n, --bitrate=n"
+Sets encoding to the bitrate closest to n (in kb/s). Defaults to 160 kb/s for stereo.
 .IP "-o output_file, --output=output_file"
 Write the Ogg Vorbis stream to
 .I output_file (only valid if a single input file is specified)
@@ -121,7 +121,7 @@
 
 Specifying a high-quality mode (approx 256 kbps):
 .RS
-oggenc infile.wav -m 5 out.ogg
+oggenc infile.wav -b 256 out.ogg
 .RE
 .PP
 
@@ -139,7 +139,7 @@
 in the section above. This example gives filenames 
 like "The Tea Party - Touch.ogg":
 .RS
-oggenc -m 4 -a "The Tea Party" -l "Triptych" -t "Touch" track01.wav -t
+oggenc -b 192 -a "The Tea Party" -l "Triptych" -t "Touch" track01.wav -t
 "Underground" track02.wav -t "Great Big Lie" track03.wav -n "%a - %t.ogg"
 .RE
 .PP

--- >8 ----
List archives:  http://www.xiph.org/archives/
Ogg project homepage: http://www.xiph.org/ogg/
To unsubscribe from this list, send a message to 'cvs-request at xiph.org'
containing only the word 'unsubscribe' in the body.  No subject is needed.
Unsubscribe messages sent to the list will be ignored/filtered.