6f476dbdbe19d76ddbdfcadd2ad20d2b5c719746
[obnox/wireshark/wip.git] / doc / capinfos.pod
1
2 =head1 NAME
3
4 capinfos - Prints information about binary capture files
5
6 =head1 SYNOPSYS
7
8 B<capinfos>
9 S<[ B<-t> ]>
10 S<[ B<-c> ]>
11 S<[ B<-s> ]>
12 S<[ B<-d> ]>
13 S<[ B<-u> ]>
14 S<[ B<-a> ]>
15 S<[ B<-e> ]>
16 S<[ B<-y> ]>
17 S<[ B<-i> ]>
18 S<[ B<-z> ]>
19 S<[ B<-h> ]>
20 I<capfile>
21 I<...>
22
23 =head1 DESCRIPTION
24
25 B<Capinfos> is a program that reads one or more saved capture files and
26 returns any or all of several statistics about each file.  B<Capinfos> is
27 able to detect and read any capture supported by the B<Ethereal> package.
28
29 B<Capinfos> can read the following file formats:
30
31 =over 4
32
33 =item *
34 libpcap/WinPcap, tcpdump and various other tools using tcpdump's capture format
35
36 =item *
37 B<snoop> and B<atmsnoop>
38
39 =item *
40 Shomiti/Finisar B<Surveyor> captures
41
42 =item *
43 Novell B<LANalyzer> captures
44
45 =item *
46 Microsoft B<Network Monitor> captures
47
48 =item *
49 AIX's B<iptrace> captures
50
51 =item *
52 Cinco Networks B<NetXRay> captures
53
54 =item *
55 Network Associates Windows-based B<Sniffer> captures
56
57 =item *
58 Network General/Network Associates DOS-based B<Sniffer> (compressed or uncompressed) captures
59
60 =item *
61 AG Group/WildPackets B<EtherPeek>/B<TokenPeek>/B<AiroPeek>/B<EtherHelp>/B<PacketGrabber> captures
62
63 =item *
64 B<RADCOM>'s WAN/LAN analyzer captures
65
66 =item *
67 Network Instruments B<Observer> version 9 captures
68
69 =item *
70 B<Lucent/Ascend> router debug output
71
72 =item *
73 files from HP-UX's B<nettl>
74
75 =item *
76 B<Toshiba's> ISDN routers dump output
77
78 =item *
79 the output from B<i4btrace> from the ISDN4BSD project
80
81 =item *
82 traces from the B<EyeSDN> USB S0.
83
84 =item *
85 the output in B<IPLog> format from the Cisco Secure Intrusion Detection System
86
87 =item *
88 B<pppd logs> (pppdump format)
89
90 =item *
91 the output from VMS's B<TCPIPtrace>/B<TCPtrace>/B<UCX$TRACE> utilities
92
93 =item *
94 the text output from the B<DBS Etherwatch> VMS utility
95
96 =item *
97 Visual Networks' B<Visual UpTime> traffic capture
98
99 =item *
100 the output from B<CoSine> L2 debug
101
102 =item *
103 the output from Accellent's B<5Views> LAN agents
104
105 =item *
106 Endace Measurement Systems' ERF format captures 
107
108 =item *
109 Linux Bluez Bluetooth stack B<hcidump -w> traces
110
111 =back
112
113 There is no need to tell B<Capinfos> what type of
114 file you are reading; it will determine the file type by itself. 
115 B<Capinfos> is also capable of reading any of these file formats if they
116 are compressed using gzip.  B<Capinfos> recognizes this directly from the
117 file; the '.gz' extension is not required for this purpose.
118
119 The user specifies which statistics to report by specifying flags 
120 corresponding to the statistic.  If no flags are specified, B<Capinfos> will
121 report all statistics available.
122
123 =head1 OPTIONS
124
125 =over 4
126
127 =item -t
128
129 Displays the capture type of the capture file.
130
131 =item -c
132
133 Counts the number of packets in the capture file.
134
135 =item -s
136
137 Displays the size of the file, in bytes.  This reports
138 the size of the capture file itself.
139
140 =item -d
141
142 Displays the total length of all packets in the file, in
143 bytes.  This counts the size of the packets as they appeared
144 in their original form, not as they appear in this file.
145 For example, if a packet was originally 1514 bytes and only
146 256 of those bytes were saved to the capture file (if packets
147 were captured with a snaplen or other slicing option),
148 B<Capinfos> will consider the packet to have been 1514 bytes.
149
150 =item -u
151
152 Displays the capture duration, in seconds.  This is the
153 difference in time between the earliest packet seen and
154 latest packet seen.
155
156 =item -a
157
158 Displays the start time of the capture.  B<Capinfos> considers
159 the earliest timestamp seen to be the start time, so the
160 first packet in the capture is not necessarily the earliest -
161 if packets exist "out-of-order", time-wise, in the capture,
162 B<Capinfos> detects this.
163
164 =item -e
165
166 Displays the end time of the capture.  B<Capinfos> considers
167 the latest timestamp seen to be the end time, so the
168 last packet in the capture is not necessarily the latest -
169 if packets exist "out-of-order", time-wise, in the capture,
170 B<Capinfos> detects this.
171
172 =item -y
173
174 Displays the average data rate, in bytes
175
176 =item -i
177
178 Displays the average data rate, in bits
179
180 =item -z
181
182 displays the average packet size, in bytes
183
184 =item -h
185
186 Prints the help listing and exits.
187
188 =back
189
190 =head1 SEE ALSO
191
192 I<tcpdump(8)>, I<pcap(3)>, I<ethereal(1)>, I<mergecap(1)>, I<editcap(1)>, I<tethereal(1)>
193
194 =head1 NOTES
195
196 B<Capinfos> is part of the B<Ethereal> distribution.  The latest version
197 of B<Ethereal> can be found at B<http://www.ethereal.com>.
198
199 =head1 AUTHORS
200
201   Original Author
202   -------- ------
203   Ian Schorr           <ian[AT]ianschorr.com>
204
205
206   Contributors
207   ------------
208   Gerald Combs         <gerald[AT]ethereal.com>