doc/capinfos.pod

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