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<Ethereal>.
  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 The I<capture file format> section of I<ethereal(1)> or
  37 I<http://www.ethereal.com/docs/man-pages/ethereal.1.html>
  38 provides a detailed description.
  39
  40 =head1 OPTIONS
  41
  42 =over 4
  43
  44 =item -t
  45
  46 Displays the capture type of the capture file.
  47
  48 =item -c
  49
  50 Counts the number of packets in the capture file.
  51
  52 =item -s
  53
  54 Displays the size of the file, in bytes.  This reports
  55 the size of the capture file itself.
  56
  57 =item -d
  58
  59 Displays the total length of all packets in the file, in
  60 bytes.  This counts the size of the packets as they appeared
  61 in their original form, not as they appear in this file.
  62 For example, if a packet was originally 1514 bytes and only
  63 256 of those bytes were saved to the capture file (if packets
  64 were captured with a snaplen or other slicing option),
  65 B<Capinfos> will consider the packet to have been 1514 bytes.
  66
  67 =item -u
  68
  69 Displays the capture duration, in seconds.  This is the
  70 difference in time between the earliest packet seen and
  71 latest packet seen.
  72
  73 =item -a
  74
  75 Displays the start time of the capture.  B<Capinfos> considers
  76 the earliest timestamp seen to be the start time, so the
  77 first packet in the capture is not necessarily the earliest -
  78 if packets exist "out-of-order", time-wise, in the capture,
  79 B<Capinfos> detects this.
  80
  81 =item -e
  82
  83 Displays the end time of the capture.  B<Capinfos> considers
  84 the latest timestamp seen to be the end time, so the
  85 last packet in the capture is not necessarily the latest -
  86 if packets exist "out-of-order", time-wise, in the capture,
  87 B<Capinfos> detects this.
  88
  89 =item -y
  90
  91 Displays the average data rate, in bytes
  92
  93 =item -i
  94
  95 Displays the average data rate, in bits
  96
  97 =item -z
  98
  99 displays the average packet size, in bytes
 100
 101 =item -h
 102
 103 Prints the help listing and exits.
 104
 105 =back
 106
 107 =head1 SEE ALSO
 108
 109 I<tcpdump(8)>, I<pcap(3)>, I<ethereal(1)>, I<mergecap(1)>, I<editcap(1)>, I<tethereal(1)>
 110
 111 =head1 NOTES
 112
 113 B<Capinfos> is part of the B<Ethereal> distribution.  The latest version
 114 of B<Ethereal> can be found at B<http://www.ethereal.com>.
 115
 116 HTML versions of the Ethereal project man pages are available at:
 117 http://www.ethereal.com/docs/man-pages
 118
 119 =head1 AUTHORS
 120
 121   Original Author
 122   -------- ------
 123   Ian Schorr           <ian[AT]ianschorr.com>
 124
 125
 126   Contributors
 127   ------------
 128   Gerald Combs         <gerald[AT]ethereal.com>