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