1.\" $OpenBSD: pppstats.8,v 1.11 2007/05/31 19:20:28 jmc Exp $ 2.\" 3.\" Contributed by Van Jacobson (van@ee.lbl.gov), Dec 31, 1989. 4.\" 5.\" Copyright (c) 1989, 1990, 1991, 1992 Regents of the University of 6.\" California. All rights reserved. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.Dd $Mdocdate: May 31 2007 $ 33.Dt PPPSTATS 8 34.Os 35.Sh NAME 36.Nm pppstats 37.Nd report statistics for the specified PPP interface 38.Sh SYNOPSIS 39.Nm pppstats 40.Op Fl adrvz 41.Op Fl c Ar count 42.Op Fl w Ar wait 43.Op Ar interface 44.Sh DESCRIPTION 45The 46.Nm pppstats 47utility reports PPP-related statistics at regular intervals for the 48specified PPP 49.Ar interface . 50If the 51.Ar interface 52is unspecified, it will default to ppp0. 53The display is split horizontally 54into input and output sections containing columns of statistics 55describing the properties and volume of packets received and 56transmitted by the interface. 57.Pp 58The options are as follows: 59.Bl -tag -width Ds 60.It Fl a 61Display absolute values rather than deltas. 62If this option is specified with the 63.Fl c 64and/or 65.Fl w 66options, the second and subsequent reports (as well as the first) will 67show statistics for the time since the link was initiated. 68.It Fl c Ar count 69Repeat the display 70.Ar count 71times. 72The first display is for the time since the link was initiated 73(that is, since the corresponding 74.Xr pppd 8 75was started), and each 76subsequent report is for the time period since the last display 77(unless the 78.Fl a 79option is specified). 80If this option is not specified, the default repeat 81.Ar count 82is 1 if the 83.Fl w 84option is not specified, otherwise infinity. 85.It Fl d 86Display values in terms of data rate (KB/s) rather than in bytes. 87.It Fl r 88Display additional statistics summarizing the compression ratio 89achieved by the packet compression algorithm in use. 90.It Fl v 91Display additional statistics demonstrating the efficiency of VJ header 92compression and provide more explicit information on the operation 93of the algorithm. 94.It Fl w Ar wait 95Pause 96.Ar wait 97seconds between each display. 98.It Fl z 99Instead of the standard display, show statistics indicating the 100performance of the packet compression algorithm in use. 101.El 102.Pp 103The following fields are printed on the input side when the 104.Fl z 105option is not used: 106.Bl -tag -width search 107.It Li IN 108The total number of bytes received by this interface. 109.It Li PACK 110The total number of packets received by this interface. 111.It Li VJCOMP 112The number of compressed TCP packets received by this interface. 113.It Li VJUNC 114The number of uncompressed TCP packets received by this interface. 115Not reported when the 116.Fl r 117option is specified. 118.It Li VJERR 119The number of corrupted or bogus TCP packets received by this interface. 120Not reported when the 121.Fl r 122option is specified. 123.It Li VJTOSS 124The number of VJ header-compressed TCP packets dropped on reception by 125this interface because of preceding errors. 126Only reported when the 127.Fl v 128option is specified. 129.It Li NON-VJ 130The total number of non-VJ packets received by this interface. 131Only reported when the 132.Fl v 133option is specified. 134.It Li RATIO 135The compression ratio achieved for received packets by the 136packet compression scheme in use, defined as the uncompressed size 137divided by the compressed size. 138Only reported when the 139.Fl r 140option is specified. 141.It Li UBYTE 142The total number of bytes received, after decompression of compressed 143packets. 144Only reported when the 145.Fl r 146option is specified. 147.El 148.Pp 149The following fields are printed on the output side: 150.Bl -tag -width search 151.It Li OUT 152The total number of bytes transmitted from this interface. 153.It Li PACK 154The total number of packets transmitted from this interface. 155.It Li VJCOMP 156The number of TCP packets transmitted from this interface with 157VJ-compressed TCP headers. 158.It Li VJUNC 159The number of TCP packets transmitted from this interface with 160VJ-uncompressed TCP headers. 161Not reported when the 162.Fl r 163option is specified. 164.It Li NON-VJ 165The total number of non-VJ packets transmitted from this interface. 166Not reported when the 167.Fl r 168option is specified. 169.It Li VJSRCH 170The number of searches for the cached header entry for a VJ header 171compressed TCP packet. 172Only reported when the 173.Fl v 174option is specified. 175.It Li VJMISS 176The number of failed searches for the cached header entry for a 177VJ header compressed TCP packet. 178Only reported when the 179.Fl v 180option is specified. 181.It Li RATIO 182The compression ratio achieved for transmitted packets by the 183packet compression scheme in use, defined as the size 184before compression divided by the compressed size. 185Only reported when the 186.Fl r 187option is specified. 188.It Li UBYTE 189The total number of bytes to be transmitted, before packet compression 190is applied. 191Only reported when the 192.Fl r 193option is specified. 194.El 195.Pp 196When the 197.Fl z 198option is specified, 199.B pppstats 200instead displays the following fields, relating to the packet 201compression algorithm currently in use. 202If packet compression is not in use, these fields will all display zeroes. 203The fields displayed on the input side are: 204.Bl -tag -width search 205.It Li COMPRESSED BYTE 206The number of bytes of compressed packets received. 207.It Li COMPRESSED PACK 208The number of compressed packets received. 209.It Li INCOMPRESSIBLE BYTE 210The number of bytes of incompressible packets (that is, those which 211were transmitted in uncompressed form) received. 212.It Li INCOMPRESSIBLE PACK 213The number of incompressible packets received. 214.It Li COMP RATIO 215The recent compression ratio for incoming packets, defined as the 216uncompressed size divided by the compressed size (including both 217compressible and incompressible packets). 218.El 219.Pp 220The fields displayed on the output side are: 221.Bl -tag -width search 222.It Li COMPRESSED BYTE 223The number of bytes of compressed packets transmitted. 224.It Li COMPRESSED PACK 225The number of compressed packets transmitted. 226.It Li INCOMPRESSIBLE BYTE 227The number of bytes of incompressible packets transmitted (that is, 228those which were transmitted in uncompressed form). 229.It Li INCOMPRESSIBLE PACK 230The number of incompressible packets transmitted. 231.It Li COMP RATIO 232The recent compression ratio for outgoing packets. 233.El 234.Sh SEE ALSO 235.Xr pppd 8 236