Commit c040d52d authored by conrad's avatar conrad

add oggzrip man page


git-svn-id: http://svn.annodex.net/liboggz/trunk@697 8158c8cd-e7e1-0310-9fa4-c5954c97daef
parent 739d9357
......@@ -3,14 +3,14 @@ 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 \
oggzdump.1 oggzdiff.1 oggzmerge.1
oggzdump.1.sgml oggzdiff.1.sgml oggzmerge.1.sgml oggzrip.1.sgml \
oggzdump.1 oggzdiff.1 oggzmerge.1 oggzrip.1
man_MANS = oggzdump.1 oggzdiff.1 oggzmerge.1
man_MANS = oggzdump.1 oggzdiff.1 oggzmerge.1 oggzrip.1
doc_DATA = doxygen-build.stamp
html: oggzdump.1.html oggzdiff.1.html oggzmerge.1.html
html: oggzdump.1.html oggzdiff.1.html oggzmerge.1.html oggzrip.1.html
if HAVE_DOCBOOKTOMAN
%.1: %.1.sgml
......
......@@ -15,7 +15,7 @@
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl \" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
......@@ -87,6 +87,7 @@ 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, Tue 21 Sep 2004, 12:49
.\" created by instant / docbook-to-man, Sat 22 Jan 2005, 13:47
......@@ -131,6 +131,10 @@ manpage.1: manpage.sgml
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>oggzrip</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>oggzdump</refentrytitle>
<manvolnum>1</manvolnum>
......
.\" $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 ] [-h | --help ] filename
.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.
.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 \fBstreamid\fR, --streamid \fBstreamid\fR" 10
Filter by stream-ID, IDs are assigned to
streams in the order of their BOS pages,
starting at 0.
.IP "-c \fBcodec-name\fR --codec-name \fBcodec-name\fR" 10
Filter by codec-name. The following codecs
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, Sat 22 Jan 2005, 14:09
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"[
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > 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 $< > $@
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>David</firstname>">
<!ENTITY dhsurname "<surname>Kuehling</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>January 1, 2005</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>conrad.parker@csiro.au</email>">
<!ENTITY dhusername "CSIRO Australia">
<!ENTITY dhucpackage "<refentrytitle>oggzrip</refentrytitle>">
<!ENTITY dhpackage "oggzrip">
<!ENTITY debian "<productname>Debian GNU/Linux</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
]>
<refentry id="oggzrip">
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2005</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>Extract one or more logical bitstreams from an Ogg file.
</refpurpose>
</refnamediv>
<!-- A warning of
"document type does not allow element "PARAMETER" here"
for all the <parameter> tags in the refsynopsisdiv.
Ignore them as the <parameter> tag still gets interpreted correctly in
the manpage. Deleting the tag however results in non-underlined
-->
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<group>
<arg choice="opt">-o <parameter>filename</parameter></arg>
<arg choice="opt">--output <parameter>filename</parameter></arg>
</group>
<group><arg choice="opt">-h</arg><arg choice="opt">--help</arg></group>
<arg choice="plain">filename</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<command>&dhpackage;</command> extracts one or more logical bitstreams
from an Ogg file.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>
<command>&dhpackage;</command> accepts the following options:
</para>
<refsect2>
<title>Miscellaneous options</title>
<variablelist>
<varlistentry>
<term>-o <parameter>filename</parameter>, --output <parameter>filename</parameter></term>
<listitem><para>Write output to the specified
<parameter>filename</parameter> instead of printing it to
standard output.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-h, --help</term>
<listitem><para>Display usage information and exit.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Filter options</title>
<para>
These options can be used multiple times. Pages matching ANY of
the filter options will be included into the output.
</para>
<variablelist>
<varlistentry>
<term>-s <parameter>serialno</parameter>, --serialno <parameter>serialno</parameter></term>
<listitem><para>Output streams with given serialno.</para></listitem>
</varlistentry>
<varlistentry>
<term>-i <parameter>streamid</parameter>, --streamid <parameter>streamid</parameter></term>
<listitem><para>Filter by stream-ID, IDs are assigned to
streams in the order of their BOS pages,
starting at 0.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-c <parameter>codec-name</parameter> --codec-name <parameter>codec-name</parameter></term>
<listitem><para>Filter by codec-name. The following codecs
are currently detected: "theora",
"vorbis", "speex", "annodex"
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>
<author>
&dhfirstname; &dhsurname;
</author>
&dhdate
</para>
</refsect1>
<refsect1>
<title>COPYRIGHT</title>
<para>
Copyright &copy; 2005 &dhusername;
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>oggzmerge</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>oggzdump</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>oggzdiff</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
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