Commit 5a8628ec authored by conrad's avatar conrad

add oggz.1 man page

parent a8ea2f18
docdir=$(prefix)/share/doc/@PACKAGE@
if HAVE_DOCBOOKTOMAN
man_MANS = oggz-diff.1 oggz-dump.1 oggz-info.1 oggz-known-codecs.1 oggz-merge.1 oggz-chop.1 \
man_MANS = oggz.1 oggz-diff.1 oggz-dump.1 oggz-info.1 oggz-known-codecs.1 oggz-merge.1 oggz-chop.1 \
oggz-sort.1 oggz-rip.1 oggz-comment.1 oggz-scan.1 oggz-validate.1
else
man_MANS =
......@@ -13,7 +13,7 @@ endif
EXTRA_DIST = $(man_MANS) Doxyfile.in \
forcefeed.fig forcefeed.eps forcefeed.png \
hungry.fig hungry.eps hungry.png \
oggz-diff.1.sgml oggz-dump.1.sgml oggz-info.1.sgml oggz-known-codecs.1.sgml oggz-merge.1.sgml \
oggz.1.sgml oggz-diff.1.sgml oggz-dump.1.sgml oggz-info.1.sgml oggz-known-codecs.1.sgml oggz-merge.1.sgml \
oggz-chop.1.sgml oggz-sort.1.sgml oggz-rip.1.sgml oggz-comment.1.sgml \
oggz-scan.1.sgml oggz-validate.1.sgml
......
<!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>Conrad</firstname>">
<!ENTITY dhsurname "<surname>Parker</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>July 9, 2008</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@annodex.net</email>">
<!ENTITY dhusername "Annodex Association">
<!ENTITY dhucpackage "<refentrytitle>oggz</refentrytitle>">
<!ENTITY dhpackage "oggz">
<!ENTITY debian "<productname>Debian GNU/Linux</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
]>
<refentry id="oggz">
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2008</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>inspect and manipulate Ogg multimedia files
</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>
<arg choice="plain">help <parameter>command</parameter></arg>
<arg choice="plain">command <parameter choice="opt">args</parameter></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<command>&dhpackage;</command> is a suite of tools for manipulating
Ogg multimedia files.
It supports multiplexed files conformant with RFC3533. Oggz can parse headers for
CELT, CMML, Dirac, FLAC, Kate, PCM, Speex, Theora and Vorbis, and can read and write
Ogg Skeleton logical bitstreams.
</para>
</refsect1>
<refsect1>
<title>Commands</title>
<itemizedlist>
<listitem>
<command>help</command>
Display help for a specific subcommand (eg. "oggz help chop")
</listitem>
</itemizedlist>
<refsect2>
<title>Reporting</title>
<itemizedlist>
<listitem>
<command>diff</command>
Hexdump the packets of two Ogg files and output differences.
</listitem>
<listitem>
<command>dump</command>
Hexdump packets of an Ogg file, or revert an Ogg file from such a hexdump.
</listitem>
<listitem>
<command>info</command>
Display information about one or more Ogg files and their bitstreams.
</listitem>
<listitem>
<command>scan</command>
Scan an Ogg file and output characteristic landmarks.
</listitem>
<listitem>
<command>validate</command>
Validate the Ogg framing of one or more files.
</listitem>
</itemizedlist>
</refsect2>
<refsect2>
<title>Extraction</title>
<itemizedlist>
<listitem>
<command>rip</command>
Extract one or more logical bitstreams from an Ogg file.
</listitem>
</itemizedlist>
</refsect2>
<refsect2>
<title>Editing</title>
<itemizedlist>
<listitem>
<command>chop</command>
Extract the part of an Ogg file between given start and/or end times.
</listitem>
<listitem>
<command>comment</command>
List or edit comments in an Ogg file.
<listitem>
<command>merge</command>
Merge Ogg files together, interleaving pages in order of presentation time.
</listitem>
<listitem>
<command>sort</command>
Sort the pages of an Ogg file in order of presentation time.
</listitem>
</itemizedlist>
</refsect2>
<refsect1>
<title>Options</title>
<para>
<command>&dhpackage;</command> accepts the following options:
</para>
<refsect2>
<title>Miscellaneous options</title>
<variablelist>
<varlistentry>
<term>-h, --help</term>
<listitem><para>Display usage information and exit.</para></listitem>
</varlistentry>
<varlistentry>
<term>-v, --version</term>
<listitem><para>Output version information and exit.</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; 2008 &dhusername;
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>ogginfo</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
<citerefentry>
<refentrytitle>hogg</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