pppstats/pppstats.8

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