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