[xiph-commits] r3495 - liboggz/trunk/doc
conrad at svn.annodex.net
conrad at svn.annodex.net
Mon Feb 25 22:35:22 PST 2008
Author: conrad
Date: 2008-02-25 22:35:22 -0800 (Mon, 25 Feb 2008)
New Revision: 3495
Added:
liboggz/trunk/doc/oggz-chop.1.sgml
Modified:
liboggz/trunk/doc/Makefile.am
Log:
add a man page for oggz-chop
Modified: liboggz/trunk/doc/Makefile.am
===================================================================
--- liboggz/trunk/doc/Makefile.am 2008-02-26 06:16:24 UTC (rev 3494)
+++ liboggz/trunk/doc/Makefile.am 2008-02-26 06:35:22 UTC (rev 3495)
@@ -1,8 +1,8 @@
docdir=$(prefix)/share/doc/@PACKAGE@
if HAVE_DOCBOOKTOMAN
-man_MANS = oggzdiff.1 oggzdump.1 oggzinfo.1 oggzmerge.1 oggz-sort.1 \
- oggzrip.1 oggz-comment.1 oggz-scan.1 oggz-validate.1
+man_MANS = oggzdiff.1 oggzdump.1 oggzinfo.1 oggzmerge.1 oggz-chop.1 \
+ oggz-sort.1 oggzrip.1 oggz-comment.1 oggz-scan.1 oggz-validate.1
else
man_MANS =
check:
@@ -14,16 +14,16 @@
forcefeed.fig forcefeed.eps forcefeed.png \
hungry.fig hungry.eps hungry.png \
oggzdiff.1.sgml oggzdump.1.sgml oggzinfo.1.sgml oggzmerge.1.sgml \
- oggz-sort.1.sgml oggzrip.1.sgml oggz-comment.1.sgml oggz-scan.1.sgml \
- oggz-validate.1.sgml
+ oggz-chop.1.sgml oggz-sort.1.sgml oggzrip.1.sgml oggz-comment.1.sgml \
+ oggz-scan.1.sgml oggz-validate.1.sgml
# ensure doxygen-build.stamp is included, or else the documentation will
# not be built or distributed
noinst_DATA = doxygen-build.stamp
html: oggzdiff.1.html oggzdump.1.html oggzinfo.1.html oggzmerge.1.html \
- oggz-sort.1.html oggzrip.1.html oggz-comment.1.html oggz-scan.1.html \
- oggz-validate.1.html
+ oggz-chop.1.html oggz-sort.1.html oggzrip.1.html oggz-comment.1.html \
+ oggz-scan.1.html oggz-validate.1.html
if HAVE_DOCBOOKTOMAN
%.1: %.1.sgml
Added: liboggz/trunk/doc/oggz-chop.1.sgml
===================================================================
--- liboggz/trunk/doc/oggz-chop.1.sgml (rev 0)
+++ liboggz/trunk/doc/oggz-chop.1.sgml 2008-02-26 06:35:22 UTC (rev 3495)
@@ -0,0 +1,215 @@
+<!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>January 25, 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 at annodex.net</email>">
+ <!ENTITY dhusername "Annodex Association">
+ <!ENTITY dhucpackage "<refentrytitle>oggz-chop</refentrytitle>">
+ <!ENTITY dhpackage "oggz-chop">
+ <!ENTITY debian "<productname>Debian GNU/Linux</productname>">
+ <!ENTITY gnu "<acronym>GNU</acronym>">
+]>
+
+<refentry id="oggz-chop">
+
+ <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>Chop 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">-s <parameter>start_time</parameter></arg>
+ <arg choice="opt">--start <parameter>start_time</parameter></arg>
+ </group>
+
+ <group>
+ <arg choice="opt">-e <parameter>end_time</parameter></arg>
+ <arg choice="opt">--end <parameter>end_time</parameter></arg>
+ </group>
+
+ <arg choice="plain">filename</arg>
+ </cmdsynopsis>
+
+ <cmdsynopsis>
+ <command>&dhpackage;</command>
+ <group><arg choice="opt">-h</arg><arg choice="opt">--help</arg></group>
+ <group><arg choice="opt">-v</arg><arg choice="opt">--version</arg></group>
+ </cmdsynopsis>
+
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ <command>&dhpackage;</command> chops a section of an Ogg file.
+ It correctly interprets the granulepos timestamps of Ogg Vorbis, Speex,
+ FLAC and Theora bitstreams, and all bitstreams of Annodex files.
+ </para>
+ <para>
+ The output file contains copies of the headers of the input file, and
+ all the codec data required to correctly decode the content between the
+ start and end times specified on the commandline. For codecs with data
+ dependencies like video keyframes, the keyframe prior to the starting
+ time will be included in the output.
+ </para>
+ <para>
+ Note that <command>&dhpackage</command> operates by copying pages of
+ Ogg data; it does not strip partial packets from the first or last
+ data page included in the output. It does however ensure to set the
+ end of stream flag on the last page of each logical bitstream.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+ <para>
+ <command>&dhpackage;</command> accepts the following options:
+ </para>
+
+ <refsect2>
+ <title>Output 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>-s <parameter>start_time</parameter>, --start <parameter>start_time</parameter></term>
+ <listitem><para>Specify the start time of the chopped section to output.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-e <parameter>end_time</parameter>, --end <parameter>end_time</parameter></term>
+ <listitem><para>Specify the end time of the chopped section to output.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <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 © 2008 &dhusername;
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>SEE ALSO</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>oggz-validate</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>oggzmerge</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>oggzdump</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:
+-->
More information about the commits
mailing list