[cvs-annodex] commit (/annodex): libcmml/trunk/doc/Makefile.am
libcmml/trunk/doc/cmml_dox.h
+libcmml/trunk/doc/cmml-timeshift.1.sgml.in
silvia
nobody at lists.annodex.net
Mon Apr 18 10:59:50 EST 2005
Update of /annodex (new revision 1265)
Added files:
libcmml/trunk/doc/cmml-timeshift.1.sgml.in
Modified files:
libcmml/trunk/doc/Makefile.am
libcmml/trunk/doc/cmml_dox.h
Log Message:
Added documentation for cmml-timeshift.
Modified: libcmml/trunk/doc/Makefile.am
===================================================================
--- libcmml/trunk/doc/Makefile.am 2005-04-17 08:56:24 UTC (rev 1264)
+++ libcmml/trunk/doc/Makefile.am 2005-04-18 00:59:46 UTC (rev 1265)
@@ -38,19 +38,21 @@
cmml_dox.h cmml_2_0.dtd cmml_2_1.dtd \
cmml-validate.1.sgml.in cmml-validate.1 \
cmml-fix.1.sgml.in cmml-fix.1 \
- cmml-fortune.6.sgml.in cmml-fortune.6
+ cmml-fortune.6.sgml.in cmml-fortune.6 \
+ cmml-timeshift.1.sgml.in cmml-timeshift.1
DOXY_INPUT = ${top_srcdir}/src/cmml.h \
${top_srcdir}/tools/cmml-validate.c \
${top_srcdir}/tools/cmml-fix.c \
${top_srcdir}/tools/cmml-fortune.c \
+ $(top_srcdir)/tools/cmml-timeshift.c \
${srcdir}/cmml_dox.h
SUBDIRS = .
if HAVE_DOCBOOKTOMAN
-man_MANS = cmml-validate.1 cmml-fix.1 cmml-fortune.6
+man_MANS = cmml-validate.1 cmml-fix.1 cmml-timeshift.1 cmml-fortune.6
endif
# do not delete - make dist needs it
@@ -91,7 +93,7 @@
%.6.html: %.6.sgml
endif
-html: cmml-validate.1.html cmml-fix.1.html cmml-fortune.6.html
+html: cmml-validate.1.html cmml-fix.1.html cmml-timeshift.1.html cmml-fortune.6.html
all: doxygen-build.stamp
Added: libcmml/trunk/doc/cmml-timeshift.1.sgml.in
===================================================================
--- libcmml/trunk/doc/cmml-timeshift.1.sgml.in 2005-04-17 08:56:24 UTC (rev 1264)
+++ libcmml/trunk/doc/cmml-timeshift.1.sgml.in 2005-04-18 00:59:46 UTC (rev 1265)
@@ -0,0 +1,166 @@
+<!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>Silvia</firstname>">
+ <!ENTITY dhsurname "<surname>Pfeiffer</surname>">
+ <!-- Please adjust the date whenever revising the manpage. -->
+ <!ENTITY dhdate "<date>April 18, 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>silvia.pfeiffer at csiro.au</email>">
+ <!ENTITY dhusername "CSIRO Australia">
+ <!ENTITY dhucpackage "<refentrytitle>cmml-timeshift</refentrytitle>">
+ <!ENTITY dhpackage "cmml-timeshift">
+]>
+
+<refentry id="cmml-timeshift">
+
+ <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>
+ Apply a timeshift to all the clip tags.
+ </refpurpose>
+ </refnamediv>
+
+
+<!-- The warning message
+ "document type does not allow element "PARAMETER" here"
+ is created 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
+ parameters in the man page.
+-->
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>&dhpackage;</command>
+
+ <group>
+ <arg choice="opt">-o <parameter>file</parameter></arg>
+ <arg choice="opt">--output <parameter>file</parameter></arg>
+ </group>
+
+ <group>
+ <arg choice="opt">-s <parameter>offset</parameter></arg>
+ <arg choice="opt">--sec <parameter>offset</parameter></arg>
+ </group>
+
+ <group>
+ <arg choice="opt">-h</arg><arg choice="opt">--help</arg>
+ </group>
+
+ <group>
+ <arg choice="opt">-v</arg><arg choice="opt">--version</arg>
+ </group>
+
+ <arg choice="plain">filename</arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ <command>&dhpackage;</command> parses a CMML instance document
+ given as <parameter>filename</parameter>, applies a timeshift
+ to the start and end times of the clip tags and creates a
+ CMML instance document from it, which gets written to stdout
+ by default. Clip tags that would receive negative start times
+ are skipped. In case of a non-recoverable error upon parsing, the
+ faulty tag including line and column number is reported.
+ </para>
+ </refsect1>
+
+<refsect1>
+ <title>Options</title>
+ <para>
+ <command>&dhpackage;</command> accepts the following options:
+ </para>
+ <variablelist>
+
+ <varlistentry>
+ <term>-o <parameter>file</parameter>, --output <parameter>file</parameter></term>
+ <listitem><para>Output file. Writes fixed CMML document to the
+ given <parameter>file</parameter> instead of stdout, which is the
+ default.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-s <parameter>offset</parameter>, --sec <parameter>offset</parameter></term>
+ <listitem><para>Timeshift offset in seconds. Shifts the start- and
+ endtime of the clip tags by <parameter>offset</parameter> seconds.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-h, --help</term>
+ <listitem><para>Print usage message.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-v, --version</term>
+ <listitem><para>Print version information.</para></listitem>
+ </varlistentry>
+
+ </variablelist>
+</refsect1>
+
+<refsect1>
+ <title>VERSION</title>
+ <para>This man page is correct for CMML version 2.1 and libcmml
+ version @VERSION at .
+ </para>
+</refsect1>
+
+<refsect1>
+ <title>SEE ALSO</title>
+ <para>More information is available at:
+ <ulink url="http://www.annodex.net/">Annodex.net</ulink>
+ </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: libcmml/trunk/doc/cmml_dox.h
===================================================================
--- libcmml/trunk/doc/cmml_dox.h 2005-04-17 08:56:24 UTC (rev 1264)
+++ libcmml/trunk/doc/cmml_dox.h 2005-04-18 00:59:46 UTC (rev 1265)
@@ -47,6 +47,8 @@
* href="cmml_8dtd-example.html">cmml.dtd</a>
* - <a href="cmml-fix_8c.html">cmml-fix</a>, which fixes a sloppily
* written input CMML and creates a valid one if possible
+ * - <a href="cmml-timeshift_8c.html">cmml-timeshift</a>, which
+ * shifts the start and end times of all the clip tags by a second value
* - <a href="cmml-fortune_8c.html">cmml-fortune</a>, which creates a
* valid CMML file with random content
*
--
silvia
More information about the cvs-annodex
mailing list