[xiph-commits] r3556 - liboggz/trunk/doc

[conrad at svn.annodex.net]

Author: conrad
Date: 2008-04-13 17:39:12 -0700 (Sun, 13 Apr 2008)
New Revision: 3556

Modified:
   liboggz/trunk/doc/oggzrip.1.sgml
Log:
add a usage example to oggzrip man page, showing how to create an Ogg Vorbis I
file from any file containing a vorbis audio track. Adapted from:
http://lists.xiph.org/pipermail/vorbis-dev/2008-April/019320.html


Modified: liboggz/trunk/doc/oggzrip.1.sgml
===================================================================
--- liboggz/trunk/doc/oggzrip.1.sgml	2008-04-14 00:08:57 UTC (rev 3555)
+++ liboggz/trunk/doc/oggzrip.1.sgml	2008-04-14 00:39:12 UTC (rev 3556)
@@ -81,9 +81,28 @@
   <refsect1>
     <title>Description</title>
     <para>
-      <command>&dhpackage;</command> extracts one or more logical bitstreams
+      <command>&dhpackage;</command> extracts one or more tracks
       from an Ogg file.
+      In Ogg terminology, <command>&dhpackage;</command> extracts one or
+      more logical bitstreams.
     </para>
+    <para>
+      For example, to extract just the vorbis audio track from any Ogg file:
+    </para>
+    <para><command>oggzrip -c vorbis input.ogx > output.ogg</command>
+    </para>
+    </para>
+
+    <para>
+      This will removed any other tracks: Skeleton, Theora, image, etc.
+      The output will be a valid Ogg Vorbis I file, suitable for use on
+      hardware players that do not support multiplexed (ie. multi-track)
+      Ogg files. If the input file contains multiple Vorbis, the desired
+      once can be specified by serialno with the <command>-s</command>
+      option.
+      Use <command>oggzinfo</command> to view the serialno of
+      each track in a file.
+    </para>
   </refsect1>
   
   <refsect1>
@@ -169,6 +188,10 @@
 	<manvolnum>1</manvolnum>
       </citerefentry>,
       <citerefentry>
+	<refentrytitle>oggz-chop</refentrytitle>
+	<manvolnum>1</manvolnum>
+      </citerefentry>,
+      <citerefentry>
 	<refentrytitle>oggzdump</refentrytitle>
 	<manvolnum>1</manvolnum>
       </citerefentry>,