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