Commit 29466136 authored by conrad's avatar conrad

remove autogenerated manpages (closes ticket:155)


git-svn-id: http://svn.annodex.net/liboggz/trunk@1433 8158c8cd-e7e1-0310-9fa4-c5954c97daef
parent 206621e6
.\" $Header: /aolnet/dev/src/CVS/sgml/docbook-to-man/cmd/docbook-to-man.sh,v 1.1.1.1 1998/11/13 21:31:59 db3l Exp $
.\"
.\" transcript compatibility for postscript use.
.\"
.\" synopsis: .P! <file.ps>
.\"
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl \" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl \" prolog
.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie !\\*(f4 \{\
. ft \\*(f4
. ds f4\"
' br \}
.el .ie !\\*(f3 \{\
. ft \\*(f3
. ds f3\"
' br \}
.el .ie !\\*(f2 \{\
. ft \\*(f2
. ds f2\"
' br \}
.el .ie !\\*(f1 \{\
. ft \\*(f1
. ds f1\"
' br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
'\" t
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
.TH "oggz-validate" "1"
.SH "NAME"
oggz-validate \(em Validate the Ogg framing of one or more files
.SH "SYNOPSIS"
.PP
\fBoggz-validate \fRfilename \&...
.PP
\fBoggz-validate\fR [-h | --help ] [-v | --version ]
.SH "Description"
.PP
\fBoggz-validate\fR validates the Ogg framing of one or more
Ogg files.
.PP
\fBoggz-validate\fR detects the following errors
in Ogg framing:
.IP " \(bu" 6
Packet out of order
.IP " \(bu" 6
Multiple bos packets
.IP " \(bu" 6
Multiple eos packets
.IP " \(bu" 6
Missing eos packets
.IP " \(bu" 6
Packet belongs to unknown serialno
.IP " \(bu" 6
Granulepos decreasing within track
.PP
\fBoggz-validate\fR exits with status 0 if all files
are valid Ogg files, and with status 1 if one or more errors are found.
.SH "Options"
.PP
\fBoggz-validate\fR accepts the following options:
.SS "Miscellaneous options"
.IP "-h, --help" 10
Display usage information and exit.
.IP "-v, --version" 10
Output version information and exit.
.SH "AUTHOR"
.PP
Conrad Parker April 3, 2005;
.SH "COPYRIGHT"
.PP
Copyright \(co 2005 CSIRO Australia
.SH "SEE ALSO"
.PP
\fBoggzdump\fP\fB(1)\fP,
\fBoggzinfo\fP\fB(1)\fP
.\" created by instant / docbook-to-man, Mon 11 Jul 2005, 15:28
.\" $Header: /aolnet/dev/src/CVS/sgml/docbook-to-man/cmd/docbook-to-man.sh,v 1.1.1.1 1998/11/13 21:31:59 db3l Exp $
.\"
.\" transcript compatibility for postscript use.
.\"
.\" synopsis: .P! <file.ps>
.\"
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl \" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl \" prolog
.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie !\\*(f4 \{\
. ft \\*(f4
. ds f4\"
' br \}
.el .ie !\\*(f3 \{\
. ft \\*(f3
. ds f3\"
' br \}
.el .ie !\\*(f2 \{\
. ft \\*(f2
. ds f2\"
' br \}
.el .ie !\\*(f1 \{\
. ft \\*(f1
. ds f1\"
' br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
'\" t
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
.TH "oggzdiff" "1"
.SH "NAME"
oggzdiff \(em Hexdump the packets of two Ogg files and output differences
.SH "SYNOPSIS"
.PP
\fBoggzdiff\fR [options] [OGGZDUMP_OPTIONS] [DIFF_OPTIONS] file1.ogg file2.ogg
.PP
\fB\fBoptions:\fR\fR [--verbose ] [-v | --version ] [-h | --help ]
.PP
\fB\fBOGGZDUMP_OPTIONS:\fR\fR [-b | --binary ] [-x | --hexadecimal ] [-c content-type | --content-type content-type ] [-s serialno | --serialno serialno ] [-O | --hide-offset ] [-S | --hide-serialno ] [-G | --hide-granulepos ] [-P | --hide-packetno ]
.PP
\fB\fBDIFF_OPTIONS:\fR\fR [-q | --brief ] [-C NUM | --context[=NUM] ] [-u | -U NUM | --unified[=NUM] ] [-e | --ed ] [--normal ] [--rcs ] [-y | --side-by-side ] [-l | --paginate ]
.SH "Description"
.PP
\fBoggzdiff\fR is a \fBsh\fR script which
uses \fBoggzdump\fR to generate hexadecimal packet dumps
of each input file, then outputs the difference between these dumps
using \fBdiff\fR.
.SH "Options"
.PP
\fBoggzdiff\fR forwards a subset of options
accepted by \fBoggzdump\fR and \fBdiff\fR.
See
\fBoggzdump\fP\fB(1)\fP and
\fBdiff\fP\fB(1)\fP for more detail.
.SS "oggzdump 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"
.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: "theora", "vorbis", "speex", "cmml"
.IP "-s \fBserialno\fR, --serialno \fBserialno\fR" 10
Dump only the logical bitstream with specified
\fBserialno\fR.
.IP "-O, --hide-offset" 10
Hide the byte offset field of the preamble for
each packet dumped. This is particularly useful when comparing
Ogg bitstreams that differ only in page structure.
.IP "-S, --hide-serialno" 10
Hide the serialno field of the preamble for
each packet dumped. This is particularly useful when comparing
Ogg bitstreams that differ only in serialno assignment.
.IP "-G, --hide-granulepos" 10
Hide the granulepos field of the preamble for
each packet dumped.
.IP "-P, --hide-packetno" 10
Hide the packetno field of the preamble for
each packet dumped.
.SS "diff options"
.PP
The -w (--ignore-all-space) option to \fBdiff\fR is always implied.
.IP "-q, --brief" 10
Output only whether files differ.
.IP "-C \fBNUM\fR, --context[=\fBNUM\fR]" 10
Output NUM lines of copied context.
.IP "-u, -U \fBNUM\fR, --unified[=\fBNUM\fR]" 10
Output NUM (default 3) lines of unified context.
.IP "-e, --ed" 10
Output an ed script.
.IP "--normal" 10
Output a normal diff.
.IP "--rcs" 10
Output an RCS format diff.
.IP "-y, --side-by-side" 10
Output in two columns.
.IP "-l, --paginate" 10
Pass the output through \fBpr\fR to
paginate it.
.SS "Miscellaneous options"
.IP "--verbose" 10
Display verbose messages.
.IP "-v, --version" 10
Display version information and exit.
.IP "-h, --help" 10
Display usage information and exit.
.SH "AUTHOR"
.PP
Conrad Parker
.SH "COPYRIGHT"
.PP
Copyright \(co 2003 CSIRO Australia
.SH "SEE ALSO"
.PP
\fBoggzdump\fP\fB(1)\fP,
\fBdiff\fP\fB(1)\fP,
\fBpatch\fP\fB(1)\fP
.\" created by instant / docbook-to-man, Thu 31 Mar 2005, 00:07
.\" $Header: /aolnet/dev/src/CVS/sgml/docbook-to-man/cmd/docbook-to-man.sh,v 1.1.1.1 1998/11/13 21:31:59 db3l Exp $
.\"
.\" transcript compatibility for postscript use.
.\"
.\" synopsis: .P! <file.ps>
.\"
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl \" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl \" prolog
.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie !\\*(f4 \{\
. ft \\*(f4
. ds f4\"
' br \}
.el .ie !\\*(f3 \{\
. ft \\*(f3
. ds f3\"
' br \}
.el .ie !\\*(f2 \{\
. ft \\*(f2
. ds f2\"
' br \}
.el .ie !\\*(f1 \{\
. ft \\*(f1
. ds f1\"
' br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
'\" t
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
.TH "oggzdump" "1"
.SH "NAME"
oggzdump \(em Hexdump packets of an Ogg file, or revert an Ogg file from
such a hexdump
.SH "SYNOPSIS"
.PP
\fBoggzdump\fR [-b | --binary ] [-x | --hexadecimal ] [-n | --new ] [-o \fBfilename\fR | --output \fBfilename\fR ] [-c \fBcontent-type\fR | --content-type \fBcontent-type\fR ] [-s \fBserialno\fR | --serialno \fBserialno\fR ] [-O | --hide-offset ] [-S | --hide-serialno ] [-G | --hide-granulepos ] [-P | --hide-packetno ] filename
.PP
\fBoggzdump\fR [-r | --revert ] [-o \fBfilename\fR | --output \fBfilename\fR ] filename
.PP
\fBoggzdump\fR [-h | --help ] [-v | --version ]
.SH "Description"
.PP
\fBoggzdump\fR generates a hexadecimal or binary dump
of packets in an Ogg file, or creates an Ogg file from a hexadecimal
oggzdump file.
.SH "Options"
.PP
\fBoggzdump\fR accepts the following options:
.SS "Dump format options"
.IP "-b, --binary" 10
Generate a binary dump of each packet
.IP "-x, --hexadecimal" 10
Generate a hexadecimal dump of each packet
.SS "Filtering options"
.IP "-n, --new" 10
Only dump the first packet of each new logical
bitstream found; for correctly formed Ogg files, this dumps
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: "theora", "vorbis", "speex", "cmml"
.IP "-s \fBserialno\fR, --serialno \fBserialno\fR" 10
Dump only the logical bitstream with specified
\fBserialno\fR.
.IP "-O, --hide-offset" 10
Hide the byte offset field of the preamble for
each packet dumped. This is particularly useful in
conjunction with
\fBoggzdiff\fP\fB(1)\fP when comparing Ogg bitstreams that differ
only in page structure.
.IP "-S, --hide-serialno" 10
Hide the serialno field of the preamble for
each packet dumped. This is particularly useful in
conjunction with
\fBoggzdiff\fP\fB(1)\fP when comparing Ogg bitstreams that differ
only in serialno assignment.
.IP "-G, --hide-granulepos" 10
Hide the granulepos field of the preamble for
each packet dumped.
.IP "-P, --hide-packetno" 10
Hide the packetno field of the preamble for
each packet dumped.
.SS "Mode options"
.IP "-r, --revert" 10
Revert an oggzdump. Generates an Ogg bitstream as prescribed
in the input oggzdump.
.IP "" 10
The serialno, granulepos and packetno fields of the packet
preambles in the oggzdump, as well as any bos or eos markers
if present, are used to structure the packets into logical
bitstreams. Hence it is advised that the original input
oggzdump not be generated with any hiding filters.
.IP "" 10
Only the hexadecimal data columns of the input oggzdump are
parsed when generating Ogg packet data; the printable character
representation is ignored.
.SS "Miscellaneous options"
.IP "-o \fBfilename\fR, --output \fBfilename\fR" 10
Write output to the specified
\fBfilename\fR instead of printing it to
standard output.
.IP "-h, --help" 10
Display usage information and exit.
.IP "-v, --version" 10
Output version information and exit.
.SH "AUTHOR"
.PP
Conrad Parker November 17, 2003;
.SH "COPYRIGHT"
.PP
Copyright \(co 2003 CSIRO Australia
.SH "SEE ALSO"
.PP
\fBoggzdiff\fP\fB(1)\fP,
\fBxxd\fP\fB(1)\fP,
\fBhexdump\fP\fB(1)\fP
.\" created by instant / docbook-to-man, Mon 04 Apr 2005, 08:40
.\" $Header: /aolnet/dev/src/CVS/sgml/docbook-to-man/cmd/docbook-to-man.sh,v 1.1.1.1 1998/11/13 21:31:59 db3l Exp $
.\"
.\" transcript compatibility for postscript use.
.\"
.\" synopsis: .P! <file.ps>
.\"
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl \" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl \" prolog
.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie !\\*(f4 \{\
. ft \\*(f4
. ds f4\"
' br \}
.el .ie !\\*(f3 \{\
. ft \\*(f3
. ds f3\"
' br \}
.el .ie !\\*(f2 \{\
. ft \\*(f2
. ds f2\"
' br \}
.el .ie !\\*(f1 \{\
. ft \\*(f1
. ds f1\"
' br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
'\" t
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
.TH "oggzinfo" "1"
.SH "NAME"
oggzinfo \(em Display information about one or more Ogg files and their bitstreams.
.SH "SYNOPSIS"
.PP
\fBoggzinfo\fR [-l | --length ] [-b | --bitrate ] [-g | --page-stats ] [-p | --packet-stats ] [-a | --all ] filename \&...
.PP
\fBoggzinfo\fR [-h | --help ] [-v | --version ]
.SH "Description"
.PP
\fBoggzinfo\fR displays information about one or more
Ogg files and their bitstreams.
.SH "Options"
.PP
\fBoggzinfo\fR accepts the following options:
.SS "Display options"
.IP "-l, --length" 10
Display content lengths.
.IP "-b, --bitrate" 10
Display bitrate information.
.IP "-g, --page-stats" 10
Display Ogg page statistics.
.IP "-p, --packet-stats" 10
Display Ogg packet statistics.
.IP "-a, --all" 10
Display all information.
.SS "Miscellaneous options"
.IP "-h, --help" 10
Display usage information and exit.
.IP "-v, --version" 10
Output version information and exit.
.SH "Units of measurement"
.PP
\fBoggzinfo\fR displays information using the
following units:
.SS "Byte lengths"
.IP "bytes" 10
(8 bits)
.IP "kB" 10
kilobytes (1024 bytes)
.IP "MB" 10
megabytes (1024*1024 bytes)
.IP "GB" 10
gigabytes (1024*1024*1024 bytes)
.SS "Bitrates"
.IP "bps" 10
bits per second (bit/s)
.IP "kbps" 10
kilobits per second (1000 bit/s)
.IP "Mbps" 10
megabits per second (1000000 bit/s)
.IP "Gbps" 10
gigabits per second (1000000000 bit/s)
.SH "AUTHOR"
.PP
Conrad Parker March 10, 2005;
.SH "COPYRIGHT"
.PP
Copyright \(co 2005 CSIRO Australia
.SH "SEE ALSO"
.PP
\fBoggzdump\fP\fB(1)\fP,
\fBoggzrip\fP\fB(1)\fP,
\fBoggzdiff\fP\fB(1)\fP
.\" created by instant / docbook-to-man, Thu 10 Mar 2005, 15:45
.\" $Header: /aolnet/dev/src/CVS/sgml/docbook-to-man/cmd/docbook-to-man.sh,v 1.1.1.1 1998/11/13 21:31:59 db3l Exp $
.\"
.\" transcript compatibility for postscript use.
.\"
.\" synopsis: .P! <file.ps>
.\"
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl \" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl \" prolog
.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie !\\*(f4 \{\
. ft \\*(f4
. ds f4\"
' br \}
.el .ie !\\*(f3 \{\
. ft \\*(f3
. ds f3\"
' br \}
.el .ie !\\*(f2 \{\
. ft \\*(f2
. ds f2\"
' br \}
.el .ie !\\*(f1 \{\
. ft \\*(f1
. ds f1\"
' br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
'\" t
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
.TH "oggzmerge" "1"
.SH "NAME"
oggzmerge \(em Merge Ogg files together, interleaving pages in order of
presentation time.
.SH "SYNOPSIS"
.PP
\fBoggzmerge\fR [-o \fBfilename\fR | --output \fBfilename\fR ] filename \&...
.PP
\fBoggzmerge\fR [-h | --help ] [-v | --version ]
.SH "Description"
.PP
\fBoggzmerge\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.
.SH "Options"
.PP
\fBoggzmerge\fR accepts the following options:
.SS "Miscellaneous options"
.IP "-o \fBfilename\fR, --output \fBfilename\fR" 10
Write output to the specified
\fBfilename\fR instead of printing it to
standard output.
.IP "-h, --help" 10
Display usage information and exit.
.IP "-v, --version" 10
Output version information and exit.
.SH "AUTHOR"
.PP
Conrad Parker September 21, 2004;
.SH "COPYRIGHT"
.PP
Copyright \(co 2004 CSIRO Australia
.SH "SEE ALSO"
.PP
\fBoggzrip\fP\fB(1)\fP,
\fBoggzdump\fP\fB(1)\fP,
\fBoggzdiff\fP\fB(1)\fP
.\" created by instant / docbook-to-man, Mon 04 Apr 2005, 08:40
.\" $Header: /aolnet/dev/src/CVS/sgml/docbook-to-man/cmd/docbook-to-man.sh,v 1.1.1.1 1998/11/13 21:31:59 db3l Exp $
.\"
.\" transcript compatibility for postscript use.
.\"
.\" synopsis: .P! <file.ps>
.\"
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl \" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl \" prolog
.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie !\\*(f4 \{\
. ft \\*(f4
. ds f4\"
' br \}
.el .ie !\\*(f3 \{\
. ft \\*(f3
. ds f3\"
' br \}
.el .ie !\\*(f2 \{\
. ft \\*(f2
. ds f2\"
' br \}
.el .ie !\\*(f1 \{\
. ft \\*(f1
. ds f1\"
' br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
'\" t
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
.TH "oggzrip" "1"
.SH "NAME"
oggzrip \(em Extract one or more logical bitstreams from an Ogg file.
.SH "SYNOPSIS"
.PP
\fBoggzrip\fR [-o \fBfilename\fR | --output \fBfilename\fR ] filename
.PP
\fBoggzrip\fR [-h | --help ] [-v | --version ]
.SH "Description"
.PP
\fBoggzrip\fR extracts one or more logical bitstreams
from an Ogg file.
.SH "Options"
.PP
\fBoggzrip\fR accepts the following options:
.SS "Miscellaneous options"
.IP "-o \fBfilename\fR, --output \fBfilename\fR" 10
Write output to the specified
\fBfilename\fR instead of printing it to
standard output.
.IP "-h, --help" 10
Display usage information and exit.
.IP "-v, --version" 10
Output version information and exit.
.SS "Filter options"
.PP
These options can be used multiple times. Pages matching ANY of
the filter options will be included into the output.
.IP "-s \fBserialno\fR, --serialno \fBserialno\fR" 10
Output streams with given serialno.
.IP "-i \fBindex\fR, --stream-index \fBindex\fR" 10
Filter by stream index. These are assigned to
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: "theora",
"vorbis", "speex", "annodex"
.SH "AUTHOR"
.PP
David Kuehling January 1, 2005;
.SH "COPYRIGHT"
.PP
Copyright \(co 2005 CSIRO Australia
.SH "SEE ALSO"
.PP
\fBoggzmerge\fP\fB(1)\fP,
\fBoggzdump\fP\fB(1)\fP,
\fBoggzdiff\fP\fB(1)\fP
.\" created by instant / docbook-to-man, Mon 04 Apr 2005, 08:42
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