.\"	$OpenBSD: slstats.8,v 1.11 2003/02/18 07:43:36 jmc Exp $
.\"	$NetBSD: slstats.8,v 1.2.6.1 1996/06/07 01:42:24 thorpej Exp $
.\"
.\" Contributed by Van Jacobson (van@ee.lbl.gov), Dec 31, 1989.
.\"
.\" Copyright (c) 1989, 1990, 1991, 1992 Regents of the University of
.\" California. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\" 
.Dd July 5, 1993
.Dt SLSTATS 8
.Os
.Sh NAME
.Nm slstats
.Nd report slip statistics
.Sh SYNOPSIS
.Nm slstats
.Op Fl v
.Op Fl w Ar interval
.Op Ar unit-number
.Sh DESCRIPTION
The
.Nm slstats
utility reports slip-related statistics for the
.Nm sl Ns
.So
.Ar unit-number
.Sc
interface.
If the
.Nm unit-number
is unspecified, it defaults to 0.
These statistics are displayed at regular intervals.
.Pp
The display is split horizontally into input and output sections
containing columns of statistics describing the properties and volume
of packets received and transmitted by the specified interface.
.Pp
The first report will consist of a snapshot of the interface's present
statistics.
All further output will describe activity between report intervals.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl v
Display additional statistics demonstrating the efficacy of VJ header
compression and providing more explicit information on failure
distribution.
.It Fl w
Specifies the interval between reports.
The default interval is 5 seconds.
.El
.Pp
The following fields are printed on the input side:
.Bl -tag -width search
.It Li IN
The total number of bytes received by this interface.
.It Li PACK
The total number of packets received by this interface.
.It Li COMP
The number of compressed TCP packets received by this interface.
.It Li UNCOMP
The number of uncompressed TCP packets received by this interface.
.It Li ERR
The number of packets received by this interface of unknown type.
.It Li TOSS
The number of packets dropped on reception by this interface.
Only reported when the
.Fl v
option is specified.
.It Li IP
The total number of non-TCP packets received by this interface.
Only reported when the
.Fl v
option is specified.
.El
.Pp
The following fields are printed on the output side:
.Bl -tag -width search
.It Li OUT
The total number of bytes transmitted from this interface.
.It Li PACK
The total number of packets transmitted from this interface.
.It Li COMP
The number of TCP packets compressed and then transmitted from this interface.
.It Li UNCOMP
The number of uncompressed TCP packets transmitted from this interface.
.It Li IP
The total number of non-TCP packets transmitted from this interface.
.It Li SEARCH
The number of searches for the cached header entry for a compressed
packet.
Only reported when the
.Fl v
option is specified.
.It Li MISS
The number of failed searches for the cached header entry for a
compressed packet.
Only reported when the
.Fl v
option is specified.
.El
.Sh BUGS
Should take an interface name and not a unit number.
.Sh SEE ALSO
.Xr sliplogin 8