From 1966af2d891c880f56b01f722c0c2b2bbf793cff Mon Sep 17 00:00:00 2001 From: conrad Date: Thu, 10 Mar 2005 04:41:43 +0000 Subject: [PATCH] add oggzinfo man page git-svn-id: http://svn.annodex.net/liboggz/trunk@1089 8158c8cd-e7e1-0310-9fa4-c5954c97daef --- doc/Makefile.am | 9 +- doc/oggzinfo.1 | 123 +++++++++++++++++++++ doc/oggzinfo.1.sgml | 259 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 387 insertions(+), 4 deletions(-) create mode 100644 doc/oggzinfo.1 create mode 100644 doc/oggzinfo.1.sgml diff --git a/doc/Makefile.am b/doc/Makefile.am index 278cd5b..4aa0267 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -3,14 +3,15 @@ docdir=$(prefix)/share/doc/@PACKAGE@ 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 \ - oggzdump.1 oggzdiff.1 oggzmerge.1 oggzrip.1 + 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 -man_MANS = oggzdump.1 oggzdiff.1 oggzmerge.1 oggzrip.1 +man_MANS = oggzdump.1 oggzdiff.1 oggzmerge.1 oggzrip.1 oggzinfo.1 doc_DATA = doxygen-build.stamp -html: oggzdump.1.html oggzdiff.1.html oggzmerge.1.html oggzrip.1.html +html: oggzdump.1.html oggzdiff.1.html oggzmerge.1.html oggzrip.1.html oggzinfo.1.html if HAVE_DOCBOOKTOMAN %.1: %.1.sgml diff --git a/doc/oggzinfo.1 b/doc/oggzinfo.1 new file mode 100644 index 0000000..797ee3b --- /dev/null +++ b/doc/oggzinfo.1 @@ -0,0 +1,123 @@ +.\" $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 "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 diff --git a/doc/oggzinfo.1.sgml b/doc/oggzinfo.1.sgml new file mode 100644 index 0000000..746f13d --- /dev/null +++ b/doc/oggzinfo.1.sgml @@ -0,0 +1,259 @@ + 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"> + + March 10, 2005"> + + 1"> + conrad.parker@csiro.au"> + + oggzinfo"> + + Debian GNU/Linux"> + GNU"> +]> + + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2005 + &dhusername; + + &dhdate; + + + + &dhucpackage; + &dhsection; + + + + &dhpackage; + Display information about one or more Ogg files and their bitstreams. + + + + + + + &dhpackage; + -l--length + -b--bitrate + -g--page-stats + -p--packet-stats + -a--all + filename + + + + &dhpackage; + -h--help + -v--version + + + + + + Description + + &dhpackage; displays information about one or more + Ogg files and their bitstreams. + + + + + Options + + &dhpackage; accepts the following options: + + + + Display options + + + + -l, --length + Display content lengths. + + + + -b, --bitrate + Display bitrate information. + + + + -g, --page-stats + Display Ogg page statistics. + + + + -p, --packet-stats + Display Ogg packet statistics. + + + + -a, --all + Display all information. + + + + + + + Miscellaneous options + + + + -h, --help + Display usage information and exit. + + + + -v, --version + Output version information and exit. + + + + + + + + + Units of measurement + + &dhpackage; displays information using the + following units: + + + + Byte lengths + + + + bytes + (8 bits) + + + + kB + kilobytes (1024 bytes) + + + + MB + megabytes (1024*1024 bytes) + + + + GB + gigabytes (1024*1024*1024 bytes) + + + + + + + Bitrates + + + + bps + bits per second (bit/s) + + + + kbps + kilobits per second (1000 bit/s) + + + + Mbps + megabits per second (1000000 bit/s) + + + + Gbps + gigabits per second (1000000000 bit/s) + + + + + + + + AUTHOR + + + &dhfirstname; &dhsurname; + + &dhdate + + + + + COPYRIGHT + + Copyright © 2005 &dhusername; + + + + + SEE ALSO + + + oggzdump + 1 + , + + oggzrip + 1 + , + + oggzdiff + 1 + + + + + + + -- GitLab