diff --git a/doc/Makefile.am b/doc/Makefile.am index 4aa0267b4daef1d72fea0fb5af611781419e37e3..4f1d3d80a9f5aaa10ec9065e8b6f8f5cc05f50ca 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -4,14 +4,14 @@ EXTRA_DIST = Doxyfile.in \ forcefeed.fig forcefeed.eps forcefeed.png \ hungry.fig hungry.eps hungry.png \ oggzdump.1.sgml oggzdiff.1.sgml oggzmerge.1.sgml \ - oggzrip.1.sgml oggzinfo.1.sgml \ - oggzdump.1 oggzdiff.1 oggzmerge.1 oggzrip.1 oggzinfo.1 + oggzrip.1.sgml oggzinfo.1.sgml oggz-validate.1.sgml \ + oggzdump.1 oggzdiff.1 oggzmerge.1 oggzrip.1 oggzinfo.1 oggz-validate.1 -man_MANS = oggzdump.1 oggzdiff.1 oggzmerge.1 oggzrip.1 oggzinfo.1 +man_MANS = oggzdump.1 oggzdiff.1 oggzmerge.1 oggzrip.1 oggzinfo.1 oggz-validate.1 doc_DATA = doxygen-build.stamp -html: oggzdump.1.html oggzdiff.1.html oggzmerge.1.html oggzrip.1.html oggzinfo.1.html +html: oggzdump.1.html oggzdiff.1.html oggzmerge.1.html oggzrip.1.html oggzinfo.1.html oggz-validate.1.html if HAVE_DOCBOOKTOMAN %.1: %.1.sgml diff --git a/doc/oggz-validate.1 b/doc/oggz-validate.1 new file mode 100644 index 0000000000000000000000000000000000000000..29fba7531f97db8f162f7278ba636212f62d00bf --- /dev/null +++ b/doc/oggz-validate.1 @@ -0,0 +1,105 @@ +.\" $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! +.\" +.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 +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, 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 04 Apr 2005, 08:26 diff --git a/doc/oggz-validate.1.sgml b/doc/oggz-validate.1.sgml new file mode 100644 index 0000000000000000000000000000000000000000..72b0020d4a96b3ae61f6e315672eda33a768c612 --- /dev/null +++ b/doc/oggz-validate.1.sgml @@ -0,0 +1,169 @@ + manpage.1'. You may view + the manual page with: `docbook-to-man manpage.sgml | nroff -man | + less'. A typical entry in a Makefile or Makefile.am is: + +manpage.1: manpage.sgml + docbook-to-man $< > $@ + --> + + + Conrad"> + Parker"> + + April 3, 2005"> + + 1"> + conrad.parker@csiro.au"> + + oggz-validate"> + + Debian GNU/Linux"> + GNU"> +]> + + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2005 + &dhusername; + + &dhdate; + + + + &dhucpackage; + &dhsection; + + + + &dhpackage; + Validate the Ogg framing of one or more files + + + + + + + &dhpackage; + filename + + + + &dhpackage; + -h--help + -v--version + + + + + + Description + + &dhpackage; validates the Ogg framing of one or more + Ogg files. + &dhpackage; detects the following errors + in Ogg framing: + + Packet out of order + Multiple bos packets + Multiple eos packets + Packet belongs to unknown serialno + Granulepos decreasing within track + + + + &dhpackage; exits with status 0 if all files + are valid, and with status 1 if one or more errors are found. + + + + + Options + + &dhpackage; accepts the following options: + + + + Miscellaneous options + + + + -h, --help + Display usage information and exit. + + + + -v, --version + Output version information and exit. + + + + + + + + + AUTHOR + + + &dhfirstname; &dhsurname; + + &dhdate + + + + + COPYRIGHT + + Copyright © 2005 &dhusername; + + + + + SEE ALSO + + + oggzdump + 1 + , + + oggzinfo + 1 + + + + + + +