7645932ee6a9479ca88fab33e05d0263a2460cc0
[obnox/wireshark/wip.git] / doc / editcap.pod
1
2 =head1 NAME
3
4 editcap - Edit and/or translate the format of capture files
5
6 =head1 SYNOPSYS
7
8 B<editcap>
9 S<[ B<-F> file format ]>
10 S<[ B<-T> encapsulation type ]>
11 S<[ B<-r> ]>
12 S<[ B<-v> ]>
13 S<[ B<-s> snaplen ]>
14 S<[ B<-t> time adjustment ]>
15 S<[ B<-h> ]>
16 I<infile>
17 I<outfile>
18 S<[ I<record#> ... ]>
19
20 =head1 DESCRIPTION
21
22 B<Editcap> is a program that reads a saved capture file and writes some
23 or all of the packets in that capture file to another capture file. 
24 B<Editcap> knows how to read B<libpcap> capture files, including those
25 of B<tcpdump>, B<Ethereal>, and other tools that write captures in that
26 format.  In addition, B<Editcap> can read capture files from B<snoop>
27 (including B<Shomiti>) and B<atmsnoop>, B<LanAlyzer>, B<Sniffer>
28 (compressed or uncompressed), Microsoft B<Network Monitor>, AIX's
29 B<iptrace>, B<NetXray>, B<Sniffer Pro>, B<Etherpeek> versions 5, 6, and
30 7 for Macintosh, B<RADCOM>'s WAN/LAN analyzer, B<Lucent/Ascend> router
31 debug output, HP-UX's B<nettl>, the dump output from B<Toshiba's> ISDN
32 routers, the output from B<i4btrace> from the ISDN4BSD project, the
33 output in B<IPLog> format from the Cisco Secure Intrusion Detection
34 System, B<pppd logs> (pppdump format), the output from VMS's
35 B<TCPIPtrace> utility, the text output from the B<DBS Etherwatch> VMS
36 utility, and traffic capture files from Visual Networks' software. 
37 There is no need to tell B<Editcap> what type of file you are reading;
38 it will determine the file type by itself.  B<Editcap> is also capable
39 of reading any of these file formats if they are compressed using gzip. 
40 B<Editcap> recognizes this directly from the file; the '.gz' extension
41 is not required for this purpose.
42
43 By default, it writes the capture file in B<libpcap> format, and writes
44 all of the packets in the capture file to the output file.  The B<-F>
45 flag can be used to specify the format in which to write the capture
46 file; it can write the file in B<libpcap> format (standard B<libpcap>
47 format, a modified format used by some patched versions of B<libpcap>,
48 the format used by Red Hat Linux 6.1, or the format used by SuSE Linux
49 6.3), B<snoop> format, uncompressed B<Sniffer> format, Microsoft
50 B<Network Monitor> 1.x format, the format used by Windows-based versions
51 of the B<Sniffer> software, and the format used by Visual Networks'
52 software.
53
54 A list of packet numbers can be specified on the command line; the
55 packets with those numbers will I<not> be written to the capture file,
56 unless the B<-r> flag is specified, in which case I<only> those packets
57 will be written to the capture file.  Ranges of packet numbers can be
58 specified as I<start>-I<end>, referring to all packets from I<start> to
59 I<end> (removing them all if B<-r> isn't specified, including them all
60 if B<-r> is specified).
61
62 If the B<-s> flag is used to specify a snapshot length, frames in the
63 input file with more captured data than the specified snapshot length
64 will have only the amount of data specified by the snapshot length
65 written to the output file.  This may be useful if the program that is
66 to read the output file cannot handle packets larger than a certain size
67 (for example, the versions of snoop in Solaris 2.5.1 and Solaris 2.6
68 appear to reject Ethernet frames larger than the standard Ethernet MTU,
69 making them incapable of handling gigabit Ethernet captures if jumbo
70 frames were used).
71
72 If the B<-t> flag is used to specify a time adjustment, the specified
73 adjustment will be applied to all selected frames in the capture file.
74 The adjustment is specified as [-]I<seconds>[I<.fractional seconds>].
75 For example, B<-t> 3600 advances the timestamp on selected frames by one
76 hour while B<-t> -0.5 reduces the timestamp on selected frames by
77 one-half second.  This feature is useful when synchronizing dumps
78 collected on different machines where the time difference between the
79 two machines is known or can be estimated.
80
81 If the B<-T> flag is used to specify an encapsulation type, the
82 encapsulation type of the output capture file will be forced to the
83 specified type, rather than being the type appropriate to the
84 encapsulation type of the input capture file.  Note that this merely
85 forces the encapsulation type of the output file to be the specified
86 type; the packet headers of the packets will not be translated from the
87 encapsulation type of the input capture file to the specified
88 encapsulation type (for example, it will not translate an Ethernet
89 capture to an FDDI capture if an Ethernet capture is read and 'B<-T
90 fddi>' is specified).
91
92 =head1 OPTIONS
93
94 =over 4
95
96 =item -F
97
98 Sets the file format of the output capture file.
99
100 =item -T
101
102 Sets the packet encapsulation type of the output capture file.
103
104 =item -r
105
106 Causes the packets whose packet numbers are specified on the command
107 line to be written to the output capture file, and no other packets to
108 be written to the output capture file.
109
110 =item -v
111
112 Causes B<editcap> to print a number of messages while it's working.
113
114 =item -s
115
116 Sets the snapshot length to use when writing the data.
117
118 =item -t
119
120 Sets the time adjustment to use on selected frames.
121
122 =item -h
123
124 Prints the version and options and exits.
125
126 =head1 SEE ALSO
127
128 L<tcpdump(8)>, L<pcap(3)>, L<ethereal(1)>, L<mergecap(1)>
129
130 =head1 NOTES
131
132 B<Editcap> is part of the B<Ethereal> distribution.  The latest version
133 of B<Ethereal> can be found at B<http://www.ethereal.com>.
134
135 =head1 AUTHORS
136
137   Original Author
138   -------- ------
139   Richard Sharpe           <sharpe@ns.aus.com>
140
141
142   Contributors
143   ------------
144   Guy Harris               <guy@alum.mit.edu>