Update to the FreeRADIUS version.
[metze/wireshark/wip.git] / doc / mergecap.pod
index 34937a0f457d86ed45f306814183fc9651c69b6d..671c5c68f61d49bfbca0d5840b4881b94424b588 100644 (file)
@@ -9,9 +9,10 @@ B<mergecap>
 S<[ B<-a> ]>
 S<[ B<-F> E<lt>I<file format>E<gt> ]>
 S<[ B<-h> ]>
+S<[ B<-I> E<lt>I<IDB merge mode>E<gt> ]>
 S<[ B<-s> E<lt>I<snaplen>E<gt> ]>
-S<[ B<-T> E<lt>I<encapsulation type>E<gt> ]>
 S<[ B<-v> ]>
+S<[ B<-V> ]>
 S<B<-w> E<lt>I<outfile>E<gt>|->
 E<lt>I<infile>E<gt> [E<lt>I<infile>E<gt> I<...>]
 
@@ -19,10 +20,10 @@ E<lt>I<infile>E<gt> [E<lt>I<infile>E<gt> I<...>]
 
 B<Mergecap> is a program that combines multiple saved capture files into
 a single output file specified by the B<-w> argument.  B<Mergecap> knows
-how to read B<libpcap> capture files, including those of B<tcpdump>,
+how to read B<pcap> capture files, including those of B<tcpdump>,
 B<Wireshark>, and other tools that write captures in that format.
 
-By default, B<Mergecap> writes the capture file in B<libpcap> format, and writes
+By default, B<Mergecap> writes the capture file in B<pcap> format, and writes
 all of the packets from the input capture files to the output file.
 
 B<Mergecap> is able to detect, read and write the same capture files that
@@ -30,7 +31,7 @@ are supported by B<Wireshark>.
 The input files don't need a specific filename extension; the file
 format and an optional gzip compression will be automatically detected.
 Near the beginning of the DESCRIPTION section of wireshark(1) or
-L<http://www.wireshark.org/docs/man-pages/wireshark.html>
+L<https://www.wireshark.org/docs/man-pages/wireshark.html>
 is a detailed description of the way B<Wireshark> handles this, which is
 the same way B<Mergecap> handles this.
 
@@ -50,7 +51,7 @@ The output file frame encapsulation type is set to the type of the input
 files if all input files have the same type.  If not all of the input
 files have the same frame encapsulation type, the output file type is
 set to WTAP_ENCAP_PER_PACKET.  Note that some capture file formats, most
-notably B<libpcap>, do not currently support WTAP_ENCAP_PER_PACKET.
+notably B<pcap>, do not currently support WTAP_ENCAP_PER_PACKET.
 This combination will cause the output file creation to fail.
 
 =head1 OPTIONS
@@ -78,6 +79,28 @@ first input file.
 
 Prints the version and options and exits.
 
+=item -I  E<lt>IDB merge modeE<gt>
+
+Sets the Interface Description Block (IDB) merge mode to use during merging.
+B<mergecap -I> provides a list of the available IDB merge modes.
+
+Every input file has one or more IDBs, which describe the interface(s) the
+capture was performed on originally. This includes encapsulation type,
+interface name, etc. When mergecap merges multiple input files, it has to
+merge these IDBs somehow for the new merged output file. This flag controls
+how that is accomplished. The currently available modes are:
+
+ * 'B<none>': no merging of IDBs is performed, and instead all IDBs are
+              copied to the merged output file.
+ * 'B<all>':  IDBs are merged only if all input files have the same number
+              of IDBs, and each IDB matches their respective entry in the
+              other files. This is the default mode.
+ * 'B<any>':  Any and all duplicate IDBs are merged into one IDB, regardless
+              of what file they are in.
+
+Note that an IDB is only considered a matching duplicate if it has the same
+encapsulation type, name, speed, time precision, comments, description, etc.
+
 =item -s  E<lt>snaplenE<gt>
 
 Sets the snapshot length to use when writing the data.
@@ -95,27 +118,15 @@ frames were used).
 
 Causes B<mergecap> to print a number of messages while it's working.
 
+=item -V
+
+Print the version and exit.
+
 =item -w  E<lt>outfileE<gt>|-
 
 Sets the output filename. If the name is 'B<->', stdout will be used.
 This setting is mandatory.
 
-=item -T  E<lt>encapsulation typeE<gt>
-
-Sets the packet encapsulation type of the output capture file.
-If the B<-T> flag is used to specify a frame encapsulation type, the
-encapsulation type of the output capture file will be forced to the
-specified type, rather than being the type appropriate to the
-encapsulation type of the input capture files.
-
-Note that this merely
-forces the encapsulation type of the output file to be the specified
-type; the packet headers of the packets will not be translated from the
-encapsulation type of the input capture file to the specified
-encapsulation type (for example, it will not translate an Ethernet
-capture to an FDDI capture if an Ethernet capture is read and 'B<-T
-fddi>' is specified).
-
 =back
 
 =head1 EXAMPLES
@@ -134,7 +145,7 @@ seconds.)
 =head1 SEE ALSO
 
 pcap(3), wireshark(1), tshark(1), dumpcap(1), editcap(1), text2pcap(1),
-pcap-filter(7) or tcpdump(8) if it doesn't exist.
+pcap-filter(7) or tcpdump(8)
 
 =head1 NOTES
 
@@ -142,10 +153,10 @@ B<Mergecap> is based heavily upon B<editcap> by Richard Sharpe
 <sharpe[AT]ns.aus.com> and Guy Harris <guy[AT]alum.mit.edu>.
 
 B<Mergecap> is part of the B<Wireshark> distribution.  The latest version
-of B<Wireshark> can be found at L<http://www.wireshark.org>.
+of B<Wireshark> can be found at L<https://www.wireshark.org>.
 
 HTML versions of the Wireshark project man pages are available at:
-L<http://www.wireshark.org/docs/man-pages>.
+L<https://www.wireshark.org/docs/man-pages>.
 
 =head1 AUTHORS