Fix up various product names and descriptions in the lists of file
[obnox/wireshark/wip.git] / doc / mergecap.pod
1
2 =head1 NAME
3
4 mergecap - Merges two capture files into one
5
6 =head1 SYNOPSYS
7
8 B<mergecap>
9 S<[ B<-hva> ]>
10 S<[ B<-s> I<snaplen> ]>
11 S<[ B<-F> I<file format> ]>
12 S<[ B<-T> I<encapsulation type> ]>
13 S<B<-w> I<outfile>>
14 I<infile>
15 I<...>
16
17 =head1 DESCRIPTION
18
19 B<Mergecap> is a program that combines multiple saved capture files into
20 a single output file specified by the B<-w> argument.  B<Mergecap> knows
21 how to read B<libpcap> capture files, including those of B<tcpdump>,
22 B<Ethereal>, and other tools that write captures in that format.  In
23 addition, B<Mergecap> can read capture files from B<snoop> and
24 B<atmsnoop>, Shomiti/Finisar B<Surveyor>, Novell B<LANalyzer>, Network
25 General/Network Associates DOS-based B<Sniffer> (compressed or
26 uncompressed), Microsoft B<Network Monitor>, AIX's B<iptrace>, Cinco
27 Networks B<NetXRay>, Network Associates Windows-based B<Sniffer>, AG
28 Group/WildPackets B<EtherPeek> and B<TokenPeek>, B<RADCOM>'s WAN/LAN
29 analyzer, B<Lucent/Ascend> router debug output, HP-UX's B<nettl>, the
30 dump output from B<Toshiba's> ISDN routers, the output from B<i4btrace>
31 from the ISDN4BSD project, the output in B<IPLog> format from the Cisco
32 Secure Intrusion Detection System, B<pppd logs> (pppdump format), the
33 output from VMS's B<TCPIPtrace> utility, the text output from the B<DBS
34 Etherwatch> VMS utility, and traffic capture files from Visual Networks'
35 Visual UpTime.  There is no need to tell B<Mergecap> what type of file
36 you are reading; it will determine the file type by itself.  B<Mergecap>
37 is also capable of reading any of these file formats if they are
38 compressed using gzip.  B<Mergecap> recognizes this directly from the
39 file; the '.gz' extension is not required for this purpose.
40
41 By default, it writes the capture file in B<libpcap> format, and writes
42 all of the packets in both input capture files to the output file.  The
43 B<-F> flag can be used to specify the format in which to write the
44 capture file; it can write the file in B<libpcap> format (standard
45 B<libpcap> format, a modified format used by some patched versions of
46 B<libpcap>, the format used by Red Hat Linux 6.1, or the format used by
47 SuSE Linux 6.3), B<snoop> format, uncompressed B<Sniffer> format,
48 Microsoft B<Network Monitor> 1.x format, the format used by
49 Windows-based versions of the B<Sniffer> software, and the format used
50 by Visual Networks' software.
51
52 Packets from the input files are merged in chronological order based on
53 each frame's timestamp, unless the B<-a> flag is specified.  B<Mergecap>
54 assumes that frames within a single capture file are already stored in
55 chronological order.  When the B<-a> flag is specified, packets are
56 copied directly from each input file to the output file, independent of
57 each frame's timestamp.
58
59 If the B<-s> flag is used to specify a snapshot length, frames in the
60 input file with more captured data than the specified snapshot length
61 will have only the amount of data specified by the snapshot length
62 written to the output file.  This may be useful if the program that is
63 to read the output file cannot handle packets larger than a certain size
64 (for example, the versions of snoop in Solaris 2.5.1 and Solaris 2.6
65 appear to reject Ethernet frames larger than the standard Ethernet MTU,
66 making them incapable of handling gigabit Ethernet captures if jumbo
67 frames were used).
68
69 The output file frame encapsulation type is set to the type of the input
70 files, if all input files have the same type.  If not all of the input
71 files have the same frame encapsulation type, the output file type is
72 set to WTAP_ENCAP_PER_PACKET.  Note that some capture file formats, most
73 notably B<libpcap>, do not currently support WTAP_ENCAP_PER_PACKET.
74 This combination will cause the output file creation to fail.
75
76 If the B<-T> flag is used to specify a frame encapsulation type, the
77 encapsulation type of the output capture file will be forced to the
78 specified type, rather than being the type appropriate to the
79 encapsulation type of the input capture files.  Note that this merely
80 forces the encapsulation type of the output file to be the specified
81 type; the packet headers of the packets will not be translated from the
82 encapsulation type of the input capture file to the specified
83 encapsulation type (for example, it will not translate an Ethernet
84 capture to an FDDI capture if an Ethernet capture is read and 'B<-T
85 fddi>' is specified).
86
87 =head1 OPTIONS
88
89 =over 4
90
91 =item -w
92
93 Sets the output filename.
94
95 =item -F
96
97 Sets the file format of the output capture file.
98
99 =item -T
100
101 Sets the packet encapsulation type of the output capture file.
102
103 =item -a
104
105 Causes the frame timestamps to be ignored, writing all packets from the
106 first input file followed by all packets from the second input file.  By
107 default, when B<-a> is not specified, the contents of the input files
108 are merged in chronological order based on each frame's timestamp.
109 Note: when merging, B<mergecap> assumes that packets within a capture
110 file are already in chronological order.
111
112 =item -v
113
114 Causes B<mergecap> to print a number of messages while it's working.
115
116 =item -s
117
118 Sets the snapshot length to use when writing the data.
119
120 =item -h
121
122 Prints the version and options and exits.
123
124 =head1 SEE ALSO
125
126 L<tcpdump(8)>, L<pcap(3)>, L<ethereal(1)>, L<editcap(1)>
127
128 =head1 NOTES
129
130 B<Mergecap> is based heavily upon B<editcap> by Richard Sharpe
131 <sharpe@ns.aus.com> and Guy Harris <guy@alum.mit.edu>.
132
133 B<Mergecap> is part of the B<Ethereal> distribution.  The latest version
134 of B<Ethereal> can be found at B<http://www.ethereal.com>.
135
136 =head1 AUTHORS
137
138   Original Author
139   -------- ------
140   Scott Renfro             <scott@renfro.org>
141
142
143   Contributors
144   ------------