X-Git-Url: http://git.ozlabs.org/?p=ppp.git;a=blobdiff_plain;f=pppstats%2Fpppstats.8;h=217ffa98ccd6daa3f426fab003cd614464d09557;hp=d7f89f7c6406f2f9dd16dbab2fd17136c6cb9a55;hb=71b6b5b21419e5ab151a9bb2da0997bda855fa6c;hpb=4ed9d22c884b6266f30d308c108f214a0815b812 diff --git a/pppstats/pppstats.8 b/pppstats/pppstats.8 index d7f89f7..217ffa9 100644 --- a/pppstats/pppstats.8 +++ b/pppstats/pppstats.8 @@ -1,22 +1,22 @@ -.\" @(#) $Id: pppstats.8,v 1.3 1996/07/01 01:22:35 paulus Exp $ +.\" @(#) $Id: pppstats.8,v 1.4 2004/11/13 12:22:49 paulus Exp $ .TH PPPSTATS 8 "26 June 1995" .SH NAME pppstats \- print PPP statistics .SH SYNOPSIS .B pppstats [ -.B -a +.B \-a ] [ -.B -v +.B \-v ] [ -.B -r +.B \-r ] [ -.B -z +.B \-z ] [ -.B -c +.B \-c .I ] [ -.B -w +.B \-w .I ] [ .I interface @@ -25,7 +25,7 @@ pppstats \- print PPP statistics .SH DESCRIPTION The .B pppstats -utility reports PPP-related statistics at regular intervals for the +utility reports PPP\-related statistics at regular intervals for the specified PPP interface. If the interface is unspecified, it will default to ppp0. The display is split horizontally @@ -35,40 +35,40 @@ transmitted by the interface. .PP The options are as follows: .TP -.B -a +.B \-a Display absolute values rather than deltas. With this option, all reports show statistics for the time since the link was initiated. Without this option, the second and subsequent reports show statistics for the time since the last report. .TP -.B -c \fIcount +.B \-c \fIcount Repeat the display .I count times. If this option is not specified, the default repeat count is 1 if the -.B -w +.B \-w option is not specified, otherwise infinity. .TP -.B -r +.B \-r Display additional statistics summarizing the compression ratio achieved by the packet compression algorithm in use. .TP -.B -v +.B \-v Display additional statistics relating to the performance of the Van Jacobson TCP header compression algorithm. .TP -.B -w \fIwait +.B \-w \fIwait Pause .I wait seconds between each display. If this option is not specified, the default interval is 5 seconds. .TP -.B -z +.B \-z Instead of the standard display, show statistics indicating the performance of the packet compression algorithm in use. .PP The following fields are printed on the input side when the -.B -z +.B \-z option is not used: .TP .B IN @@ -83,25 +83,25 @@ The number of header-compressed TCP packets received by this interface. .B VJUNC The number of header-uncompressed TCP packets received by this interface. Not reported when the -.B -r +.B \-r option is specified. .TP .B VJERR The number of corrupted or bogus header-compressed TCP packets received by this interface. Not reported when the -.B -r +.B \-r option is specified. .TP .B VJTOSS The number of VJ header-compressed TCP packets dropped on reception by this interface because of preceding errors. Only reported when the -.B -v +.B \-v option is specified. .TP .B NON-VJ The total number of non-TCP packets received by this interface. Only reported when the -.B -v +.B \-v option is specified. .TP .B RATIO @@ -109,13 +109,13 @@ The compression ratio achieved for received packets by the packet compression scheme in use, defined as the uncompressed size divided by the compressed size. Only reported when the -.B -r +.B \-r option is specified. .TP .B UBYTE The total number of bytes received, after decompression of compressed packets. Only reported when the -.B -r +.B \-r option is specified. .PP The following fields are printed on the output side: @@ -134,25 +134,25 @@ VJ-compressed TCP headers. The number of TCP packets transmitted from this interface with VJ-uncompressed TCP headers. Not reported when the -.B -r +.B \-r option is specified. .TP .B NON-VJ The total number of non-TCP packets transmitted from this interface. Not reported when the -.B -r +.B \-r option is specified. .TP .B VJSRCH The number of searches for the cached header entry for a VJ header compressed TCP packet. Only reported when the -.B -v +.B \-v option is specified. .TP .B VJMISS The number of failed searches for the cached header entry for a VJ header compressed TCP packet. Only reported when the -.B -v +.B \-v option is specified. .TP .B RATIO @@ -160,17 +160,17 @@ The compression ratio achieved for transmitted packets by the packet compression scheme in use, defined as the size before compression divided by the compressed size. Only reported when the -.B -r +.B \-r option is specified. .TP .B UBYTE The total number of bytes to be transmitted, before packet compression is applied. Only reported when the -.B -r +.B \-r option is specified. .PP When the -.B -z +.B \-z option is specified, .Nm pppstats instead displays the following fields, relating to the packet