Commit 46b2367b authored by Michael Smith's avatar Michael Smith
Browse files

Add manpage (contributed by Frederick Lee <phaethon@linux.ucla.edu>)

fix raw option.

svn path=/trunk/vorbis-tools/; revision=3514
parent f9ed06f0
......@@ -10,6 +10,9 @@ DEFS = -DLOCALEDIR=\"$(localedir)\" @DEFS@
bin_PROGRAMS = oggdec
mandir = @MANDIR@
man_MANS = oggdec.1
INCLUDES = @OGG_CFLAGS@ @VORBIS_CFLAGS@ @SHARE_CFLAGS@
oggdec_LDADD = @LIBICONV@ @SHARE_LIBS@ @VORBISFILE_LIBS@ @VORBIS_LIBS@ @OGG_LIBS@
......@@ -17,6 +20,8 @@ oggdec_DEPENDENCIES = @SHARE_LIBS@
oggdec_SOURCES = oggdec.c
EXTRA_DIST = $(man_MANS)
endif
debug:
......@@ -24,3 +29,5 @@ debug:
profile:
$(MAKE) all CFLAGS="@PROFILE@"
.TH "oggdec" "1" "2002 July 03" "" "Vorbis Tools"
.SH "NAME"
oggdec - simple decoder, Ogg Vorbis file to PCM audio file (WAV or RAW).
.SH "SYNOPSIS"
.B oggdec
[
.B -Qhv
] [
.B -b bits_per_sample
] [
.B -e endianness
] [
.B -R rawness
] [
.B -s signedness
] [
.B -o outputfile
]
.B file ...
.SH "DESCRIPTION"
.B oggdec
decodes Ogg Vorbis files into PCM-encoded ("uncompressed") audio files, either WAV or RAW format.
For each input file,
.B oggdec
writes to a filename based on the input filename, but with the extension changed to ".wav" or ".raw" as appropriate.
If the input file is specified as
.B "-"
, then
.B oggdec
will read from stdin, and write to stdout unless an output filename is specified. Likewise, an output filename of
.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.
.SH "OPTIONS"
.IP "-q, --quiet"
Suppresses program output.
.IP "-h, --help"
Print help message.
.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 n, --raw=n"
Output in raw format. If not specified, writes WAV file (RIFF headers).
.IP "-s n, --sign=n"
Set signedness for output. 0 for unsigned, 1 (default) for signed.
.IP "-o filename, --output=filename"
Write output to specified filename. This option is only valid if one input [file] is specified.
.SH "EXAMPLES"
Decode a file
.B enabler.ogg
to
.B enabler.wav
as little-endian unsigned 16-bit (default options):
.RS
oggdec enabler.ogg
.RE
Decode a file
.B enabler.ogg
to
.B enabler.raw
as headerless little-endian unsigned 16-bit:
.RS
oggdec --raw=1 enabler.ogg
.RE
Decode
.B enabler.ogg
to
.B enabler.crazymonkey
as unsigned 8-bit:
.RS
oggdec -b 8 -s 0 -o enabler.crazymonkey enabler.ogg
.RE
Decode
.B enabler.ogg
to
.B enabler.raw
as big-endian signed 16-bit (any of the following):
.RS
oggdec -R 1 -e 1 -b 16 enabler.ogg
.RE
.RS
oggdec -R 1 -e 1 -b 16 -o enabler.raw - < enabler.ogg
.RE
.RS
oggdec -R 1 -e 1 -b 16 - < enabler.ogg > enabler.raw
.RE
Mass decoding (foo.ogg to foo.wav, bar.ogg to bar.wav, quux.ogg to quux.wav, etc.):
.RS
oggdec *.ogg
.RE
.SH "SEE ALSO"
.B ogg123(1)
.SH "AUTHORS"
.SS "Program Authors"
Michael Smith <msmith@labyrinth.net.au>
.SS "Manpage Authors"
.br
Frederick Lee <phaethon@linux.ucla.edu>, assisted by a few million monkeys armed with keyboards in irc://irc.openprojects.net/#vorbis
......@@ -68,7 +68,7 @@ static void parse_options(int argc, char **argv)
int option_index = 1;
int ret;
while((ret = getopt_long(argc, argv, "Qhvb:e:r:s:o:",
while((ret = getopt_long(argc, argv, "Qhvb:e:R:s:o:",
long_options, &option_index)) != -1)
{
switch(ret)
......
Supports Markdown
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