pppstats/pppstats.8

   1 .\"     @(#) $Id: pppstats.8,v 1.4 2004/11/13 12:22:49 paulus Exp $
   2 .TH PPPSTATS 8 "26 June 1995"
   3 .SH NAME
   4 pppstats \- print PPP statistics
   5 .SH SYNOPSIS
   6 .B pppstats
   7 [
   8 .B \-a
   9 ] [
  10 .B \-d
  11 ] [
  12 .B \-v
  13 ] [
  14 .B \-r
  15 ] [
  16 .B \-z
  17 ] [
  18 .B \-c
  19 .I <count>
  20 ] [
  21 .B \-w
  22 .I <secs>
  23 ] [
  24 .I interface
  25 ]
  26 .ti 12
  27 .SH DESCRIPTION
  28 The
  29 .B pppstats
  30 utility reports PPP\-related statistics at regular intervals for the
  31 specified PPP interface.  If the interface is unspecified, it will
  32 default to ppp0.
  33 The display is split horizontally
  34 into input and output sections containing columns of statistics
  35 describing the properties and volume of packets received and
  36 transmitted by the interface.
  37 .PP
  38 The options are as follows:
  39 .TP
  40 .B \-a
  41 Display absolute values rather than deltas.  With this option, all
  42 reports show statistics for the time since the link was initiated.
  43 Without this option, the second and subsequent reports show statistics
  44 for the time since the last report.
  45 .TP
  46 .B \-d
  47 Show data rate (kB/s) instead of bytes.
  48 .TP
  49 .B \-c \fIcount
  50 Repeat the display
  51 .I count
  52 times.  If this option is not specified, the default repeat count is 1
  53 if the
  54 .B \-w
  55 option is not specified, otherwise infinity.
  56 .TP
  57 .B \-r
  58 Display additional statistics summarizing the compression ratio
  59 achieved by the packet compression algorithm in use.
  60 .TP
  61 .B \-v
  62 Display additional statistics relating to the performance of the Van
  63 Jacobson TCP header compression algorithm.
  64 .TP
  65 .B \-w \fIwait
  66 Pause
  67 .I wait
  68 seconds between each display.  If this option is not specified, the
  69 default interval is 5 seconds.
  70 .TP
  71 .B \-z
  72 Instead of the standard display, show statistics indicating the
  73 performance of the packet compression algorithm in use.
  74 .PP
  75 The following fields are printed on the input side when the
  76 .B \-z
  77 option is not used:
  78 .TP
  79 .B IN
  80 The total number of bytes received by this interface.
  81 .TP
  82 .B PACK
  83 The total number of packets received by this interface.
  84 .TP
  85 .B VJCOMP
  86 The number of header-compressed TCP packets received by this interface.
  87 .TP
  88 .B VJUNC
  89 The number of header-uncompressed TCP packets received by this
  90 interface.  Not reported when the
  91 .B \-r
  92 option is specified.
  93 .TP
  94 .B VJERR
  95 The number of corrupted or bogus header-compressed TCP packets
  96 received by this interface.  Not reported when the
  97 .B \-r
  98 option is specified.
  99 .TP
 100 .B VJTOSS
 101 The number of VJ header-compressed TCP packets dropped on reception by
 102 this interface because of preceding errors.  Only reported when the
 103 .B \-v
 104 option is specified.
 105 .TP
 106 .B NON-VJ
 107 The total number of non-TCP packets received by this interface. Only
 108 reported when the
 109 .B \-v
 110 option is specified.
 111 .TP
 112 .B RATIO
 113 The compression ratio achieved for received packets by the
 114 packet compression scheme in use, defined as the uncompressed size
 115 divided by the compressed size.
 116 Only reported when the
 117 .B \-r
 118 option is specified.
 119 .TP
 120 .B UBYTE
 121 The total number of bytes received, after decompression of compressed
 122 packets.  Only reported when the
 123 .B \-r
 124 option is specified.
 125 .PP
 126 The following fields are printed on the output side:
 127 .TP
 128 .B OUT
 129 The total number of bytes transmitted from this interface.
 130 .TP
 131 .B PACK
 132 The total number of packets transmitted from this interface.
 133 .TP
 134 .B VJCOMP
 135 The number of TCP packets transmitted from this interface with
 136 VJ-compressed TCP headers.
 137 .TP
 138 .B VJUNC
 139 The number of TCP packets transmitted from this interface with
 140 VJ-uncompressed TCP headers.
 141 Not reported when the
 142 .B \-r
 143 option is specified.
 144 .TP
 145 .B NON-VJ
 146 The total number of non-TCP packets transmitted from this interface.
 147 Not reported when the
 148 .B \-r
 149 option is specified.
 150 .TP
 151 .B VJSRCH
 152 The number of searches for the cached header entry for a VJ header
 153 compressed TCP packet.  Only reported when the
 154 .B \-v
 155 option is specified.
 156 .TP
 157 .B VJMISS
 158 The number of failed searches for the cached header entry for a
 159 VJ header compressed TCP packet.  Only reported when the
 160 .B \-v
 161 option is specified.
 162 .TP
 163 .B RATIO
 164 The compression ratio achieved for transmitted packets by the
 165 packet compression scheme in use, defined as the size
 166 before compression divided by the compressed size.
 167 Only reported when the
 168 .B \-r
 169 option is specified.
 170 .TP
 171 .B UBYTE
 172 The total number of bytes to be transmitted, before packet compression
 173 is applied.  Only reported when the
 174 .B \-r
 175 option is specified.
 176 .PP
 177 When the
 178 .B \-z
 179 option is specified,
 180 .B pppstats
 181 instead displays the following fields, relating to the packet
 182 compression algorithm currently in use.  If packet compression is not
 183 in use, these fields will all display zeroes.  The fields displayed on
 184 the input side are:
 185 .TP
 186 .B COMPRESSED BYTE
 187 The number of bytes of compressed packets received.
 188 .TP
 189 .B COMPRESSED PACK
 190 The number of compressed packets received.
 191 .TP
 192 .B INCOMPRESSIBLE BYTE
 193 The number of bytes of incompressible packets (that is, those which
 194 were transmitted in uncompressed form) received.
 195 .TP
 196 .B INCOMPRESSIBLE PACK
 197 The number of incompressible packets received.
 198 .TP
 199 .B COMP RATIO
 200 The recent compression ratio for incoming packets, defined as the
 201 uncompressed size divided by the compressed size (including both
 202 compressible and incompressible packets).
 203 .PP
 204 The fields displayed on the output side are:
 205 .TP
 206 .B COMPRESSED BYTE
 207 The number of bytes of compressed packets transmitted.
 208 .TP
 209 .B COMPRESSED PACK
 210 The number of compressed packets transmitted.
 211 .TP
 212 .B INCOMPRESSIBLE BYTE
 213 The number of bytes of incompressible packets transmitted (that is,
 214 those which were transmitted in uncompressed form).
 215 .TP
 216 .B INCOMPRESSIBLE PACK
 217 The number of incompressible packets transmitted.
 218 .TP
 219 .B COMP RATIO
 220 The recent compression ratio for outgoing packets.
 221 .SH SEE ALSO
 222 pppd(8)