xref: /dragonfly/usr.sbin/slstat/slstat.8 (revision 984263bc)
1.\" Copyright (c) 1986 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"	From: @(#)slstat.8	6.8 (Berkeley) 6/20/91
33.\" $FreeBSD: src/usr.sbin/slstat/slstat.8,v 1.14.2.2 2001/08/16 15:56:33 ru Exp $
34.\"
35.Dd October 11, 1996
36.Dt SLSTAT 8
37.Os
38.Sh NAME
39.Nm slstat
40.Nd report serial line IP statistics
41.Sh SYNOPSIS
42.Nm
43.Op Fl i Ar interval
44.Op Fl vr
45.Op Ar unit
46.Sh DESCRIPTION
47The
48.Nm
49utility
50reports certain kernel statistics kept about serial line internet
51protocol traffic.
52.Pp
53The options are as follows:
54.Bl -tag -width indent
55.It Fl i
56Repeat the display indefinitely every
57.Ar interval
58seconds.
59If no
60.Ar interval
61is specified, the default is 5 seconds.
62.It Fl v
63Verbose display of extra fields of information.
64.It Fl r
65Display all values in rate per second rather than amount per interval.
66.It Ar unit
67Is number specifying the
68.Tn SLIP
69interface, or a
70.Tn SLIP
71interface name.
72The default unit is
73.Sy 0
74for interface
75.Sy sl0 .
76.El
77.Pp
78By default,
79.Nm
80displays the following information:
81.Pp
82.Bl -tag -width indent
83.It in
84bytes received
85.It out
86bytes sent
87.It pack
88packets received or sent
89.It comp
90compressed packets received or sent
91.It uncomp
92uncompressed packets received or sent
93.It unknwn
94inbound packets of unknown type
95.It toss
96inbound packets tossed because of error
97.It other
98all other inbound or outbound ip packets
99.It err
100input or output errors
101.It search
102searches for connection state
103.It miss
104times we could not find a connection state
105.It coll
106collisions with end of clists.
107If you get many collisions (more than one or two
108a day) you probably do not have enough clists
109and you should increase
110.Dv nclist
111in param.c.
112.El
113.Sh EXAMPLES
114The command:
115.Dl slstat -i 5
116will print what the system is doing every five
117seconds.
118.Sh SEE ALSO
119.Xr fstat 1 ,
120.Xr netstat 1 ,
121.Xr nfsstat 1 ,
122.Xr ps 1 ,
123.Xr ststat 1 ,
124.Xr iostat 8 ,
125.Xr pppstats 8 ,
126.Xr pstat 8
127.Pp
128The sections starting with ``Interpreting system activity'' in
129.%T "Installing and Operating 4.3BSD" .
130