~ubuntu-branches/ubuntu/hoary/liboggz/hoary

« back to all changes in this revision

Viewing changes to doc/oggzdiff.1.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Jamie Wilkinson
  • Date: 2004-04-13 21:48:13 UTC
  • Revision ID: james.westby@ubuntu.com-20040413214813-oq1cjx1n49vvqrcf
Tags: upstream-0.8.2
ImportĀ upstreamĀ versionĀ 0.8.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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:
 
6
 
 
7
manpage.1: manpage.sgml
 
8
        docbook-to-man $< > $@
 
9
  -->
 
10
 
 
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>">
 
25
]>
 
26
 
 
27
<refentry id="oggzdiff">
 
28
 
 
29
  <refentryinfo>
 
30
    <address>
 
31
      &dhemail;
 
32
    </address>
 
33
    <author>
 
34
      &dhfirstname;
 
35
      &dhsurname;
 
36
    </author>
 
37
    <copyright>
 
38
      <year>2003</year>
 
39
      <holder>&dhusername;</holder>
 
40
    </copyright>
 
41
    &dhdate;
 
42
  </refentryinfo>
 
43
 
 
44
  <refmeta>
 
45
    &dhucpackage;
 
46
    &dhsection;
 
47
  </refmeta>
 
48
 
 
49
  <refnamediv>
 
50
    <refname>&dhpackage;</refname>
 
51
    <refpurpose>Hexdump the packets of two Ogg files and output differences
 
52
    </refpurpose>
 
53
  </refnamediv>
 
54
 
 
55
  <!-- A warning of 
 
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 
 
60
  -->
 
61
  <refsynopsisdiv>
 
62
    <cmdsynopsis>
 
63
      <command>&dhpackage;</command>
 
64
 
 
65
      <arg choice="opt">options</arg>
 
66
      <arg choice="opt">OGGZDUMP_OPTIONS</arg>
 
67
      <arg choice="opt">DIFF_OPTIONS</arg>
 
68
 
 
69
      <arg choice="plain">file1.ogg</arg>
 
70
      <arg choice="plain">file2.ogg</arg>
 
71
    </cmdsynopsis>
 
72
 
 
73
    <cmdsynopsis>
 
74
      <command><parameter>options:</parameter></command>
 
75
 
 
76
      <group><arg choice="opt">--verbose</arg></group>
 
77
      <group>
 
78
        <arg choice="opt">-v</arg><arg choice="opt">--version</arg>
 
79
      </group>
 
80
      <group><arg choice="opt">-h</arg><arg choice="opt">--help</arg></group>
 
81
    </cmdsynopsis>
 
82
 
 
83
    <cmdsynopsis>
 
84
      <command><parameter>OGGZDUMP_OPTIONS:</parameter></command>
 
85
      
 
86
      <group>
 
87
        <arg choice="opt">-b</arg><arg choice="opt">--binary</arg>
 
88
      </group>
 
89
      <group>
 
90
        <arg choice="opt">-x</arg><arg choice="opt">--hexadecimal</arg>
 
91
      </group>
 
92
 
 
93
      <group>
 
94
        <arg choice="opt">-s serialno</arg>
 
95
        <arg choice="opt">--serialno serialno</arg>
 
96
      </group>
 
97
 
 
98
      <group>
 
99
        <arg choice="opt">-O</arg><arg choice="opt">--hide-offset</arg>
 
100
      </group>
 
101
      <group>
 
102
        <arg choice="opt">-S</arg><arg choice="opt">--hide-serialno</arg>
 
103
      </group>
 
104
      <group>
 
105
        <arg choice="opt">-G</arg><arg choice="opt">--hide-granulepos</arg>
 
106
      </group>
 
107
      <group>
 
108
        <arg choice="opt">-P</arg><arg choice="opt">--hide-packetno</arg>
 
109
      </group>
 
110
    </cmdsynopsis>
 
111
 
 
112
    <cmdsynopsis>
 
113
      <command><parameter>DIFF_OPTIONS:</parameter></command>
 
114
 
 
115
      <group>
 
116
        <arg choice="opt">-q</arg><arg choice="opt">--brief</arg>
 
117
      </group>
 
118
 
 
119
      <group>
 
