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