| 1 |
.TH PPPSTATS 8 "26 June 1995" |
| 2 |
.SH NAME |
| 3 |
pppstats \- print PPP statistics |
| 4 |
.SH SYNOPSIS |
| 5 |
.B pppstats |
| 6 |
[ |
| 7 |
.B \-a |
| 8 |
] [ |
| 9 |
.B \-d |
| 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 \-d |
| 46 |
Show data rate (kB/s) instead of bytes. |
| 47 |
.TP |
| 48 |
.B \-c \fIcount |
| 49 |
Repeat the display |
| 50 |
.I count |
| 51 |
times. If this option is not specified, the default repeat count is 1 |
| 52 |
if the |
| 53 |
.B \-w |
| 54 |
option is not specified, otherwise infinity. |
| 55 |
.TP |
| 56 |
.B \-r |
| 57 |
Display additional statistics summarizing the compression ratio |
| 58 |
achieved by the packet compression algorithm in use. |
| 59 |
.TP |
| 60 |
.B \-v |
| 61 |
Display additional statistics relating to the performance of the Van |
| 62 |
Jacobson TCP header compression algorithm. |
| 63 |
.TP |
| 64 |
.B \-w \fIwait |
| 65 |
Pause |
| 66 |
.I wait |
| 67 |
seconds between each display. If this option is not specified, the |
| 68 |
default interval is 5 seconds. |
| 69 |
.TP |
| 70 |
.B \-z |
| 71 |
Instead of the standard display, show statistics indicating the |
| 72 |
performance of the packet compression algorithm in use. |
| 73 |
.PP |
| 74 |
The following fields are printed on the input side when the |
| 75 |
.B \-z |
| 76 |
option is not used: |
| 77 |
.TP |
| 78 |
.B IN |
| 79 |
The total number of bytes received by this interface. |
| 80 |
.TP |
| 81 |
.B PACK |
| 82 |
The total number of packets received by this interface. |
| 83 |
.TP |
| 84 |
.B VJCOMP |
| 85 |
The number of header-compressed TCP packets received by this interface. |
| 86 |
.TP |
| 87 |
.B VJUNC |
| 88 |
The number of header-uncompressed TCP packets received by this |
| 89 |
interface. Not reported when the |
| 90 |
.B \-r |
| 91 |
option is specified. |
| 92 |
.TP |
| 93 |
.B VJERR |
| 94 |
The number of corrupted or bogus header-compressed TCP packets |
| 95 |
received by this interface. Not reported when the |
| 96 |
.B \-r |
| 97 |
option is specified. |
| 98 |
.TP |
| 99 |
.B VJTOSS |
| 100 |
The number of VJ header-compressed TCP packets dropped on reception by |
| 101 |
this interface because of preceding errors. Only reported when the |
| 102 |
.B \-v |
| 103 |
option is specified. |
| 104 |
.TP |
| 105 |
.B NON-VJ |
| 106 |
The total number of non-TCP packets received by this interface. Only |
| 107 |
reported when the |
| 108 |
.B \-v |
| 109 |
option is specified. |
| 110 |
.TP |
| 111 |
.B RATIO |
| 112 |
The compression ratio achieved for received packets by the |
| 113 |
packet compression scheme in use, defined as the uncompressed size |
| 114 |
divided by the compressed size. |
| 115 |
Only reported when the |
| 116 |
.B \-r |
| 117 |
option is specified. |
| 118 |
.TP |
| 119 |
.B UBYTE |
| 120 |
The total number of bytes received, after decompression of compressed |
| 121 |
packets. Only reported when the |
| 122 |
.B \-r |
| 123 |
option is specified. |
| 124 |
.PP |
| 125 |
The following fields are printed on the output side: |
| 126 |
.TP |
| 127 |
.B OUT |
| 128 |
The total number of bytes transmitted from this interface. |
| 129 |
.TP |
| 130 |
.B PACK |
| 131 |
The total number of packets transmitted from this interface. |
| 132 |
.TP |
| 133 |
.B VJCOMP |
| 134 |
The number of TCP packets transmitted from this interface with |
| 135 |
VJ-compressed TCP headers. |
| 136 |
.TP |
| 137 |
.B VJUNC |
| 138 |
The number of TCP packets transmitted from this interface with |
| 139 |
VJ-uncompressed TCP headers. |
| 140 |
Not reported when the |
| 141 |
.B \-r |
| 142 |
option is specified. |
| 143 |
.TP |
| 144 |
.B NON-VJ |
| 145 |
The total number of non-TCP packets transmitted from this interface. |
| 146 |
Not reported when the |
| 147 |
.B \-r |
| 148 |
option is specified. |
| 149 |
.TP |
| 150 |
.B VJSRCH |
| 151 |
The number of searches for the cached header entry for a VJ header |
| 152 |
compressed TCP packet. Only reported when the |
| 153 |
.B \-v |
| 154 |
option is specified. |
| 155 |
.TP |
| 156 |
.B VJMISS |
| 157 |
The number of failed searches for the cached header entry for a |
| 158 |
VJ header compressed TCP packet. Only reported when the |
| 159 |
.B \-v |
| 160 |
option is specified. |
| 161 |
.TP |
| 162 |
.B RATIO |
| 163 |
The compression ratio achieved for transmitted packets by the |
| 164 |
packet compression scheme in use, defined as the size |
| 165 |
before compression divided by the compressed size. |
| 166 |
Only reported when the |
| 167 |
.B \-r |
| 168 |
option is specified. |
| 169 |
.TP |
| 170 |
.B UBYTE |
| 171 |
The total number of bytes to be transmitted, before packet compression |
| 172 |
is applied. Only reported when the |
| 173 |
.B \-r |
| 174 |
option is specified. |
| 175 |
.PP |
| 176 |
When the |
| 177 |
.B \-z |
| 178 |
option is specified, |
| 179 |
.B pppstats |
| 180 |
instead displays the following fields, relating to the packet |
| 181 |
compression algorithm currently in use. If packet compression is not |
| 182 |
in use, these fields will all display zeroes. The fields displayed on |
| 183 |
the input side are: |
| 184 |
.TP |
| 185 |
.B COMPRESSED BYTE |
| 186 |
The number of bytes of compressed packets received. |
| 187 |
.TP |
| 188 |
.B COMPRESSED PACK |
| 189 |
The number of compressed packets received. |
| 190 |
.TP |
| 191 |
.B INCOMPRESSIBLE BYTE |
| 192 |
The number of bytes of incompressible packets (that is, those which |
| 193 |
were transmitted in uncompressed form) received. |
| 194 |
.TP |
| 195 |
.B INCOMPRESSIBLE PACK |
| 196 |
The number of incompressible packets received. |
| 197 |
.TP |
| 198 |
.B COMP RATIO |
| 199 |
The recent compression ratio for incoming packets, defined as the |
| 200 |
uncompressed size divided by the compressed size (including both |
| 201 |
compressible and incompressible packets). |
| 202 |
.PP |
| 203 |
The fields displayed on the output side are: |
| 204 |
.TP |
| 205 |
.B COMPRESSED BYTE |
| 206 |
The number of bytes of compressed packets transmitted. |
| 207 |
.TP |
| 208 |
.B COMPRESSED PACK |
| 209 |
The number of compressed packets transmitted. |
| 210 |
.TP |
| 211 |
.B INCOMPRESSIBLE BYTE |
| 212 |
The number of bytes of incompressible packets transmitted (that is, |
| 213 |
those which were transmitted in uncompressed form). |
| 214 |
.TP |
| 215 |
.B INCOMPRESSIBLE PACK |
| 216 |
The number of incompressible packets transmitted. |
| 217 |
.TP |
| 218 |
.B COMP RATIO |
| 219 |
The recent compression ratio for outgoing packets. |
| 220 |
.SH SEE ALSO |
| 221 |
pppd(8) |