120
        <arg choice="opt">-c</arg>
 
121
        <arg choice="opt">-C NUM</arg>
 
122
        <arg choice="opt">--context[=NUM]</arg>
 
123
      </group>
 
124
 
 
125
      <group>
 
126
        <arg choice="opt">-u</arg>
 
127
        <arg choice="opt">-U NUM</arg>
 
128
        <arg choice="opt">--unified[=NUM]</arg>
 
129
      </group>
 
130
 
 
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>
 
134
      <group>
 
135
        <arg choice="opt">-y</arg><arg choice="opt">--side-by-side</arg>
 
136
      </group>
 
137
      <group>
 
138
        <arg choice="opt">-l</arg><arg choice="opt">--paginate</arg>
 
139
      </group>
 
140
    </cmdsynopsis>
 
141
 
 
142
 
 
143
  </refsynopsisdiv>
 
144
    
 
145
  <refsect1>
 
146
    <title>Description</title>
 
147
    <para>
 
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>.
 
152
    </para>
 
153
  </refsect1>
 
154
  
 
155
  <refsect1>
 
156
    <title>Options</title>
 
157
    <para>
 
158
      <command>&dhpackage;</command> forwards a subset of options
 
159
      accepted by <command>oggzdump</command> and <command>diff</command>.
 
160
      See
 
161
      <citerefentry>
 
162
        <refentrytitle>oggzdump</refentrytitle>
 
163
        <manvolnum>1</manvolnum>
 
164
      </citerefentry> and
 
165
      <citerefentry>
 
166
        <refentrytitle>diff</refentrytitle>
 
167
        <manvolnum>1</manvolnum>
 
168
      </citerefentry> for more detail.
 
169
    </para>
 
170
    
 
171
    <refsect2>
 
172
      <title>oggzdump format options</title>
 
173
      <variablelist>
 
174
        
 
175
        <varlistentry>
 
176
          <term>-b, --binary</term>
 
177
          <listitem><para>Generate a binary dump of each packet
 
178
            </para></listitem>
 
179
        </varlistentry>
 
180
 
 
181
        <varlistentry>
 
182
          <term>-x, --hexadeciaml</term>
 
183
          <listitem><para>Generate a hexadecimal dump of each packet
 
184
            </para></listitem>
 
185
        </varlistentry>
 
186
 
 
187
      </variablelist>
 
188
    </refsect2>
 
189
 
 
190
    <refsect2>
 
191
      <title>oggzdump filtering options</title>
 
192
      <variablelist>
 
193
        
 
194
        <varlistentry>
 
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>.
 
198
            </para></listitem>
 
199
        </varlistentry>
 
200
 
 
201
        <varlistentry>
 
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.
 
206
            </para></listitem>
 
207
        </varlistentry>
 
208
 
 
209
        <varlistentry>
 
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.
 
214
            </para></listitem>
 
215
        </varlistentry>
 
216
 
 
217
        <varlistentry>
 
218
          <term>-G, --hide-granulepos</term>
 
219
          <listitem><para>Hide the granulepos field of the preamble for
 
220
              each packet dumped.
 
221
            </para></listitem>
 
222
        </varlistentry>
 
223
 
 
224
        <varlistentry>
 
225
          <term>-P, --hide-packetno</term>
 
226
          <listitem><para>Hide the packetno field of the preamble for
 
227
              each packet dumped.
 
228
            </para></listitem>
 
229
        </varlistentry>
 
230
        
 
231
      </variablelist>
 
232
    </refsect2>
 
233
 
 
234
    <refsect2>
 
235
      <title>diff options</title>
 
236
      <para>The -w (--ignore-all-space) option to <command>diff</command>
 
237
        is always implied.
 
238
      </para>
 
239
 
 
240
      <variablelist>
 
241
 
 
242
        <varlistentry>
 
243
          <term>-q, --brief</term>
 
244
          <listitem><para>Output only whether files differ.
 
245
            </para></listitem>
 
246
        </varlistentry>
 
247
 
 
248
        <varlistentry>
 
249
          <term>-c, -C <parameter>NUM</parameter>, --context[=<parameter>NUM</parameter>]</term>
 
