19de7aef48ce78654a52287dedb8e43db3ffa6a7
[obnox/wireshark/wip.git] / doc / capinfos.pod
1
2 =head1 NAME
3
4 capinfos - Prints information about capture files
5
6 =head1 SYNOPSYS
7
8 B<capinfos>
9 S<[ B<-t> ]>
10 S<[ B<-E> ]>
11 S<[ B<-c> ]>
12 S<[ B<-s> ]>
13 S<[ B<-d> ]>
14 S<[ B<-u> ]>
15 S<[ B<-a> ]>
16 S<[ B<-e> ]>
17 S<[ B<-y> ]>
18 S<[ B<-i> ]>
19 S<[ B<-z> ]>
20 S<[ B<-h> ]>
21 E<lt>I<infile>E<gt>
22 I<...>
23
24 =head1 DESCRIPTION
25
26 B<Capinfos> is a program that reads one or more capture files and
27 returns some or all available statistics of each E<lt>I<infile>E<gt>.
28
29 The user specifies which statistics to report by specifying flags
30 corresponding to the statistic.  If no flags are specified, B<Capinfos>
31 will report all statistics available.
32
33 B<Capinfos> is able to detect and read the same capture files that are
34 supported by B<Wireshark>.
35 The input files don't need a specific filename extension; the file
36 format and an optional gzip compression will be automatically detected.
37 Near the beginning of the DESCRIPTION section of wireshark(1) or
38 L<http://www.wireshark.org/docs/man-pages/wireshark.html>
39 is a detailed description of the way B<Wireshark> handles this, which is
40 the same way B<Capinfos> handles this.
41
42 =head1 OPTIONS
43
44 =over 4
45
46 =item -t
47
48 Displays the capture type of the capture file.
49
50 =item -E
51
52 Displays the per-file encapsulation of the capture file.
53
54 =item -c
55
56 Counts the number of packets in the capture file.
57
58 =item -s
59
60 Displays the size of the file, in bytes.  This reports
61 the size of the capture file itself.
62
63 =item -d
64
65 Displays the total length of all packets in the file, in
66 bytes.  This counts the size of the packets as they appeared
67 in their original form, not as they appear in this file.
68 For example, if a packet was originally 1514 bytes and only
69 256 of those bytes were saved to the capture file (if packets
70 were captured with a snaplen or other slicing option),
71 B<Capinfos> will consider the packet to have been 1514 bytes.
72
73 =item -u
74
75 Displays the capture duration, in seconds.  This is the
76 difference in time between the earliest packet seen and
77 latest packet seen.
78
79 =item -a
80
81 Displays the start time of the capture.  B<Capinfos> considers
82 the earliest timestamp seen to be the start time, so the
83 first packet in the capture is not necessarily the earliest -
84 if packets exist "out-of-order", time-wise, in the capture,
85 B<Capinfos> detects this.
86
87 =item -e
88
89 Displays the end time of the capture.  B<Capinfos> considers
90 the latest timestamp seen to be the end time, so the
91 last packet in the capture is not necessarily the latest -
92 if packets exist "out-of-order", time-wise, in the capture,
93 B<Capinfos> detects this.
94
95 =item -y
96
97 Displays the average data rate, in bytes
98
99 =item -i
100
101 Displays the average data rate, in bits
102
103 =item -z
104
105 displays the average packet size, in bytes
106
107 =item -h
108
109 Prints the help listing and exits.
110
111 =back
112
113 =head1 SEE ALSO
114
115 tcpdump(8), pcap(3), wireshark(1)>, mergecap(1), editcap(1), tshark(1),
116 dumpcap(1)
117
118 =head1 NOTES
119
120 B<Capinfos> is part of the B<Wireshark> distribution.  The latest version
121 of B<Wireshark> can be found at L<http://www.wireshark.org>.
122
123 HTML versions of the Wireshark project man pages are available at:
124 L<http://www.wireshark.org/docs/man-pages>.
125
126 =head1 AUTHORS
127
128   Original Author
129   -------- ------
130   Ian Schorr           <ian[AT]ianschorr.com>
131
132
133   Contributors
134   ------------
135   Gerald Combs         <gerald[AT]wireshark.org>