Commit b2754992 authored by conrad's avatar conrad

update docs and help output: ref oggz-known-codecs,

and add missing hyphens in SEE ALSO sections
parent 5021a98c
......@@ -10,8 +10,11 @@ oggz-chop \(em Extract the part of an Ogg file between given start and/or end ti
.SH "Description"
.PP
\fBoggz-chop\fR chops a section of an Ogg file.
It correctly interprets the granulepos timestamps of Ogg Vorbis, Speex,
FLAC and Theora bitstreams, and all bitstreams of Annodex files.
It correctly interprets the granulepos timestamps of
Ogg CELT, CMML, Dirac, FLAC, Kate, PCM, Speex, Theora and Vorbis
bitstreams.
Run \fBoggz-known-codecs\fP\fB(1)\fP for a full list
of codecs known by the installed version of oggz.
.PP
The output file contains copies of the headers of the input file, and
......@@ -101,7 +104,7 @@ Copyright \(co 2008 Annodex Association
.SH "SEE ALSO"
.PP
\fBoggz-validate\fP\fB(1)\fP,
\fBoggzmerge\fP\fB(1)\fP,
\fBoggzdump\fP\fB(1)\fP,
\fBoggz-merge\fP\fB(1)\fP,
\fBoggz-dump\fP\fB(1)\fP,
\fBhogg\fP\fB(1)\fP
.\" created by instant / docbook-to-man, Mon 23 Feb 2009, 12:35
......@@ -37,5 +37,5 @@ Copyright \(co 2005 CSIRO Australia
.SH "SEE ALSO"
.PP
\fBoggzinfo\fP\fB(1)\fP \fBhogg\fP\fB(1)\fP
\fBoggz-info\fP\fB(1)\fP \fBhogg\fP\fB(1)\fP
.\" created by instant / docbook-to-man, Mon 23 Feb 2009, 12:35
......@@ -33,8 +33,8 @@ Edit comments for all logical bitstreams.
.IP "\-c \fBcontent-type\fR, \-\-content-type \fBcontent-type\fR" 10
Edit comments of the logical bitstreams with
specified \fBcontent-type\fR.
The following codec names are currently detected:
"cmml", "flac", "theora", "speex", "vorbis"
Run \fBoggz-known-codecs\fP\fB(1)\fP for a full list
of codecs known by the installed version of oggz.
.IP "\-s \fBserialno\fR, \-\-serialno \fBserialno\fR" 10
Edit comments of the logical bitstream with
......@@ -55,6 +55,6 @@ Copyright \(co 2007 Annodex Association
.PP
\fBvorbiscomment\fP\fB(1)\fP,
\fBogginfo\fP\fB(1)\fP,
\fBoggzinfo\fP\fB(1)\fP,
\fBoggz-info\fP\fB(1)\fP,
\fBhogg\fP\fB(1)\fP
.\" created by instant / docbook-to-man, Mon 23 Feb 2009, 12:35
......@@ -14,30 +14,31 @@ oggz-diff \(em Hexdump the packets of two Ogg files and output differences
.SH "Description"
.PP
\fBoggz-diff\fR is a \fBsh\fR script which
uses \fBoggzdump\fR to generate hexadecimal packet dumps
uses \fBoggz-dump\fR to generate hexadecimal packet dumps
of each input file, then outputs the difference between these dumps
using \fBdiff\fR.
.SH "Options"
.PP
\fBoggz-diff\fR forwards a subset of options
accepted by \fBoggzdump\fR and \fBdiff\fR.
accepted by \fBoggz-dump\fR and \fBdiff\fR.
See
\fBoggzdump\fP\fB(1)\fP and
\fBoggz-dump\fP\fB(1)\fP and
\fBdiff\fP\fB(1)\fP for more detail.
.SS "oggzdump format options"
.SS "oggz-dump format options"
.IP "\-b, \-\-binary" 10
Generate a binary dump of each packet
.IP "\-x, \-\-hexadeciaml" 10
Generate a hexadecimal dump of each packet
.SS "oggzdump filtering options"
.SS "oggz-dump filtering options"
.IP "\-c \fBcontent-type\fR, \-\-content-type \fBcontent-type\fR" 10
Dump only the logical bitstreams for a specific
\fBcontent-type\fR. The following codec names
are currently detected: "cmml", "flac", "theora", "speex", "vorbis"
\fBcontent-type\fR.
Run \fBoggz-known-codecs\fP\fB(1)\fP for a full list
of codecs known by the installed version of oggz.
.IP "\-s \fBserialno\fR, \-\-serialno \fBserialno\fR" 10
Dump only the logical bitstream with specified
......@@ -106,7 +107,7 @@ Copyright \(co 2003 CSIRO Australia
.SH "SEE ALSO"
.PP
\fBoggzdump\fP\fB(1)\fP,
\fBoggz-dump\fP\fB(1)\fP,
\fBdiff\fP\fB(1)\fP,
\fBpatch\fP\fB(1)\fP
.\" created by instant / docbook-to-man, Mon 23 Feb 2009, 12:35
......@@ -35,8 +35,9 @@ only the beginning-of-stream packets.
.IP "\-c \fBcontent-type\fR, \-\-content-type \fBcontent-type\fR" 10
Dump only the logical bitstreams for a specific
\fBcontent-type\fR. The following codec names
are currently detected: "cmml", "flac", "theora", "speex", "vorbis"
\fBcontent-type\fR.
Run \fBoggz-known-codecs\fP\fB(1)\fP for a full list
of codecs known by the installed version of oggz.
.IP "\-s \fBserialno\fR, \-\-serialno \fBserialno\fR" 10
Dump only the logical bitstream with specified
......
......@@ -81,7 +81,7 @@ Copyright \(co 2005 CSIRO Australia
.SH "SEE ALSO"
.PP
\fBoggzdump\fP\fB(1)\fP,
\fBoggzrip\fP\fB(1)\fP,
\fBoggzdiff\fP\fB(1)\fP \fBhogg\fP\fB(1)\fP
\fBoggz-dump\fP\fB(1)\fP,
\fBoggz-rip\fP\fB(1)\fP,
\fBoggz-diff\fP\fB(1)\fP \fBhogg\fP\fB(1)\fP
.\" created by instant / docbook-to-man, Mon 23 Feb 2009, 12:35
......@@ -9,7 +9,8 @@ oggz-known-codecs \(em List codecs known by this version of Oggz
.PP
\fBoggz-known-codecs\fR lists the names of codecs for which oggz can
interpret timestamps and report general information. These codec names are
valid arguments to the \fB-c\fR, \fB\-\-content-type\fR arguments to other \fBoggz\fR commands.
valid arguments to the \fB-c\fR, \fB\-\-content-type\fR
arguments to other \fBoggz\fR commands.
.SH "Options"
.PP
......
......@@ -11,9 +11,12 @@ presentation time.
.SH "Description"
.PP
\fBoggz-merge\fR merges Ogg files together, interleaving
pages in order of presentation time. It correctly interprets the
granulepos timestamps of Ogg Vorbis, Speex, FLAC and Theora bitstreams,
and all bitstreams of Annodex files.
pages in order of presentation time.
It correctly interprets the granulepos timestamps of
Ogg CELT, CMML, Dirac, FLAC, Kate, PCM, Speex, Theora and Vorbis
bitstreams.
Run \fBoggz-known-codecs\fP\fB(1)\fP for a full list
of codecs known by the installed version of oggz.
.PP
For example, if you have an Ogg Theora video file, and its soundtrack
......@@ -73,8 +76,8 @@ Copyright \(co 2004 CSIRO Australia
.SH "SEE ALSO"
.PP
\fBcat\fP\fB(1)\fP,
\fBoggzrip\fP\fB(1)\fP,
\fBoggzdump\fP\fB(1)\fP,
\fBoggzdiff\fP\fB(1)\fP,
\fBoggz-rip\fP\fB(1)\fP,
\fBoggz-dump\fP\fB(1)\fP,
\fBoggz-diff\fP\fB(1)\fP,
\fBhogg\fP\fB(1)\fP
.\" created by instant / docbook-to-man, Mon 23 Feb 2009, 12:35
......@@ -9,13 +9,11 @@ oggz-rip \(em Extract one or more logical bitstreams from an Ogg file.
\fBoggz-rip\fR [\-h | \-\-help ] [\-v | \-\-version ]
.SH "Description"
.PP
\fBoggz-rip\fR extracts one or more tracks
from an Ogg file.
In Ogg terminology, \fBoggz-rip\fR extracts one or
more logical bitstreams.
\fBoggz-rip\fR extracts one or more tracks from an Ogg file.
In Ogg terminology, \fBoggz-rip\fR extracts one or more logical bitstreams.
.PP
For example, to extract just the vorbis audio track from any Ogg file:
For example, to extract just the Vorbis audio track from any Ogg file:
.PP
\fBoggz-rip \-c vorbis input.ogx > output.ogg\fR
......@@ -24,9 +22,8 @@ This will removed any other tracks: Skeleton, Theora, image, etc.
The output will be a valid Ogg Vorbis I file, suitable for use on
hardware players that do not support multiplexed (ie. multi-track)
Ogg files. If the input file contains multiple Vorbis, the desired
once can be specified by serialno with the \fB-s\fR option.
Use \fBoggzinfo\fR to view the serialno of
each track in a file.
once can be specified by serialno with the \fB-s\fR option.
Use \fBoggz-info\fR to view the serialno of each track in a file.
.SH "Options"
.PP
......@@ -55,8 +52,9 @@ streams in the order of their BOS pages,
starting at 0.
.IP "\-c \fBcontent-type\fR \-\-content-type \fBcontent-type\fR" 10
Filter by content-type. The following codec names
are currently detected: "cmml", "flac", "theora", "speex", "vorbis"
Filter by content-type.
Run \fBoggz-known-codecs\fP\fB(1)\fP for a full list
of codecs known by the installed version of oggz.
.SH EXAMPLES
.PP
......@@ -81,8 +79,8 @@ Copyright \(co 2005 CSIRO Australia
.SH "SEE ALSO"
.PP
\fBoggzmerge\fP\fB(1)\fP,
\fBoggz-merge\fP\fB(1)\fP,
\fBoggz-chop\fP\fB(1)\fP,
\fBoggzdump\fP\fB(1)\fP,
\fBoggzdiff\fP\fB(1)\fP \fBhogg\fP\fB(1)\fP
\fBoggz-dump\fP\fB(1)\fP,
\fBoggz-diff\fP\fB(1)\fP \fBhogg\fP\fB(1)\fP
.\" created by instant / docbook-to-man, Mon 23 Feb 2009, 12:35
......@@ -40,8 +40,8 @@ Copyright \(co 2005 CSIRO Australia
.SH "SEE ALSO"
.PP
\fBoggzdump\fP\fB(1)\fP,
\fBoggzinfo\fP\fB(1)\fP,
\fBoggzrip\fP\fB(1)\fP,
\fBoggz-dump\fP\fB(1)\fP,
\fBoggz-info\fP\fB(1)\fP,
\fBoggz-rip\fP\fB(1)\fP,
\fBoggz-validate\fP\fB(1)\fP
.\" created by instant / docbook-to-man, Mon 23 Feb 2009, 12:35
......@@ -10,9 +10,12 @@ oggz-sort \(em Sort the pages of an Ogg file in order of presentation time.
.SH "Description"
.PP
\fBoggz-sort\fR sorts an Ogg file, interleaving
pages in order of presentation time. It correctly interprets the
granulepos timestamps of Ogg Vorbis, Speex, FLAC and Theora bitstreams,
and all bitstreams of Annodex files.
pages in order of presentation time.
It correctly interprets the granulepos timestamps of
Ogg CELT, CMML, Dirac, FLAC, Kate, PCM, Speex, Theora and Vorbis
bitstreams.
Run \fBoggz-known-codecs\fP\fB(1)\fP for a full list
of codecs known by the installed version of oggz.
.PP
Some encoders produce files with incorrect page ordering; for example,
......@@ -69,8 +72,8 @@ Copyright \(co 2008 Annodex Association
.SH "SEE ALSO"
.PP
\fBoggz-validate\fP\fB(1)\fP,
\fBoggzmerge\fP\fB(1)\fP,
\fBoggzdump\fP\fB(1)\fP,
\fBoggzdiff\fP\fB(1)\fP,
\fBoggz-merge\fP\fB(1)\fP,
\fBoggz-dump\fP\fB(1)\fP,
\fBoggz-diff\fP\fB(1)\fP,
\fBhogg\fP\fB(1)\fP
.\" created by instant / docbook-to-man, Mon 23 Feb 2009, 12:35
......@@ -75,6 +75,6 @@ Copyright \(co 2005 CSIRO Australia
.SH "SEE ALSO"
.PP
\fBoggz-sort\fP\fB(1)\fP,
\fBoggzdump\fP\fB(1)\fP,
\fBoggzinfo\fP\fB(1)\fP
\fBoggz-dump\fP\fB(1)\fP,
\fBoggz-info\fP\fB(1)\fP
.\" created by instant / docbook-to-man, Sat 11 Apr 2009, 16:34
......@@ -89,8 +89,8 @@ usage (char * progname)
printf (" -n, --new Only dump the first packet of each logical bitstream\n");
printf (" -c content-type, --content-type content-type\n");
printf (" Dump only the logical bitstreams for a specified\n");
printf (" content-type. The following codecs are currently\n");
printf (" detected: theora, vorbis, speex, cmml, kate\n");
printf (" content-type. Run oggz-known-codecs for a list of\n");
printf (" codec names which can be detected by this version of oggz.\n");
printf (" -s serialno, --serialno serialno\n");
printf (" Dump only the logical bitstream with specified serialno\n");
printf (" -O, --hide-offset Hide the byte offset of each packet\n");
......
......@@ -92,9 +92,9 @@ usage (char * progname)
printf (" streams in the order of their BOS pages,\n");
printf (" starting at 0.\n");
printf (" -c content-type --content-type content-type\n");
printf (" Filter by content-type. The following codec\n");
printf (" names are currently detected: \"theora\",\n");
printf (" \"vorbis\", \"speex\", \"cmml\", \"kate\"\n");
printf (" Filter by content-type. Run oggz-known-codecs\n");
printf (" for a list of codec names which can be detected\n");
printf (" by this version of oggz.\n");
printf ("\nMiscellaneous options\n");
printf (" -o filename, --output filename\n");
printf (" Specify output filename\n");
......
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