added maxconnect option; extend protocol table; optional IPX support;

[ppp.git] / pppstats / pppstats.8

diff --git a/pppstats/pppstats.8 b/pppstats/pppstats.8
index 45bdc7b53221c58dc5fbe308329fdf03dc65e28d..3ec4db0364e2a48401027507cbb269c815592ab3 100644 (file)
--- a/pppstats/pppstats.8
+++ b/pppstats/pppstats.8
@@ -1,5 +1,5 @@
-.\"    @(#) $Id: pppstats.8,v 1.1 1995/04/28 06:22:53 paulus Exp $
-.TH PPPSTATS 8 "23 Aug 1994"
+.\"    @(#) $Id: pppstats.8,v 1.2 1995/05/02 05:50:53 paulus Exp $
+.TH PPPSTATS 8 "2 May 1995"
 .SH NAME
 pppstats \- print PPP statistics
 .SH SYNOPSIS
@@ -7,18 +7,16 @@ pppstats \- print PPP statistics
 [
 .B -v
 ] [
+.B -r
+] [
+.B -c
+] [
 .B -i
 .I <secs>
 ] [
 .I <unit#>
 ]
 .ti 12
-.br
-[
-.I objectfile
-[
-.I corefile
-]]
 .SH DESCRIPTION
 .B pppstats
 prints PPP-related statistics.
@@ -27,13 +25,30 @@ The
 .B -v
 flag causes
 .B pppstats
-to display additional statistics, such as the number of packets tossed.
+to display additional statistics, such as the number of packets tossed
+(that is, which the VJ TCP header decompression code rejected).
+.PP
+The
+.B -r
+flag causes
+.B pppstats
+to display the overall packet compression rate.  The rate value is
+between 0 and 1, with 0 meaning that the data is incompressible.
+.PP
+The
+.B -c
+flag is used to specify an alternate display mode that shows
+packet compression statistics: the number of packets and bytes
+uncompressed (that is, before compression or after decompression),
+compressed, and incompressible (packets which did not shrink on
+compression and were transmitted uncompressed), and the recent
+compression rate.  This rate reflects the recent performance of the
+compression code rather than the overall rate achieved since
+compression was enabled.
 .PP
 The
 .B -i
 flag is used to specify the interval between printouts. The default is
 5 seconds.
 .PP
-.B pppstats
-must be installed set-group-id to kmem, or the user must have read
-access to /dev/kmem.
+<unit#> specifies which interface to use for gathering statistics.