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