oggz-validate.1.sgml 4.64 KB
Newer Older
conrad's avatar
conrad committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
<!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@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>
86
	<listitem><para>Missing eos packets</para></listitem>
conrad's avatar
conrad committed
87 88 89 90 91 92
	<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
93
      are valid Ogg files, and with status 1 if one or more errors are found.
conrad's avatar
conrad committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
    </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 &copy; 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:
-->