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