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