Fix some NULL pointer dereferences, most of the in debug code though.
[dragonfly/netmp.git] / usr.sbin / slstat / slstat.8
blob2a789fc12fd1be6f292fa5ede72fcf864e6b48d7
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.4 2008/05/02 02:05:08 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 .Bl -tag -width indent
83 .It in
84 bytes received
85 .It out
86 bytes sent
87 .It pack
88 packets received or sent
89 .It comp
90 compressed packets received or sent
91 .It uncomp
92 uncompressed packets received or sent
93 .It unknwn
94 inbound packets of unknown type
95 .It toss
96 inbound packets tossed because of error
97 .It other
98 all other inbound or outbound ip packets
99 .It err
100 input or output errors
101 .It search
102 searches for connection state
103 .It miss
104 times we could not find a connection state
105 .It coll
106 collisions with end of clists.
107 If you get many collisions (more than one or two
108 a day) you probably do not have enough clists
109 and you should increase
110 .Dv nclist
111 in param.c.
113 .Sh EXAMPLES
114 The command:
115 .Dl slstat -i 5
116 will print what the system is doing every five
117 seconds.
118 .Sh SEE ALSO
119 .Xr fstat 1 ,
120 .Xr netstat 1 ,
121 .Xr nfsstat 1 ,
122 .Xr ps 1 ,
123 .Xr systat 1 ,
124 .Xr iostat 8 ,
125 .Xr pppstats 8 ,
126 .Xr pstat 8
128 The sections starting with ``Interpreting system activity'' in
129 .%T "Installing and Operating 4.3BSD" .