[xiph-commits] r3280 - in liboggz/trunk: doc src/tools

conrad at svn.annodex.net conrad at svn.annodex.net
Mon Dec 3 22:02:25 PST 2007


Author: conrad
Date: 2007-12-03 22:02:24 -0800 (Mon, 03 Dec 2007)
New Revision: 3280

Added:
   liboggz/trunk/doc/oggz-comment.1.sgml
Modified:
   liboggz/trunk/doc/Makefile.am
   liboggz/trunk/src/tools/oggz-comment.c
Log:
add a man page for oggz-comment, and update usage info for -s option


Modified: liboggz/trunk/doc/Makefile.am
===================================================================
--- liboggz/trunk/doc/Makefile.am	2007-11-26 03:58:55 UTC (rev 3279)
+++ liboggz/trunk/doc/Makefile.am	2007-12-04 06:02:24 UTC (rev 3280)
@@ -2,7 +2,7 @@
 
 if HAVE_DOCBOOKTOMAN
 man_MANS = oggzdiff.1 oggzdump.1 oggzinfo.1 oggzmerge.1 \
-	oggzrip.1 oggz-scan.1 oggz-validate.1
+	oggzrip.1 oggz-comment.1 oggz-scan.1 oggz-validate.1
 else
 man_MANS =
 check:
@@ -14,14 +14,15 @@
 	forcefeed.fig forcefeed.eps forcefeed.png \
 	hungry.fig hungry.eps hungry.png \
 	oggzdiff.1.sgml oggzdump.1.sgml oggzinfo.1.sgml oggzmerge.1.sgml \
-	oggzrip.1.sgml oggz-scan.1.sgml oggz-validate.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 \
-	oggzrip.1.html oggz-scan.1.html oggz-validate.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-comment.1.sgml
===================================================================
--- liboggz/trunk/doc/oggz-comment.1.sgml	                        (rev 0)
+++ liboggz/trunk/doc/oggz-comment.1.sgml	2007-12-04 06:02:24 UTC (rev 3280)
@@ -0,0 +1,207 @@
+<!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>Kangyuan</firstname>">
+  <!ENTITY dhsurname   "<surname>Niu</surname>">
+  <!-- Please adjust the date whenever revising the manpage. -->
+  <!ENTITY dhdate      "<date>August  5, 2007</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 metadecks.org</email>">
+  <!ENTITY dhusername  "Annodex Association">
+  <!ENTITY dhucpackage "<refentrytitle>oggz-comment</refentrytitle>">
+  <!ENTITY dhpackage   "oggz-comment">
+                                                                                 <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
+  <!ENTITY gnu         "<acronym>GNU</acronym>">
+]>
+
+<refentry id="oggz-comment">
+
+  <refentryinfo>
+    <address>
+      &dhemail;
+    </address>
+    <author>
+      &dhfirstname;
+      &dhsurname;
+    </author>
+    <copyright>
+      <year>2007</year>
+      <holder>&dhusername;</holder>
+    </copyright>
+    &dhdate;
+  </refentryinfo>
+
+  <refmeta>
+    &dhucpackage;
+    &dhsection;
+  </refmeta>
+
+  <refnamediv>
+    <refname>&dhpackage;</refname>
+    <refpurpose>List or edit comments in 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">-l</arg><arg choice="opt">--list</arg></group>
+    </cmdsynopsis>
+
+    <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>serialno</parameter></arg>
+	<arg choice="opt">--serialno <parameter>serialno</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> lists or edits the comments of
+      an Ogg file.
+    </para>
+  </refsect1>
+  
+  <refsect1>
+    <title>Options</title>
+    <para>
+      <command>&dhpackage;</command> accepts the following options:
+    </para>
+
+    <refsect2>
+      <title>Listing options</title>
+      <variablelist>
+	<varlistentry>
+	  <term>-l, --list</term>
+	  <listitem><para>List the comments in the given file.</para></listitem>
+	</varlistentry>
+      </variablelist>
+    </refsect2>
+            
+    <refsect2>
+      <title>Editing options</title>
+      <variablelist>
+	<varlistentry>
+	  <term>-o <parameter>filename</parameter>, --output <parameter>filename</parameter></term>
+	  <listitem><para>Write output to the specified
+	      <parameter>filename</parameter>.
+	    </para></listitem>
+	</varlistentry>
+        <varlistentry>
+          <term>-s <parameter>serialno</parameter>, --serialno <parameter>serialno</parameter></term>
+          <listitem><para>Edit comments of the logical bitstream with
+               specified <parameter>serialno</parameter>.</para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+    <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; 2007 &dhusername;
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>SEE ALSO</title>
+    <para>
+      <citerefentry>
+	<refentrytitle>vorbiscomment</refentrytitle>
+	<manvolnum>1</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+	<refentrytitle>ogginfo</refentrytitle>
+	<manvolnum>1</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+	<refentrytitle>oggzinfo</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:
+-->

Modified: liboggz/trunk/src/tools/oggz-comment.c
===================================================================
--- liboggz/trunk/src/tools/oggz-comment.c	2007-11-26 03:58:55 UTC (rev 3279)
+++ liboggz/trunk/src/tools/oggz-comment.c	2007-12-04 06:02:24 UTC (rev 3280)
@@ -53,9 +53,12 @@
   printf ("\nOutput options\n");
   printf ("  -l, --list            List the comments in the given file.\n");
   printf ("\nEditing options\n");
+  /*printf ("  -a, --all             Edit comments for all logical bitstreams\n");*/
   printf ("  -o filename, --output filename\n");
   printf ("                         Specify output filename\n");
-  printf ("  -s, --set              Set a comment\n");
+  printf ("  -s serialno, --serialno serialno\n");
+  printf ("                         Edit comments of the logical bitstream with\n");
+  printf ("                         specified serialno\n");
   printf ("\nMiscellaneous options\n");
   printf ("  -h, --help             Display this help and exit\n");
   printf ("  -v, --version          Output version information and exit\n");



More information about the commits mailing list