[cvs-annodex] commit (/annodex): liboggz/trunk/doc/Makefile.am
+liboggz/trunk/doc/oggz-validate.1
+liboggz/trunk/doc/oggz-validate.1.sgml
conrad
nobody at lists.annodex.net
Mon Apr 4 08:31:05 EST 2005
Update of /annodex (new revision 1209)
Added files:
liboggz/trunk/doc/oggz-validate.1
liboggz/trunk/doc/oggz-validate.1.sgml
Modified files:
liboggz/trunk/doc/Makefile.am
Log Message:
add oggz-validate man page
Modified: liboggz/trunk/doc/Makefile.am
===================================================================
--- liboggz/trunk/doc/Makefile.am 2005-04-03 22:00:09 UTC (rev 1208)
+++ liboggz/trunk/doc/Makefile.am 2005-04-03 22:31:03 UTC (rev 1209)
@@ -4,14 +4,14 @@
forcefeed.fig forcefeed.eps forcefeed.png \
hungry.fig hungry.eps hungry.png \
oggzdump.1.sgml oggzdiff.1.sgml oggzmerge.1.sgml \
- oggzrip.1.sgml oggzinfo.1.sgml \
- oggzdump.1 oggzdiff.1 oggzmerge.1 oggzrip.1 oggzinfo.1
+ oggzrip.1.sgml oggzinfo.1.sgml oggz-validate.1.sgml \
+ oggzdump.1 oggzdiff.1 oggzmerge.1 oggzrip.1 oggzinfo.1 oggz-validate.1
-man_MANS = oggzdump.1 oggzdiff.1 oggzmerge.1 oggzrip.1 oggzinfo.1
+man_MANS = oggzdump.1 oggzdiff.1 oggzmerge.1 oggzrip.1 oggzinfo.1 oggz-validate.1
doc_DATA = doxygen-build.stamp
-html: oggzdump.1.html oggzdiff.1.html oggzmerge.1.html oggzrip.1.html oggzinfo.1.html
+html: oggzdump.1.html oggzdiff.1.html oggzmerge.1.html oggzrip.1.html oggzinfo.1.html oggz-validate.1.html
if HAVE_DOCBOOKTOMAN
%.1: %.1.sgml
Added: liboggz/trunk/doc/oggz-validate.1
===================================================================
--- liboggz/trunk/doc/oggz-validate.1 2005-04-03 22:00:09 UTC (rev 1208)
+++ liboggz/trunk/doc/oggz-validate.1 2005-04-03 22:31:03 UTC (rev 1209)
@@ -0,0 +1,105 @@
+.\" $Header: /aolnet/dev/src/CVS/sgml/docbook-to-man/cmd/docbook-to-man.sh,v 1.1.1.1 1998/11/13 21:31:59 db3l Exp $
+.\"
+.\" transcript compatibility for postscript use.
+.\"
+.\" synopsis: .P! <file.ps>
+.\"
+.de P!
+.fl
+\!!1 setgray
+.fl
+\\&.\"
+.fl
+\!!0 setgray
+.fl \" force out current output buffer
+\!!save /psv exch def currentpoint translate 0 0 moveto
+\!!/showpage{}def
+.fl \" prolog
+.sy sed \-e 's/^/!/' \\$1\" bring in postscript file
+\!!psv restore
+.
+.de pF
+.ie \\*(f1 .ds f1 \\n(.f
+.el .ie \\*(f2 .ds f2 \\n(.f
+.el .ie \\*(f3 .ds f3 \\n(.f
+.el .ie \\*(f4 .ds f4 \\n(.f
+.el .tm ? font overflow
+.ft \\$1
+..
+.de fP
+.ie !\\*(f4 \{\
+. ft \\*(f4
+. ds f4\"
+' br \}
+.el .ie !\\*(f3 \{\
+. ft \\*(f3
+. ds f3\"
+' br \}
+.el .ie !\\*(f2 \{\
+. ft \\*(f2
+. ds f2\"
+' br \}
+.el .ie !\\*(f1 \{\
+. ft \\*(f1
+. ds f1\"
+' br \}
+.el .tm ? font underflow
+..
+.ds f1\"
+.ds f2\"
+.ds f3\"
+.ds f4\"
+'\" t
+.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
+.TH "oggz-validate" "1"
+.SH "NAME"
+oggz-validate \(em Validate the Ogg framing of one or more files
+
+.SH "SYNOPSIS"
+.PP
+\fBoggz-validate \fRfilename \&...
+.PP
+\fBoggz-validate\fR [-h | --help ] [-v | --version ]
+.SH "Description"
+.PP
+\fBoggz-validate\fR validates the Ogg framing of one or more
+Ogg files.
+.PP
+\fBoggz-validate\fR detects the following errors
+in Ogg framing:
+
+.IP " \(bu" 6
+Packet out of order
+.IP " \(bu" 6
+Multiple bos packets
+.IP " \(bu" 6
+Multiple eos packets
+.IP " \(bu" 6
+Packet belongs to unknown serialno
+.IP " \(bu" 6
+Granulepos decreasing within track
+.PP
+\fBoggz-validate\fR exits with status 0 if all files
+are valid, and with status 1 if one or more errors are found.
+
+.SH "Options"
+.PP
+\fBoggz-validate\fR accepts the following options:
+
+.SS "Miscellaneous options"
+.IP "-h, --help" 10
+Display usage information and exit.
+.IP "-v, --version" 10
+Output version information and exit.
+.SH "AUTHOR"
+.PP
+Conrad Parker April 3, 2005;
+.SH "COPYRIGHT"
+.PP
+Copyright \(co 2005 CSIRO Australia
+
+.SH "SEE ALSO"
+.PP
+\fBoggzdump\fP\fB(1)\fP,
+\fBoggzinfo\fP\fB(1)\fP
+.\" created by instant / docbook-to-man, Mon 04 Apr 2005, 08:26
Added: liboggz/trunk/doc/oggz-validate.1.sgml
===================================================================
--- liboggz/trunk/doc/oggz-validate.1.sgml 2005-04-03 22:00:09 UTC (rev 1208)
+++ liboggz/trunk/doc/oggz-validate.1.sgml 2005-04-03 22:31:03 UTC (rev 1209)
@@ -0,0 +1,169 @@
+<!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>April 3, 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>conrad.parker at csiro.au</email>">
+ <!ENTITY dhusername "CSIRO Australia">
+ <!ENTITY dhucpackage "<refentrytitle>oggz-validate</refentrytitle>">
+ <!ENTITY dhpackage "oggz-validate">
+ <!ENTITY debian "<productname>Debian GNU/Linux</productname>">
+ <!ENTITY gnu "<acronym>GNU</acronym>">
+]>
+
+<refentry id="oggz-validate">
+
+ <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>Validate the Ogg framing of one or more 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" rep="repeat">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> validates the Ogg framing of one or more
+ Ogg files.</para>
+ <para><command>&dhpackage;</command> detects the following errors
+ in Ogg framing:
+ <itemizedlist>
+ <listitem>Packet out of order</listitem>
+ <listitem><para>Multiple bos packets</para></listitem>
+ <listitem><para>Multiple eos packets</para></listitem>
+ <listitem><para>Packet belongs to unknown serialno</para></listitem>
+ <listitem><para>Granulepos decreasing within track</para></lisitem>
+ </itemizedlist>
+ </para>
+ <para>
+ <command>&dhpackage;</command> exits with status 0 if all files
+ are valid, and with status 1 if one or more errors are found.
+ </para>
+ </refsect1>
+
+ <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 © 2005 &dhusername;
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>SEE ALSO</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>oggzdump</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>oggzinfo</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:
+-->
--
conrad
More information about the cvs-annodex
mailing list