tshark.pod: fix typo
[metze/wireshark/wip.git] / doc / reordercap.pod
1
2 =head1 NAME
3
4 reordercap - Reorder input file by timestamp into output file
5
6 =head1 SYNOPSIS
7
8 B<reordercap>
9 S<[ B<-n> ]>
10 S<[ B<-v> ]>
11 E<lt>I<infile>E<gt> E<lt>I<outfile>E<gt>
12
13 =head1 DESCRIPTION
14
15 B<Reordercap> is a program that reads an input capture file and rewrites the
16 frames to an output capture file, but with the frames sorted by increasing
17 timestamp.
18
19 This functionality may be useful when capture files have been created by
20 combining frames from more than one well-synchronised source, but the
21 frames have not been combined in strict time order.
22
23 B<Reordercap> writes the output capture file in the same format as the input
24 capture file.
25
26 B<Reordercap> is able to detect, read and write the same capture files that
27 are supported by B<Wireshark>.
28 The input file doesn't need a specific filename extension; the file
29 format and an optional gzip compression will be detected automatically.
30 Near the beginning of the DESCRIPTION section of wireshark(1) or
31 L<https://www.wireshark.org/docs/man-pages/wireshark.html>
32 is a detailed description of the way B<Wireshark> handles this, which is
33 the same way B<reordercap> handles this.
34
35 =head1 OPTIONS
36
37 =over 4
38
39 =item -n
40
41 When the B<-n> option is used, B<reordercap> will not write out the output
42 file if it finds that the input file is already in order.
43
44 =item -v
45
46 Print the version and exit.
47
48 =back
49
50 =head1 SEE ALSO
51
52 pcap(3), wireshark(1), tshark(1), dumpcap(1), editcap(1), mergecap(1),
53 text2pcap(1), pcap-filter(7) or tcpdump(8)
54
55 =head1 NOTES
56
57 B<Reordercap> is part of the B<Wireshark> distribution.  The latest version
58 of B<Wireshark> can be found at L<https://www.wireshark.org>.
59
60 It may make sense to move this functionality into B<editcap>, or perhaps
61 B<mergecap>, in which case B<reordercap> could be retired.
62
63 HTML versions of the Wireshark project man pages are available at:
64 L<https://www.wireshark.org/docs/man-pages>.
65
66 =head1 AUTHORS
67
68   Original Author
69   -------- ------
70   Martin Mathieson             <martin.r.mathieson[AT]googlemail.com>
71