Initial import from FreeBSD RELENG_4:
[games.git] / usr.sbin / i4b / isdndebug / isdndebug.8
1 .\"
2 .\" Copyright (c) 1997, 2000 Hellmuth Michaelis. 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 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\"     $Id: isdndebug.8,v 1.11 2000/05/31 08:15:29 hm Exp $
26 .\"
27 .\" $FreeBSD: src/usr.sbin/i4b/isdndebug/isdndebug.8,v 1.8.2.7 2003/03/11 21:13:49 trhodes Exp $
28 .\"
29 .\"     last edit-date: [Wed May 31 10:15:07 2000]
30 .\"
31 .Dd May 31, 2000
32 .Dt ISDNDEBUG 8
33 .Os
34 .Sh NAME
35 .Nm isdndebug
36 .Nd display and control isdn4bsd kernel variables and statistics
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl c
40 .Op Fl e
41 .Op Fl g
42 .Op Fl l Ar layer
43 .Op Fl m
44 .Op Fl q
45 .Op Fl r
46 .Op Fl s Ar value
47 .Op Fl u Ar unit
48 .Op Fl z
49 .Op Fl C
50 .Op Fl Q
51 .Sh DESCRIPTION
52 The
53 .Nm
54 utility is part of the isdn4bsd package and is used to control the level of
55 debugging output of the isdn4bsd kernel part.
56 Every layer of the isdn4bsd kernel uses a debugging mask which can be
57 manipulated using this utility.
58 .Pp
59 A second usage of
60 .Nm
61 is to display and reset chipset specific statistics and/or error counters
62 and and to display and reset the D-channel layer 2
63 (Q.921 LAPD protocol) statistics and error counters.
64 .Pp
65 The following options are available:
66 .Bl -tag -width Ds
67 .It Fl c
68 Display chipset specific statistics and/or error counters.
69 .It Fl e
70 Set debugging mask for the selected layer(s) to display errors only.
71 .It Fl g
72 Get the debugging mask for the selected layer(s).
73 .It Fl l
74 Specify the layer for which a command applies. Default is all layers.
75 .It Fl m
76 Set debugging mask for the selected layer(s) to display all possible
77 debugging messages (maximum output).
78 .It Fl q
79 Display the Q.921 (D-channel layer 2) frame receive/transmit statistics.
80 .It Fl r
81 Set debugging mask for the selected layer(s) to the compiled in default
82 (reset).
83 .It Fl s
84 Set debugging mask for the selected layer(s) to value. Value can be
85 specified in any number base supported by
86 .Xr sscanf 3 .
87 .It Fl u
88 Set the unit numbers for the -c, -q, -C and -Q flags.
89 .It Fl z
90 Set debugging mask for the selected layer(s) to no output at all (zero).
91 .It Fl H
92 Reset the chipset specific statistics and/or error counters to zero.
93 .It Fl Q
94 Reset the Q.921 (D-channel layer 2) frame receive/transmit statistics to zero.
95 .El
96 .Sh FILES
97 /dev/i4bctl
98 .Sh EXAMPLES
99 The command:
100 .Bd -literal -offset indent
101 isdndebug -g
102 .Ed
103 .Pp
104 displays the current debugging level for all ISDN layers
105 .Sh AUTHORS
106 The
107 .Nm
108 utility and this manpage were written by
109 .An Hellmuth Michaelis Aq hm@kts.org .