From Reinhard Speyerer:
[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<-c> E<lt>packets per fileE<gt> ]>
10 S<[ B<-C> E<lt>choplenE<gt> ]>
11 S<[ B<-E> E<lt>error probabilityE<gt> ]>
12 S<[ B<-F> E<lt>file formatE<gt> ]>
13 S<[ B<-A> E<lt>start timeE<gt> ]>
14 S<[ B<-B> E<lt>stop timeE<gt> ]>
15 S<[ B<-h> ]>
16 S<[ B<-r> ]>
17 S<[ B<-s> E<lt>snaplenE<gt> ]>
18 S<[ B<-t> E<lt>time adjustmentE<gt> ]>
19 S<[ B<-T> E<lt>encapsulation typeE<gt> ]>
20 S<[ B<-v> ]>
21 I<infile>
22 I<outfile>
23 S<[ I<packet#>[-I<packet#>] ... ]>
24
25 B<editcap>
26 S< B<-d> > |
27 S< B<-D> E<lt>dup windowE<gt> > |
28 S< B<-w> E<lt>dup time windowE<gt> >
29 S<[ B<-v> ]>
30 I<infile>
31 I<outfile>
32
33 =head1 DESCRIPTION
34
35 B<Editcap> is a program that reads some or all of the captured packets from the 
36 I<infile>, optionally converts them in various ways and writes the 
37 resulting packets to the capture I<outfile> (or outfiles). 
38
39 By default, it reads all packets from the I<infile> and writes them to the 
40 I<outfile> in libpcap file format.
41
42 An optional list of packet numbers can be specified on the command tail; 
43 individual packet numbers separated by whitespace and/or ranges of packet
44 numbers can be specified as I<start>-I<end>, referring to all packets from
45 I<start> to I<end>.  By default the selected packets with those numbers will
46 I<not> be written to the capture file.  If the B<-r> flag is specified, the
47 whole packet selection is reversed; in that case I<only> the selected packets
48 will be written to the capture file.
49
50 B<Editcap> can also be used to remove duplicate packets.  Several different
51 options (B<-d>, B<-D> and B<-w>) are used to control the packet window
52 or relative time window to be used for duplicate comparison.
53
54 B<Editcap> is able to detect, read and write the same capture files that 
55 are supported by B<Wireshark>.
56 The input file doesn't need a specific filename extension; the file 
57 format and an optional gzip compression will be automatically detected.
58 Near the beginning of the DESCRIPTION section of wireshark(1) or
59 L<http://www.wireshark.org/docs/man-pages/wireshark.html>
60 is a detailed description of the way B<Wireshark> handles this, which is
61 the same way B<Editcap> handles this.
62
63 B<Editcap> can write the file in several output formats. The B<-F>
64 flag can be used to specify the format in which to write the capture
65 file, B<editcap -F> provides a list of the available output formats.
66
67 =head1 OPTIONS
68
69 =over 4
70
71 =item -c  E<lt>packets per fileE<gt>
72
73 Sets the maximum number of packets per output file. Each output file will 
74 be created with a suffix -nnnnn, starting with 00000. If the specified 
75 number of packets are written to the output file, the next output file is 
76 opened. The default is to use a single output file.
77
78 =item -C  E<lt>choplenE<gt>
79
80 Sets the chop length to use when writing the packet data.
81 Each packet is chopped at the packet end by a few <choplen> bytes of data.
82
83 This is useful in the rare case that the conversion between two file 
84 formats leaves some random bytes at the end of each packet.
85
86 =item -d
87
88 Attempts to remove duplicate packets.  The length and MD5 hash of the 
89 current packet are compared to the previous four (4) packets.  If a 
90 match is found, the current packet is skipped.  This option is equivalent
91 to using the option B<-D 5>.
92
93 =item -D  E<lt>dup windowE<gt>
94
95 Attempts to remove duplicate packets.  The length and MD5 hash of the
96 current packet are compared to the previous <dup window> - 1 packets.
97 If a match is found, the current packet is skipped.
98
99 The use of the option B<-D 0> combined with the B<-v> option is useful
100 in that each packet's Packet number, Len and MD5 Hash will be printed
101 to standard out.  This verbose output (specifically the MD5 hash strings)
102 can be useful in scripts to identify duplicate packets across trace
103 files.
104
105 The <dup window> is specifed as an integer value between 0 and 1000000 (inclusive).
106
107 NOTE: Specifying large <dup window> values with large tracefiles can
108 result in very long processing times for B<editcap>.
109
110 =item -w  E<lt>dup time windowE<gt>
111
112 Attempts to remove duplicate packets.  The current packet's arrival time
113 is compared with up to 1000000 previous packets.  If the packet's relative
114 arrival time is I<less than> the <dup time window> of a previous packet
115 and the packet length and MD5 hash of the current packet are the same then
116 the packet to skipped.  The duplicate comparison test stops when
117 the current packet's relative arrival time is greater than <dup time window>.
118
119 The <dup time window> is specifed as I<seconds>[I<.fractional seconds>].
120
121 The [.fractional seconds] component can be specified to nine (9) decimal
122 places (billionths of a second) but most typical trace files have resolution
123 to six (6) decimal places (millionths of a second).
124
125 NOTE: Specifying large <dup time window> values with large tracefiles can
126 result in very long processing times for B<editcap>.
127
128 NOTE: The B<-w> option assumes that the packets are in chronological order.  
129 If the packets are NOT in chronological order then the B<-w> duplication 
130 removal option may not identify some duplicates.
131
132 =item -E  E<lt>error probabilityE<gt>
133
134 Sets the probabilty that bytes in the output file are randomly changed.
135 B<Editcap> uses that probability (between 0.0 and 1.0 inclusive) 
136 to apply errors to each data byte in the file.  For instance, a 
137 probability of 0.02 means that each byte has a 2% chance of having an error.
138
139 This option is meant to be used for fuzz-testing protocol dissectors.
140
141 =item -F  E<lt>file formatE<gt>
142
143 Sets the file format of the output capture file.
144 B<Editcap> can write the file in several formats, B<editcap -F> 
145 provides a list of the available output formats. The default
146 is the B<libpcap> format.
147
148 =item -A  E<lt>start timeE<gt>
149
150 Saves only the packets whose timestamp is on or after start time.
151 The time is given in the following format YYYY-MM-DD HH:MM:SS
152
153 =item -B  E<lt>stop timeE<gt>
154
155 Saves only the packets whose timestamp is on or before stop time.
156 The time is given in the following format YYYY-MM-DD HH:MM:SS
157
158 =item -h
159
160 Prints the version and options and exits.
161
162 =item -r
163
164 Reverse the packet selection.
165 Causes the packets whose packet numbers are specified on the command
166 line to be written to the output capture file, instead of discarding them.
167
168 =item -s  E<lt>snaplenE<gt>
169
170 Sets the snapshot length to use when writing the data.
171 If the B<-s> flag is used to specify a snapshot length, packets in the
172 input file with more captured data than the specified snapshot length
173 will have only the amount of data specified by the snapshot length
174 written to the output file.  
175
176 This may be useful if the program that is
177 to read the output file cannot handle packets larger than a certain size
178 (for example, the versions of snoop in Solaris 2.5.1 and Solaris 2.6
179 appear to reject Ethernet packets larger than the standard Ethernet MTU,
180 making them incapable of handling gigabit Ethernet captures if jumbo
181 packets were used).
182
183 =item -t  E<lt>time adjustmentE<gt>
184
185 Sets the time adjustment to use on selected packets.
186 If the B<-t> flag is used to specify a time adjustment, the specified
187 adjustment will be applied to all selected packets in the capture file.
188 The adjustment is specified as [-]I<seconds>[I<.fractional seconds>].
189 For example, B<-t> 3600 advances the timestamp on selected packets by one
190 hour while B<-t> -0.5 reduces the timestamp on selected packets by
191 one-half second.  
192
193 This feature is useful when synchronizing dumps
194 collected on different machines where the time difference between the
195 two machines is known or can be estimated.
196
197 =item -T  E<lt>encapsulation typeE<gt>
198
199 Sets the packet encapsulation type of the output capture file.
200 If the B<-T> flag is used to specify an encapsulation type, the
201 encapsulation type of the output capture file will be forced to the
202 specified type. 
203 B<editcap -T> provides a list of the available types. The default
204 type is the one appropriate to the encapsulation type of the input 
205 capture file.
206
207 Note: this merely
208 forces the encapsulation type of the output file to be the specified
209 type; the packet headers of the packets will not be translated from the
210 encapsulation type of the input capture file to the specified
211 encapsulation type (for example, it will not translate an Ethernet
212 capture to an FDDI capture if an Ethernet capture is read and 'B<-T
213 fddi>' is specified). If you need to remove/add headers from/to a
214 packet, you will need od(1)/text2pcap(1).
215
216 =item -v
217
218 Causes B<editcap> to print verbose messages while it's working.
219
220 Use of B<-v> with the de-duplication switches of B<-d>, B<-D> or B<-w>
221 will cause all MD5 hashes to be printed whether the packet is skipped
222 or not.
223
224 =back
225
226 =head1 EXAMPLES
227
228 To see more detailed description of the options use:
229
230     editcap -h
231
232 To shrink the capture file by truncating the packets at 64 bytes and writing it as Sun snoop file use:
233
234     editcap -s 64 -F snoop capture.pcap shortcapture.snoop
235
236 To delete packet 1000 from the capture file use:
237
238     editcap capture.pcap sans1000.pcap 1000
239
240 To limit a capture file to packets from number 200 to 750 (inclusive) use:
241
242     editcap -r capture.pcap small.pcap 200-750
243
244 To get all packets from number 1-500 (inclusive) use:
245
246     editcap -r capture.pcap first500.pcap 1-500
247
248 or
249
250     editcap capture.pcap first500.pcap 501-9999999
251
252 To exclude packets 1, 5, 10 to 20 and 30 to 40 from the new file use:
253
254     editcap capture.pcap exclude.pcap 1 5 10-20 30-40
255
256 To select just packets 1, 5, 10 to 20 and 30 to 40 for the new file use:
257
258     editcap -r capture.pcap select.pcap 1 5 10-20 30-40
259
260 To remove duplicate packets seen within the prior four frames use:
261
262     editcap -d capture.pcap dedup.pcap
263
264 To remove duplicate packets seen within the prior 100 frames use:
265
266     editcap -D 101 capture.pcap dedup.pcap
267
268 To remove duplicate packets seen I<less than> 1/10th of a second:
269
270     editcap -w 0.1 capture.pcap dedup.pcap
271
272 To remove duplicate packets seen I<equal to or less than> 1/10th of a second:
273
274     editcap -w 0.1 capture.pcap dedup.pcap
275
276 To display the MD5 hash for all of the packets (and NOT generate any
277 real output file):
278
279     editcap -v -D 0 capture.pcap /dev/null
280
281 or on Windows systems
282
283     editcap -v -D 0 capture.pcap NUL
284
285 To introduce 5% random errors in a capture file use:
286
287 =over 4
288
289   editcap -E 0.05 capture.pcap capture_error.pcap
290
291 =back
292
293 =head1 SEE ALSO
294
295 tcpdump(8), pcap(3), wireshark(1), tshark(1), mergecap(1), dumpcap(1),
296 capinfos(1), text2pcap(1), od(1)
297
298 =head1 NOTES
299
300 B<Editcap> is part of the B<Wireshark> distribution.  The latest version
301 of B<Wireshark> can be found at L<http://www.wireshark.org>.
302
303 HTML versions of the Wireshark project man pages are available at:
304 L<http://www.wireshark.org/docs/man-pages>.
305
306 =head1 AUTHORS
307
308   Original Author
309   -------- ------
310   Richard Sharpe           <sharpe[AT]ns.aus.com>
311
312
313   Contributors
314   ------------
315   Guy Harris               <guy[AT]alum.mit.edu>
316   Ulf Lamping              <ulf.lamping[AT]web.de>