oggzdiff.1.sgml 10.1 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 86 87 88 89 90 91 92
<!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>November 17, 2003</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>oggzdiff</refentrytitle>">
  <!ENTITY dhpackage   "oggzdiff">
                                                                                 <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry id="oggzdiff">

  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2003</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>

  <refmeta>
    &dhucpackage;
    &dhsection;
  </refmeta>

  <refnamediv>
    <refname>&dhpackage;</refname>
    <refpurpose>Hexdump the packets of two Ogg files and output differences
    </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="opt">options</arg>
      <arg choice="opt">OGGZDUMP_OPTIONS</arg>
      <arg choice="opt">DIFF_OPTIONS</arg>

      <arg choice="plain">file1.ogg</arg>
      <arg choice="plain">file2.ogg</arg>
    </cmdsynopsis>

    <cmdsynopsis>
      <command><parameter>options:</parameter></command>

      <group><arg choice="opt">--verbose</arg></group>
      <group>
	<arg choice="opt">-v</arg><arg choice="opt">--version</arg>
      </group>
      <group><arg choice="opt">-h</arg><arg choice="opt">--help</arg></group>
    </cmdsynopsis>

    <cmdsynopsis>
      <command><parameter>OGGZDUMP_OPTIONS:</parameter></command>
      
      <group>
	<arg choice="opt">-b</arg><arg choice="opt">--binary</arg>
      </group>
      <group>
	<arg choice="opt">-x</arg><arg choice="opt">--hexadecimal</arg>
      </group>

93 94 95 96 97
      <group>
	<arg choice="opt">-c content-type</arg>
	<arg choice="opt">--content-type content-type</arg>
      </group>

conrad's avatar
conrad committed
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 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
      <group>
	<arg choice="opt">-s serialno</arg>
	<arg choice="opt">--serialno serialno</arg>
      </group>

      <group>
	<arg choice="opt">-O</arg><arg choice="opt">--hide-offset</arg>
      </group>
      <group>
	<arg choice="opt">-S</arg><arg choice="opt">--hide-serialno</arg>
      </group>
      <group>
	<arg choice="opt">-G</arg><arg choice="opt">--hide-granulepos</arg>
      </group>
      <group>
	<arg choice="opt">-P</arg><arg choice="opt">--hide-packetno</arg>
      </group>
    </cmdsynopsis>

    <cmdsynopsis>
      <command><parameter>DIFF_OPTIONS:</parameter></command>

      <group>
	<arg choice="opt">-q</arg><arg choice="opt">--brief</arg>
      </group>

      <group>
	<arg choice="opt">-C NUM</arg>
	<arg choice="opt">--context[=NUM]</arg>
      </group>

      <group>
	<arg choice="opt">-u</arg>
	<arg choice="opt">-U NUM</arg>
	<arg choice="opt">--unified[=NUM]</arg>
      </group>

      <group><arg choice="opt">-e</arg><arg choice="opt">--ed</arg></group>
      <group><arg choice="opt">--normal</arg></group>
      <group><arg choice="opt">--rcs</arg></group>
      <group>
	<arg choice="opt">-y</arg><arg choice="opt">--side-by-side</arg>
      </group>
      <group>
	<arg choice="opt">-l</arg><arg choice="opt">--paginate</arg>
      </group>
    </cmdsynopsis>


  </refsynopsisdiv>
    
  <refsect1>
    <title>Description</title>
    <para>
      <command>&dhpackage;</command> is a <command>sh</command> script which
      uses <command>oggzdump</command> to generate hexadecimal packet dumps
      of each input file, then outputs the difference between these dumps
      using <command>diff</command>.
    </para>
  </refsect1>
  
  <refsect1>
    <title>Options</title>
    <para>
      <command>&dhpackage;</command> forwards a subset of options
      accepted by <command>oggzdump</command> and <command>diff</command>.
      See
      <citerefentry>
	<refentrytitle>oggzdump</refentrytitle>
	<manvolnum>1</manvolnum>
      </citerefentry> and
      <citerefentry>
	<refentrytitle>diff</refentrytitle>
	<manvolnum>1</manvolnum>
      </citerefentry> for more detail.
    </para>
    
    <refsect2>
      <title>oggzdump format options</title>
      <variablelist>
	
	<varlistentry>
	  <term>-b, --binary</term>
	  <listitem><para>Generate a binary dump of each packet
	    </para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>-x, --hexadeciaml</term>
	  <listitem><para>Generate a hexadecimal dump of each packet
	    </para></listitem>
	</varlistentry>

      </variablelist>
    </refsect2>

    <refsect2>
      <title>oggzdump filtering options</title>
      <variablelist>
	
