Misc mdoc(7) cleanup:
[dragonfly.git] / usr.sbin / slstat / slstat.8
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 .\" $DragonFly: src/usr.sbin/slstat/slstat.8,v 1.3 2006/05/21 14:15:06 swildner Exp $
35 .\"
36 .Dd October 11, 1996
37 .Dt SLSTAT 8
38 .Os
39 .Sh NAME
40 .Nm slstat
41 .Nd report serial line IP statistics
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl i Ar interval
45 .Op Fl vr
46 .Op Ar unit
47 .Sh DESCRIPTION
48 The
49 .Nm
50 utility
51 reports certain kernel statistics kept about serial line internet
52 protocol traffic.
53 .Pp
54 The options are as follows:
55 .Bl -tag -width indent
56 .It Fl i
57 Repeat the display indefinitely every
58 .Ar interval
59 seconds.
60 If no
61 .Ar interval
62 is specified, the default is 5 seconds.
63 .It Fl v
64 Verbose display of extra fields of information.
65 .It Fl r
66 Display all values in rate per second rather than amount per interval.
67 .It Ar unit
68 Is number specifying the
69 .Tn SLIP
70 interface, or a
71 .Tn SLIP
72 interface name.
73 The default unit is
74 .Sy 0
75 for interface
76 .Sy sl0 .
77 .El
78 .Pp
79 By default,
80 .Nm
81 displays the following information:
82 .Pp
83 .Bl -tag -width indent
84 .It in
85 bytes received
86 .It out
87 bytes sent
88 .It pack
89 packets received or sent
90 .It comp
91 compressed packets received or sent
92 .It uncomp
93 uncompressed packets received or sent
94 .It unknwn
95 inbound packets of unknown type
96 .It toss
97 inbound packets tossed because of error
98 .It other
99 all other inbound or outbound ip packets
100 .It err
101 input or output errors
102 .It search
103 searches for connection state
104 .It miss
105 times we could not find a connection state
106 .It coll
107 collisions with end of clists.
108 If you get many collisions (more than one or two
109 a day) you probably do not have enough clists
110 and you should increase
111 .Dv nclist
112 in param.c.
113 .El
114 .Sh EXAMPLES
115 The command:
116 .Dl slstat -i 5
117 will print what the system is doing every five
118 seconds.
119 .Sh SEE ALSO
120 .Xr fstat 1 ,
121 .Xr netstat 1 ,
122 .Xr nfsstat 1 ,
123 .Xr ps 1 ,
124 .Xr systat 1 ,
125 .Xr iostat 8 ,
126 .Xr pppstats 8 ,
127 .Xr pstat 8
128 .Pp
129 The sections starting with ``Interpreting system activity'' in
130 .%T "Installing and Operating 4.3BSD" .