Added vorbis-tools.
[vorbis-lancer-gcc.git] / vorbis-tools-1.2.0 / ogginfo / ogginfo.1
blob126da20da47b3a10a0b397434713d273b1429645
1 .\" Process this file with
2 .\" groff -man -Tascii ogginfo.1
3 .\"
4 .TH ogginfo 1 "July 10, 2002" "Xiph.Org Foundation" "Vorbis Tools"
6 .SH NAME
7 ogginfo \- gives information about Ogg files, and does extensive validity checking
9 .SH SYNOPSIS
10 .B ogginfo
12 .B -q
13 ] [
14 .B -v
15 ] [
16 .B -h
18 .I file1.ogg
19 .B ...
20 .I fileN.ogg
22 .SH DESCRIPTION
23 .B ogginfo
24 reads one or more Ogg files and prints information about stream contents 
25 (including chained and/or multiplexed streams) to standard output. It will 
26 detect (but not correct) a wide range of common defects, with many 
27 additional checks specifically for Ogg Vorbis streams.
29 For all stream types
30 .B ogginfo
31 will print the filename being processed, the stream serial numbers, and various
32 common error conditions.
34 For
35 .B Vorbis
36 streams, information including the version used for encoding, the sample rate
37 and number of channels, the bitrate and playback length, and the contents of
38 the comment header are printed.
40 Similarly, for
41 .B Theora
42 streams, basic information about the video is provided, including frame rate, aspect ratio, bitrate, length, and the comment header.
44 .SH OPTIONS
45 .IP -h
46 Show a help and usage message.
47 .IP -q
48 Quiet mode. This may be specified multiple times. Doing so once will remove
49 the detailed informative messages, twice will remove warnings as well.
50 .IP -v
51 Verbose mode. At the current time, this does not do anything.
53 .SH AUTHORS
54 .br
55 Michael Smith <msmith@xiph.org>
57 .SH "SEE ALSO"
59 .PP
60 \fBvorbiscomment\fR(1), \fBogg123\fR(1), \fBoggdec\fR(1), \fBoggenc\fR(1)