share/man/man8/pppstats.8

   1 '\" te
   2 .\" Copyright (c) 1989 Regents of the University of California. All rights reserved.
   3 .\" Redistribution and use in source and binary forms are permitted provided that the above copyright notice and this paragraph are duplicated in all such forms and that any documentation, advertising materials, and other materials related to such distribution and use acknowledge that the software was developed by the University of California, Berkeley.  The name of the University may not be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
   4 .\" WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
   5 .\" Portions Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
   6 .TH PPPSTATS 8 "May 4, 2001"
   7 .SH NAME
   8 pppstats \- print PPP statistics
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBpppstats\fR [\fB-a\fR] [\fB-v\fR] [\fB-r\fR] [\fB-z\fR] [\fB-c\fR \fI<count>\fR] [\fB-w\fR \fI<secs>\fR]
  13      [\fIinterface\fR]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBpppstats\fR utility reports PPP-related statistics at regular intervals
  20 for the specified PPP interface. If the interface is unspecified,
  21 \fBpppstats\fR defaults to \fBsppp0\fR. The display is split horizontally into
  22 input and output sections containing columns of statistics describing the
  23 properties and volume of packets received and transmitted by the interface.
  24 .SH OPTIONS
  25 .sp
  26 .LP
  27 The \fBpppstats\fR options are:
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fB-a\fR \fR
  32 .ad
  33 .RS 13n
  34 Display absolute values rather than deltas. With this option, all reports show
  35 statistics for the time elapsed since the link was initiated. Without this
  36 option, the second and subsequent reports show statistics for the time since
  37 the last report.
  38 .RE
  39
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fB-c\fR \fB\fIcount\fR\fR \fR
  44 .ad
  45 .RS 13n
  46 Repeat the display \fIcount\fR times. If this option is not specified, the
  47 default repeat count is 1 if the \fB-w\fR option is not specified, otherwise
  48 infinity.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fB-r\fR \fR
  55 .ad
  56 .RS 13n
  57 Display additional statistics summarizing the compression ratio achieved by the
  58 packet compression algorithm in use.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB-v\fR \fR
  65 .ad
  66 .RS 13n
  67 Display additional statistics relating to the performance of the Van Jacobson
  68 TCP header compression algorithm.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fB-w\fR \fB\fIwait\fR\fR \fR
  75 .ad
  76 .RS 13n
  77 Pause  \fIwait\fR seconds between each display. If this option is not
  78 specified, the default interval is five seconds.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fB-z\fR \fR
  85 .ad
  86 .RS 13n
  87 Instead of the standard display, show statistics indicating the performance of
  88 the packet compression algorithm in use.
  89 .RE
  90
  91 .SH EXTENDED DESCRIPTION
  92 .sp
  93 .LP
  94 The following fields are printed on the input side when the \fB-z\fR option is
  95 not used:
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBIN\fR \fR
 100 .ad
 101 .RS 11n
 102 Total number of bytes received by this interface.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBPACK\fR \fR
 109 .ad
 110 .RS 11n
 111 Total number of packets received by this interface.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBVJCOMP\fR \fR
 118 .ad
 119 .RS 11n
 120 Number of header-compressed TCP packets received by this interface.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBVJUNC\fR \fR
 127 .ad
 128 .RS 11n
 129 Number of header-uncompressed TCP packets received by this interface. Not
 130 reported when the \fB-r\fR option is specified.
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fBVJERR\fR \fR
 137 .ad
 138 .RS 11n
 139 Number of corrupted or bogus header-compressed TCP packets received by this
 140 interface. Not reported when the \fB-r\fR option is specified.
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fBVJTOSS\fR \fR
 147 .ad
 148 .RS 11n
 149 Number of VJ header-compressed TCP packets dropped on reception by this
 150 interface because of preceding errors. Only reported when the \fB-v\fR option
 151 is specified.
 152 .RE
 153
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fBNON-VJ\fR \fR
 158 .ad
 159 .RS 11n
 160 Total number of non-TCP packets received by this interface. Only reported when
 161 the \fB-v\fR option is specified.
 162 .RE
 163
 164 .sp
 165 .ne 2
 166 .na
 167 \fB\fBRATIO\fR \fR
 168 .ad
 169 .RS 11n
 170 Compression ratio achieved for received packets by the packet compression
 171 scheme in use, defined as the uncompressed size divided by the compressed size.
 172 Only reported when the \fB-r\fR option is specified.
 173 .RE
 174
 175 .sp
 176 .ne 2
 177 .na
 178 \fB\fBUBYTE\fR \fR
 179 .ad
 180 .RS 11n
 181 Total number of bytes received, after decompression of compressed packets. Only
 182 reported when the \fB-r\fR option is specified.
 183 .RE
 184
 185 .sp
 186 .LP
 187 The following fields are printed on the output side:
 188 .sp
 189 .ne 2
 190 .na
 191 \fB\fBOUT\fR\fR
 192 .ad
 193 .RS 10n
 194 Total number of bytes transmitted from this interface.
 195 .RE
 196
 197 .sp
 198 .ne 2
 199 .na
 200 \fB\fBPACK\fR\fR
 201 .ad
 202 .RS 10n
 203 Total number of packets transmitted from this interface.
 204 .RE
 205
 206 .sp
 207 .ne 2
 208 .na
 209 \fB\fBVJCOMP\fR\fR
 210 .ad
 211 .RS 10n
 212 Number of TCP packets transmitted from this interface with VJ-compressed TCP
 213 headers.
 214 .RE
 215
 216 .sp
 217 .ne 2
 218 .na
 219 \fB\fBVJUNC\fR\fR
 220 .ad
 221 .RS 10n
 222 Number of TCP packets transmitted from this interface with VJ-uncompressed TCP
 223 headers. Not reported when the \fB-r\fR option is specified.
 224 .RE
 225
 226 .sp
 227 .ne 2
 228 .na
 229 \fB\fBNON-VJ\fR\fR
 230 .ad
 231 .RS 10n
 232 Total number of non-TCP packets transmitted from this interface. Not reported
 233 when the \fB-r\fR option is specified.
 234 .RE
 235
 236 .sp
 237 .ne 2
 238 .na
 239 \fB\fBVJSRCH\fR\fR
 240 .ad
 241 .RS 10n
 242 Number of searches for the cached header entry for a VJ header compressed TCP
 243 packet. Only reported when the \fB-v\fR option is specified.
 244 .RE
 245
 246 .sp
 247 .ne 2
 248 .na
 249 \fB\fBVJMISS\fR\fR
 250 .ad
 251 .RS 10n
 252 Number of failed searches for the cached header entry for a VJ header
 253 compressed TCP packet. Only reported when the \fB-v\fR option is specified.
 254 .RE
 255
 256 .sp
 257 .ne 2
 258 .na
 259 \fB\fBRATIO\fR\fR
 260 .ad
 261 .RS 10n
 262 Compression ratio achieved for transmitted packets by the packet compression
 263 scheme in use, defined as the size before compression divided by the compressed
 264 size. Only reported when the \fB-r\fR option is specified.
 265 .RE
 266
 267 .sp
 268 .ne 2
 269 .na
 270 \fB\fBUBYTE\fR\fR
 271 .ad
 272 .RS 10n
 273 Total number of bytes to be transmitted before packet compression is applied.
 274 Only reported when the \fB-r\fR option is specified.
 275 .RE
 276
 277 .sp
 278 .LP
 279 When the \fB-z\fR option is specified, \fBpppstats\fR displays the following
 280 fields relating to the packet compression algorithm currently in use. If packet
 281 compression is not in use, these fields display zeroes. The fields displayed on
 282 the input side are:
 283 .sp
 284 .ne 2
 285 .na
 286 \fB\fBCOMPRESSED BYTE\fR\fR
 287 .ad
 288 .RS 23n
 289 Number of bytes of compressed packets received.
 290 .RE
 291
 292 .sp
 293 .ne 2
 294 .na
 295 \fB\fBCOMPRESSED PACK\fR\fR
 296 .ad
 297 .RS 23n
 298 Number of compressed packets received.
 299 .RE
 300
 301 .sp
 302 .ne 2
 303 .na
 304 \fB\fBINCOMPRESSIBLE BYTE\fR\fR
 305 .ad
 306 .RS 23n
 307 Number of bytes of incompressible packets (that is, those which were
 308 transmitted in uncompressed form) received.
 309 .RE
 310
 311 .sp
 312 .ne 2
 313 .na
 314 \fB\fBINCOMPRESSIBLE PACK\fR\fR
 315 .ad
 316 .RS 23n
 317 Number of incompressible packets received.
 318 .RE
 319
 320 .sp
 321 .ne 2
 322 .na
 323 \fB\fBCOMP RATIO\fR\fR
 324 .ad
 325 .RS 23n
 326 Recent compression ratio for incoming packets, defined as the uncompressed size
 327 divided by the compressed size (including both compressible and incompressible
 328 packets).
 329 .RE
 330
 331 .sp
 332 .LP
 333 The fields displayed on the output side are:
 334 .sp
 335 .ne 2
 336 .na
 337 \fB\fBCOMPRESSED BYTE\fR\fR
 338 .ad
 339 .RS 23n
 340 Number of bytes of compressed packets transmitted.
 341 .RE
 342
 343 .sp
 344 .ne 2
 345 .na
 346 \fB\fBCOMPRESSED PACK\fR\fR
 347 .ad
 348 .RS 23n
 349 Number of compressed packets transmitted.
 350 .RE
 351
 352 .sp
 353 .ne 2
 354 .na
 355 \fB\fBINCOMPRESSIBLE BYTE\fR\fR
 356 .ad
 357 .RS 23n
 358 Number of bytes of incompressible packets received; that is, those that were
 359 transmitted by the peer in uncompressed form.
 360 .RE
 361
 362 .sp
 363 .ne 2
 364 .na
 365 \fB\fBINCOMPRESSIBLE PACK\fR\fR
 366 .ad
 367 .RS 23n
 368 Number of incompressible packets transmitted.
 369 .RE
 370
 371 .sp
 372 .ne 2
 373 .na
 374 \fB\fBCOMP RATIO\fR\fR
 375 .ad
 376 .RS 23n
 377 Recent compression ratio for outgoing packets.
 378 .RE
 379
 380 .SH ATTRIBUTES
 381 .sp
 382 .LP
 383 See \fBattributes\fR(5)  for descriptions of the following attributes:
 384 .sp
 385
 386 .sp
 387 .TS
 388 box;
 389 c | c
 390 l | l .
 391 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 392 _
 393 Interface Stability     Evolving
 394 .TE
 395
 396 .SH SEE ALSO
 397 .sp
 398 .LP
 399 \fBpppd\fR(8), \fBattributes\fR(5)