198 199 200 201 202 203 204 205
	<varlistentry>
	  <term>-c <parameter>content-type</parameter>, --content-type <parameter>content-type</parameter></term>
	  <listitem><para>Dump only the logical bitstreams for a specific
	      <parameter>content-type</parameter>. The following codec names
	      are currently detected: "theora", "vorbis", "speex", "cmml"
	    </para></listitem>
	</varlistentry>

conrad's avatar
conrad committed
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
	<varlistentry>
	  <term>-s <parameter>serialno</parameter>, --serialno <parameter>serialno</parameter></term>
	  <listitem><para>Dump only the logical bitstream with specified
	      <parameter>serialno</parameter>.
	    </para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>-O, --hide-offset</term>
	  <listitem><para>Hide the byte offset field of the preamble for
	      each packet dumped. This is particularly useful when comparing
	      Ogg bitstreams that differ only in page structure.
	    </para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>-S, --hide-serialno</term>
	  <listitem><para>Hide the serialno field of the preamble for
	      each packet dumped. This is particularly useful when comparing
	      Ogg bitstreams that differ only in serialno assignment.
	    </para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>-G, --hide-granulepos</term>
	  <listitem><para>Hide the granulepos field of the preamble for
	      each packet dumped.
	    </para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>-P, --hide-packetno</term>
	  <listitem><para>Hide the packetno field of the preamble for
	      each packet dumped.
	    </para></listitem>
	</varlistentry>
	
      </variablelist>
    </refsect2>

    <refsect2>
      <title>diff options</title>
      <para>The -w (--ignore-all-space) option to <command>diff</command>
	is always implied.
      </para>

      <variablelist>

	<varlistentry>
	  <term>-q, --brief</term>
	  <listitem><para>Output only whether files differ.
	    </para></listitem>
	</varlistentry>

	<varlistentry>
261 262
	  <term>-C <parameter>NUM</parameter>, --context[=<parameter>NUM</parameter>]</term>
	  <listitem><para>Output NUM lines of copied context.
conrad's avatar
conrad committed
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
	    </para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>-u, -U <parameter>NUM</parameter>, --unified[=<parameter>NUM</parameter>]</term>
	  <listitem><para>Output NUM (default 3) lines of unified context.
	    </para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>-e, --ed</term>
	  <listitem><para>Output an ed script.
	    </para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>--normal</term>
	  <listitem><para>Output a normal diff.
	    </para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>--rcs</term>
	  <listitem><para>Output an RCS format diff.
	    </para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>-y, --side-by-side</term>
	  <listitem><para>Output in two columns.
	    </para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>-l, --paginate</term>
	  <listitem><para>Pass the output through <command>pr</command> to
	      paginate it.
	    </para></listitem>
	</varlistentry>

	

      </variablelist>
    </refsect2>

    <refsect2>
      <title>Miscellaneous options</title>
      <variablelist>

	<varlistentry>
	  <term>--verbose</term>
	  <listitem>
	    <para>Display verbose messages.</para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term>-v, --version</term>
	  <listitem>
	    <para>Display version information and exit.</para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term>-h, --help</term>
	  <listitem>
	    <para>Display usage information and exit.</para>
	  </listitem>
	</varlistentry>
	
      </variablelist>
    </refsect2>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
    <para>
      <author>
	&dhfirstname; &dhsurname;
      </author>
    </para>
  </refsect1>

  <refsect1>
    <title>COPYRIGHT</title>
    <para>
      Copyright &copy; 2003 &dhusername;
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
	<refentrytitle>oggzdump</refentrytitle>
	<manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>diff</refentrytitle>
	<manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>patch</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:
-->