talk about -c and -r
[ppp.git] / pppstats / pppstats.8
1 .\"     @(#) $Id: pppstats.8,v 1.2 1995/05/02 05:50:53 paulus Exp $
2 .TH PPPSTATS 8 "2 May 1995"
3 .SH NAME
4 pppstats \- print PPP statistics
5 .SH SYNOPSIS
6 .B pppstats
7 [
8 .B -v
9 ] [
10 .B -r
11 ] [
12 .B -c
13 ] [
14 .B -i
15 .I <secs>
16 ] [
17 .I <unit#>
18 ]
19 .ti 12
20 .SH DESCRIPTION
21 .B pppstats
22 prints PPP-related statistics.
23 .PP
24 The
25 .B -v
26 flag causes
27 .B pppstats
28 to display additional statistics, such as the number of packets tossed
29 (that is, which the VJ TCP header decompression code rejected).
30 .PP
31 The
32 .B -r
33 flag causes
34 .B pppstats
35 to display the overall packet compression rate.  The rate value is
36 between 0 and 1, with 0 meaning that the data is incompressible.
37 .PP
38 The
39 .B -c
40 flag is used to specify an alternate display mode that shows
41 packet compression statistics: the number of packets and bytes
42 uncompressed (that is, before compression or after decompression),
43 compressed, and incompressible (packets which did not shrink on
44 compression and were transmitted uncompressed), and the recent
45 compression rate.  This rate reflects the recent performance of the
46 compression code rather than the overall rate achieved since
47 compression was enabled.
48 .PP
49 The
50 .B -i
51 flag is used to specify the interval between printouts. The default is
52 5 seconds.
53 .PP
54 <unit#> specifies which interface to use for gathering statistics.