250
          <listitem><para>Output NUM (default 3) lines of copied context.
 
251
            </para></listitem>
 
252
        </varlistentry>
 
253
 
 
254
        <varlistentry>
 
255
          <term>-u, -U <parameter>NUM</parameter>, --unified[=<parameter>NUM</parameter>]</term>
 
256
          <listitem><para>Output NUM (default 3) lines of unified context.
 
257
            </para></listitem>
 
258
        </varlistentry>
 
259
 
 
260
        <varlistentry>
 
261
          <term>-e, --ed</term>
 
262
          <listitem><para>Output an ed script.
 
263
            </para></listitem>
 
264
        </varlistentry>
 
265
 
 
266
        <varlistentry>
 
267
          <term>--normal</term>
 
268
          <listitem><para>Output a normal diff.
 
269
            </para></listitem>
 
270
        </varlistentry>
 
271
 
 
272
        <varlistentry>
 
273
          <term>--rcs</term>
 
274
          <listitem><para>Output an RCS format diff.
 
275
            </para></listitem>
 
276
        </varlistentry>
 
277
 
 
278
        <varlistentry>
 
279
          <term>-y, --side-by-side</term>
 
280
          <listitem><para>Output in two columns.
 
281
            </para></listitem>
 
282
        </varlistentry>
 
283
 
 
284
        <varlistentry>
 
285
          <term>-l, --paginate</term>
 
286
          <listitem><para>Pass the output through <command>pr</command> to
 
287
              paginate it.
 
288
            </para></listitem>
 
289
        </varlistentry>
 
290
 
 
291
        
 
292
 
 
293
      </variablelist>
 
294
    </refsect2>
 
295
 
 
296
    <refsect2>
 
297
      <title>Miscellaneous options</title>
 
298
      <variablelist>
 
299
 
 
300
        <varlistentry>
 
301
          <term>--verbose</term>
 
302
          <listitem>
 
303
            <para>Display verbose messages.</para>
 
304
          </listitem>
 
305
        </varlistentry>
 
306
 
 
307
        <varlistentry>
 
308
          <term>-v, --version</term>
 
309
          <listitem>
 
310
            <para>Display version information and exit.</para>
 
311
          </listitem>
 
312
        </varlistentry>
 
313
 
 
314
        <varlistentry>
 
315
          <term>-h, --help</term>
 
316
          <listitem>
 
317
            <para>Display usage information and exit.</para>
 
318
          </listitem>
 
319
        </varlistentry>
 
320
        
 
321
      </variablelist>
 
322
    </refsect2>
 
323
  </refsect1>
 
324
 
 
325
  <refsect1>
 
326
    <title>AUTHOR</title>
 
327
    <para>
 
328
      <author>
 
329
        &dhfirstname; &dhsurname;
 
330
      </author>
 
331
    </para>
 
332
  </refsect1>
 
333
 
 
334
  <refsect1>
 
335
    <title>COPYRIGHT</title>
 
336
    <para>
 
337
      Copyright &copy; 2003 &dhusername;
 
338
    </para>
 
339
  </refsect1>
 
340
 
 
341
  <refsect1>
 
342
    <title>SEE ALSO</title>
 
343
    <para>
 
344
      <citerefentry>
 
345
        <refentrytitle>oggzdump</refentrytitle>
 
346
        <manvolnum>1</manvolnum>
 
347
      </citerefentry>,
 
348
      <citerefentry>
 
349
        <refentrytitle>diff</refentrytitle>
 
350
        <manvolnum>1</manvolnum>
 
351
      </citerefentry>,
 
352
      <citerefentry>
 
353
        <refentrytitle>patch</refentrytitle>
 
354
        <manvolnum>1</manvolnum>
 
355
      </citerefentry>
 
356
    </para>
 
357
  </refsect1>
 
358
 
 
359
</refentry>
 
360
 
 
361
<!-- Keep this comment at the end of the file
 
362
Local variables:
 
363
mode: sgml
 
364
sgml-omittag:t
 
365
sgml-shorttag:t
 
366
sgml-minimize-attributes:nil
 
367
sgml-always-quote-attributes:t
 
368
sgml-indent-step:2
 
369
sgml-indent-data: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
 
375
End:
 
376
-->