Commit 62b313fa authored by ivo's avatar ivo

Update oggenc man page with latest options. Update change log. Modify -v to...

Update oggenc man page with latest options.  Update change log.  Modify -v to -V on oggenc and oggdec for consistency with the other tools; closes #1112

svn path=/trunk/vorbis-tools/; revision=15280
parent 17025907
......@@ -4,6 +4,9 @@ vorbis-tools 1.2.1 -- Unreleased
* Corrected problems in the Visual Studio project files
* Updated po files from the Translation Project
* Added new en_GB.po, sk.po and vi.po translation files
* Added AC_USE_SYSTEM_EXTENSIONS to configure.ac; no more autogen.sh warnings
* Corrected SUBLANG values in intl/localename.c (#1415)
* Modify -v to -V on oggenc and oggdec for consistency (#1112)
* ogg123: backported fix from libfishsound to patch the Speex decoder (#1347)
* ogg123: fixed CPU issue when outputting to a closed pipe (#1357)
* ogg123: return value to stop decoding after buffer is shut down (#1357)
......@@ -12,8 +15,8 @@ vorbis-tools 1.2.1 -- Unreleased
* oggenc: fixed a typo in the Skeleton handling routine
* oggenc: fixed remapping channels bug (#1326)
* oggenc: support for WAVE_FORMAT_EXTENSIBLE headers (#1326)
* oggenc: support for 32 bit WAV files (#1326)
* oggenc: --ignorelength; support for WAV files > 4 GB (#1326)
* oggenc: support for 32 bit Wave files (#1326)
* oggenc: --ignorelength; support for Wave files > 4 GB (#1326)
* oggenc: split help text into manageable chunks to help translators (#1385)
* ogginfo: support for information in Kate streams (#1360)
* vcut: 64 bit fixes (#1366)
......@@ -21,7 +24,7 @@ vorbis-tools 1.2.1 -- Unreleased
vorbis-tools 1.2.0 -- 2008-02-21
* FLAC support now relies on libFLAC
* FLAC support now relies solely on libFLAC
* Support for large files (#879)
* Fixed acinclude.m4 to properly support --no switches
* ogg123: added remote control support (#1109)
......@@ -29,8 +32,8 @@ vorbis-tools 1.2.0 -- 2008-02-21
* ogg123: fixed a type mismatch in option parsing for 64 bit systems
* ogg123: configuration no longer hardcoded to /etc
* ogg123: compiles with older versions of libcurl
* ogg123: fix crash when playing 1-channel FLAC (#535)
* ogg123: fix floating-point exception when playing corrupt FLAC (#1119)
* ogg123: fixed crash when playing 1-channel FLAC (#535)
* ogg123: fixed floating-point exception when playing corrupt FLAC (#1119)
* oggdec: limited support for chained Ogg bitstreams
* oggdec: support decoding of multiple files into a single one
* oggenc: -k, switch for Skeleton bitstream encoding
......
.TH "oggdec" "1" "2002 July 03" "Xiph.Org Foundation" "Vorbis Tools"
.TH "oggdec" "1" "2008 September 9" "Xiph.Org Foundation" "Vorbis Tools"
.SH "NAME"
oggdec - simple decoder, Ogg Vorbis file to PCM audio file (WAV or RAW).
oggdec - simple decoder, Ogg Vorbis file to PCM audio file (Wave or RAW).
.SH "SYNOPSIS"
.B oggdec
......@@ -23,7 +23,7 @@ oggdec - simple decoder, Ogg Vorbis file to PCM audio file (WAV or RAW).
.SH "DESCRIPTION"
.B oggdec
decodes Ogg Vorbis files into PCM-encoded ("uncompressed") audio files, either WAV or RAW format.
decodes Ogg Vorbis files into PCM-encoded ("uncompressed") audio files, either Wave or RAW format.
For each input file,
.B oggdec
......@@ -37,21 +37,21 @@ will read from stdin, and write to stdout unless an output filename is specified
.B -
will cause output to be to stdout.
Writing WAV format to stdout is a bad idea. WAV requires a seekable medium for the header to be rewritten after all the data is written out; stdout is not seekable.
Writing Wave format to stdout is a bad idea. Wave requires a seekable medium for the header to be rewritten after all the data is written out; stdout is not seekable.
.SH "OPTIONS"
.IP "-Q, --quiet"
Suppresses program output.
.IP "-h, --help"
Print help message.
.IP "-v, --version"
.IP "-V, --version"
Display version information.
.IP "-b n, --bits=n"
Bits per sample. Valid values are 8 or 16.
.IP "-e n, --endian=n"
Set endianness for 16-bit output. 0 (default) is little-endian (Intel byte order). 1 is big-endian (sane byte order).
.IP "-R, --raw"
Output in raw format. If not specified, writes WAV file (RIFF headers).
Output in raw format. If not specified, writes Wave file (RIFF headers).
.IP "-s n, --sign=n"
Set signedness for output. 0 for unsigned, 1 (default) for signed.
.IP "-o filename, --output=filename"
......
......@@ -29,7 +29,7 @@
struct option long_options[] = {
{"quiet", 0,0,'Q'},
{"help",0,0,'h'},
{"version", 0, 0, 'v'},
{"version", 0, 0, 'V'},
{"bits", 1, 0, 'b'},
{"endianness", 1, 0, 'e'},
{"raw", 0, 0, 'R'},
......@@ -58,7 +58,7 @@ static void usage(void)
fprintf(stdout, _("Supported options:\n"));
fprintf(stdout, _(" --quiet, -Q Quiet mode. No console output.\n"));
fprintf(stdout, _(" --help, -h Produce this help message.\n"));
fprintf(stdout, _(" --version, -v Print out version number.\n"));
fprintf(stdout, _(" --version, -V Print out version number.\n"));
fprintf(stdout, _(" --bits, -b Bit depth for output (8 and 16 supported)\n"));
fprintf(stdout, _(" --endianness, -e Output endianness for 16-bit output; 0 for\n"
" little endian (default), 1 for big endian.\n"));
......@@ -75,7 +75,7 @@ static void parse_options(int argc, char **argv)
int option_index = 1;
int ret;
while((ret = getopt_long(argc, argv, "Qhvb:e:Rs:o:",
while((ret = getopt_long(argc, argv, "QhVb:e:Rs:o:",
long_options, &option_index)) != -1)
{
switch(ret)
......@@ -87,7 +87,7 @@ static void parse_options(int argc, char **argv)
usage();
exit(0);
break;
case 'v':
case 'V':
version();
exit(0);
break;
......
.\" Process this file with
.\" groff -man -Tascii oggenc.1
.\"
.TH oggenc 1 "2005 March 3" "Xiph.Org Foundation" "Vorbis Tools"
.TH oggenc 1 "2008 September 9" "Xiph.Org Foundation" "Vorbis Tools"
.SH NAME
oggenc \- encode audio into the Ogg Vorbis format
......@@ -82,7 +82,7 @@ oggenc \- encode audio into the Ogg Vorbis format
.SH DESCRIPTION
.B oggenc
reads audio data in either raw, WAV, or AIFF format and encodes it into an
reads audio data in either raw, Wave, or AIFF format and encodes it into an
Ogg Vorbis stream.
.B oggenc
may also read audio data from FLAC and Ogg FLAC files depending upon compile-time options. If the input file "-" is specified, audio data is
......@@ -106,7 +106,7 @@ will become file.ogg
.SH OPTIONS
.IP "-h, --help"
Show command help.
.IP "-v, --version"
.IP "-V, --version"
Show the version number.
.IP "-r, --raw"
Assume input data is raw little-endian audio data with no
......@@ -121,6 +121,14 @@ Sets raw mode input samplerate. Default is 44100.
.IP "--raw-endianness n
Sets raw mode endianness to big endian (1) or little endian (0). Default is
little endian.
.IP "--utf8 "
Informs oggenc that the Vorbis Comments are already encoded as UTF-8.
Useful in situations where the shell is using some other encoding.
.IP "-k, --skeleton"
Add a Skeleton bitstream. Important if the output Ogg is intended to carry
multiplexed or chained streams. Output file uses .oga as file extension.
.IP "--ignorelength"
Support for Wave files over 4 GB and stdin data streams.
.IP "-Q, --quiet"
Quiet mode. No messages are displayed.
.IP "-b n, --bitrate=n"
......@@ -210,7 +218,7 @@ approached with caution. They may significantly degrade audio quality
if misused. Not all these options are currently documented.
.IP "lowpass_frequency=N"
Set the lowpass frequency to N kHz.
Set the lowpass frequency to N kHz.
.IP "impulse_noisetune=N"
Set a noise floor bias N (range from -15. to 0.) for impulse blocks.
......@@ -354,7 +362,7 @@ Manpage Author:
Stan Seibert <indigo@aztec.asu.edu>
.SH BUGS
Reading type 3 wav files (floating point samples) probably doesn't work other than on intel (or other 32 bit, little endian machines).
Reading type 3 Wave files (floating point samples) probably doesn't work other than on Intel (or other 32 bit, little endian machines).
.SH "SEE ALSO"
......
......@@ -43,7 +43,7 @@ struct option long_options[] = {
{"name-remove",1,0,'X'},
{"name-replace",1,0,'P'},
{"output",1,0,'o'},
{"version",0,0,'v'},
{"version",0,0,'V'},
{"raw",0,0,'r'},
{"raw-bits",1,0,'B'},
{"raw-chan",1,0,'C'},
......@@ -399,7 +399,7 @@ static void usage(void)
" General:\n"
" -Q, --quiet Produce no output to stderr\n"
" -h, --help Print this help text\n"
" -v, --version Print the version number\n"));
" -V, --version Print the version number\n"));
fprintf(stdout, _(
" -k, --skeleton Adds an Ogg Skeleton bitstream\n"
" -r, --raw Raw mode. Input files are read directly as PCM data\n"
......@@ -614,7 +614,7 @@ static void parse_options(int argc, char **argv, oe_options *opt)
int ret;
int option_index = 1;
while((ret = getopt_long(argc, argv, "A:a:b:B:c:C:d:G:hkl:m:M:n:N:o:P:q:QrR:s:t:vX:",
while((ret = getopt_long(argc, argv, "A:a:b:B:c:C:d:G:hkl:m:M:n:N:o:P:q:QrR:s:t:VX:",
long_options, &option_index)) != -1)
{
switch(ret)
......@@ -822,7 +822,7 @@ static void parse_options(int argc, char **argv, oe_options *opt)
case 'r':
opt->rawmode = 1;
break;
case 'v':
case 'V':
fprintf(stdout, _("oggenc from %s %s\n"), PACKAGE, VERSION);
exit(0);
break;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment