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