usr.sbin/pppstats/pppstats.8

   1 .\"     @(#) $FreeBSD: src/usr.sbin/pppstats/pppstats.8,v 1.10 2000/03/03 09:11:28 sheldonh 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.
 103 Only
 104 reported when the
 105 .B -v
 106 option is specified.
 107 .TP
 108 .B RATIO
 109 The compression ratio achieved for received packets by the
 110 packet compression scheme in use, defined as the uncompressed size
 111 divided by the compressed size.
 112 Only reported when the
 113 .B -r
 114 option is specified.
 115 .TP
 116 .B UBYTE
 117 The total number of bytes received, after decompression of compressed
 118 packets.  Only reported when the
 119 .B -r
 120 option is specified.
 121 .PP
 122 The following fields are printed on the output side:
 123 .TP
 124 .B OUT
 125 The total number of bytes transmitted from this interface.
 126 .TP
 127 .B PACK
 128 The total number of packets transmitted from this interface.
 129 .TP
 130 .B VJCOMP
 131 The number of TCP packets transmitted from this interface with
 132 VJ-compressed TCP headers.
 133 .TP
 134 .B VJUNC
 135 The number of TCP packets transmitted from this interface with
 136 VJ-uncompressed TCP headers.
 137 Not reported when the
 138 .B -r
 139 option is specified.
 140 .TP
 141 .B NON-VJ
 142 The total number of non-TCP packets transmitted from this interface.
 143 Not reported when the
 144 .B -r
 145 option is specified.
 146 .TP
 147 .B VJSRCH
 148 The number of searches for the cached header entry for a VJ header
 149 compressed TCP packet.  Only reported when the
 150 .B -v
 151 option is specified.
 152 .TP
 153 .B VJMISS
 154 The number of failed searches for the cached header entry for a
 155 VJ header compressed TCP packet.  Only reported when the
 156 .B -v
 157 option is specified.
 158 .TP
 159 .B RATIO
 160 The compression ratio achieved for transmitted packets by the
 161 packet compression scheme in use, defined as the size
 162 before compression divided by the compressed size.
 163 Only reported when the
 164 .B -r
 165 option is specified.
 166 .TP
 167 .B UBYTE
 168 The total number of bytes to be transmitted, before packet compression
 169 is applied.  Only reported when the
 170 .B -r
 171 option is specified.
 172 .PP
 173 When the
 174 .B -z
 175 option is specified,
 176 .B pppstats
 177 instead displays the following fields, relating to the packet
 178 compression algorithm currently in use.  If packet compression is not
 179 in use, these fields will all display zeroes.  The fields displayed on
 180 the input side are:
 181 .TP
 182 .B COMPRESSED BYTE
 183 The number of bytes of compressed packets received.
 184 .TP
 185 .B COMPRESSED PACK
 186 The number of compressed packets received.
 187 .TP
 188 .B INCOMPRESSIBLE BYTE
 189 The number of bytes of incompressible packets (that is, those which
 190 were transmitted in uncompressed form) received.
 191 .TP
 192 .B INCOMPRESSIBLE PACK
 193 The number of incompressible packets received.
 194 .TP
 195 .B COMP RATIO
 196 The recent compression ratio for incoming packets, defined as the
 197 uncompressed size divided by the compressed size (including both
 198 compressible and incompressible packets).
 199 .PP
 200 The fields displayed on the output side are:
 201 .TP
 202 .B COMPRESSED BYTE
 203 The number of bytes of compressed packets transmitted.
 204 .TP
 205 .B COMPRESSED PACK
 206 The number of compressed packets transmitted.
 207 .TP
 208 .B INCOMPRESSIBLE BYTE
 209 The number of bytes of incompressible packets transmitted (that is,
 210 those which were transmitted in uncompressed form).
 211 .TP
 212 .B INCOMPRESSIBLE PACK
 213 The number of incompressible packets transmitted.
 214 .TP
 215 .B COMP RATIO
 216 The recent compression ratio for outgoing packets.
 217 .SH SEE ALSO
 218 pppd(8)