1
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"[
2
<!-- Process this file with docbook-to-man to generate an nroff manual
3
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
4
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
5
less'. A typical entry in a Makefile or Makefile.am is:
7
manpage.1: manpage.sgml
11
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
12
<!ENTITY dhfirstname "<firstname>Conrad</firstname>">
13
<!ENTITY dhsurname "<surname>Parker</surname>">
14
<!-- Please adjust the date whenever revising the manpage. -->
15
<!ENTITY dhdate "<date>November 17, 2003</date>">
16
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
17
allowed: see man(7), man(1). -->
18
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
19
<!ENTITY dhemail "<email>conrad.parker@csiro.au</email>">
20
<!ENTITY dhusername "CSIRO Australia">
21
<!ENTITY dhucpackage "<refentrytitle>oggzdiff</refentrytitle>">
22
<!ENTITY dhpackage "oggzdiff">
23
<!ENTITY debian "<productname>Debian GNU/Linux</productname>">
24
<!ENTITY gnu "<acronym>GNU</acronym>">
27
<refentry id="oggzdiff">
39
<holder>&dhusername;</holder>
50
<refname>&dhpackage;</refname>
51
<refpurpose>Hexdump the packets of two Ogg files and output differences
56
"document type does not allow element "PARAMETER" here"
57
for all the <parameter> tags in the refsynopsisdiv.
58
Ignore them as the <parameter> tag still gets interpreted correctly in
59
the manpage. Deleting the tag however results in non-underlined
63
<command>&dhpackage;</command>
65
<arg choice="opt">options</arg>
66
<arg choice="opt">OGGZDUMP_OPTIONS</arg>
67
<arg choice="opt">DIFF_OPTIONS</arg>
69
<arg choice="plain">file1.ogg</arg>
70
<arg choice="plain">file2.ogg</arg>
74
<command><parameter>options:</parameter></command>
76
<group><arg choice="opt">--verbose</arg></group>
78
<arg choice="opt">-v</arg><arg choice="opt">--version</arg>
80
<group><arg choice="opt">-h</arg><arg choice="opt">--help</arg></group>
84
<command><parameter>OGGZDUMP_OPTIONS:</parameter></command>
87
<arg choice="opt">-b</arg><arg choice="opt">--binary</arg>
90
<arg choice="opt">-x</arg><arg choice="opt">--hexadecimal</arg>
94
<arg choice="opt">-s serialno</arg>
95
<arg choice="opt">--serialno serialno</arg>
99
<arg choice="opt">-O</arg><arg choice="opt">--hide-offset</arg>
102
<arg choice="opt">-S</arg><arg choice="opt">--hide-serialno</arg>
105
<arg choice="opt">-G</arg><arg choice="opt">--hide-granulepos</arg>
108
<arg choice="opt">-P</arg><arg choice="opt">--hide-packetno</arg>
113
<command><parameter>DIFF_OPTIONS:</parameter></command>
116
<arg choice="opt">-q</arg><arg choice="opt">--brief</arg>
120
<arg choice="opt">-c</arg>
121
<arg choice="opt">-C NUM</arg>
122
<arg choice="opt">--context[=NUM]</arg>
126
<arg choice="opt">-u</arg>
127
<arg choice="opt">-U NUM</arg>
128
<arg choice="opt">--unified[=NUM]</arg>
131
<group><arg choice="opt">-e</arg><arg choice="opt">--ed</arg></group>
132
<group><arg choice="opt">--normal</arg></group>
133
<group><arg choice="opt">--rcs</arg></group>
135
<arg choice="opt">-y</arg><arg choice="opt">--side-by-side</arg>
138
<arg choice="opt">-l</arg><arg choice="opt">--paginate</arg>
146
<title>Description</title>
148
<command>&dhpackage;</command> is a <command>sh</command> script which
149
uses <command>oggzdump</command> to generate hexadecimal packet dumps
150
of each input file, then outputs the difference between these dumps
151
using <command>diff</command>.
156
<title>Options</title>
158
<command>&dhpackage;</command> forwards a subset of options
159
accepted by <command>oggzdump</command> and <command>diff</command>.
162
<refentrytitle>oggzdump</refentrytitle>
163
<manvolnum>1</manvolnum>
166
<refentrytitle>diff</refentrytitle>
167
<manvolnum>1</manvolnum>
168
</citerefentry> for more detail.
172
<title>oggzdump format options</title>
176
<term>-b, --binary</term>
177
<listitem><para>Generate a binary dump of each packet
182
<term>-x, --hexadeciaml</term>
183
<listitem><para>Generate a hexadecimal dump of each packet
191
<title>oggzdump filtering options</title>
195
<term>-s <parameter>serialno</parameter>, --serialno <parameter>serialno</parameter></term>
196
<listitem><para>Dump only the logical bitstream with specified
197
<parameter>serialno</parameter>.
202
<term>-O, --hide-offset</term>
203
<listitem><para>Hide the byte offset field of the preamble for
204
each packet dumped. This is particularly useful when comparing
205
Ogg bitstreams that differ only in page structure.
210
<term>-S, --hide-serialno</term>
211
<listitem><para>Hide the serialno field of the preamble for
212
each packet dumped. This is particularly useful when comparing
213
Ogg bitstreams that differ only in serialno assignment.
218
<term>-G, --hide-granulepos</term>
219
<listitem><para>Hide the granulepos field of the preamble for
225
<term>-P, --hide-packetno</term>
226
<listitem><para>Hide the packetno field of the preamble for
235
<title>diff options</title>
236
<para>The -w (--ignore-all-space) option to <command>diff</command>
243
<term>-q, --brief</term>
244
<listitem><para>Output only whether files differ.
249
<term>-c, -C <parameter>NUM</parameter>, --context[=<parameter>NUM</parameter>]</term>
250
<listitem><para>Output NUM (default 3) lines of copied context.
255
<term>-u, -U <parameter>NUM</parameter>, --unified[=<parameter>NUM</parameter>]</term>
256
<listitem><para>Output NUM (default 3) lines of unified context.
261
<term>-e, --ed</term>
262
<listitem><para>Output an ed script.
267
<term>--normal</term>
268
<listitem><para>Output a normal diff.
274
<listitem><para>Output an RCS format diff.
279
<term>-y, --side-by-side</term>
280
<listitem><para>Output in two columns.
285
<term>-l, --paginate</term>
286
<listitem><para>Pass the output through <command>pr</command> to
297
<title>Miscellaneous options</title>
301
<term>--verbose</term>
303
<para>Display verbose messages.</para>
308
<term>-v, --version</term>
310
<para>Display version information and exit.</para>
315
<term>-h, --help</term>
317
<para>Display usage information and exit.</para>
326
<title>AUTHOR</title>
329
&dhfirstname; &dhsurname;
335
<title>COPYRIGHT</title>
337
Copyright © 2003 &dhusername;
342
<title>SEE ALSO</title>
345
<refentrytitle>oggzdump</refentrytitle>
346
<manvolnum>1</manvolnum>
349
<refentrytitle>diff</refentrytitle>
350
<manvolnum>1</manvolnum>
353
<refentrytitle>patch</refentrytitle>
354
<manvolnum>1</manvolnum>
361
<!-- Keep this comment at the end of the file
366
sgml-minimize-attributes:nil
367
sgml-always-quote-attributes:t
370
sgml-parent-document:nil
371
sgml-default-dtd-file:nil
372
sgml-exposed-tags:nil
373
sgml-local-catalogs:nil
374
sgml-local-ecat-files:nil