Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.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 .\" $DragonFly: src/usr.sbin/i4b/isdndebug/isdndebug.8,v 1.2 2003/06/17 04:29:54 dillon Exp $
29 .\"
30 .\"     last edit-date: [Wed May 31 10:15:07 2000]
31 .\"
32 .Dd May 31, 2000
33 .Dt ISDNDEBUG 8
34 .Os
35 .Sh NAME
36 .Nm isdndebug
37 .Nd display and control isdn4bsd kernel variables and statistics
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl c
41 .Op Fl e
42 .Op Fl g
43 .Op Fl l Ar layer
44 .Op Fl m
45 .Op Fl q
46 .Op Fl r
47 .Op Fl s Ar value
48 .Op Fl u Ar unit
49 .Op Fl z
50 .Op Fl C
51 .Op Fl Q
52 .Sh DESCRIPTION
53 The
54 .Nm
55 utility is part of the isdn4bsd package and is used to control the level of
56 debugging output of the isdn4bsd kernel part.
57 Every layer of the isdn4bsd kernel uses a debugging mask which can be
58 manipulated using this utility.
59 .Pp
60 A second usage of
61 .Nm
62 is to display and reset chipset specific statistics and/or error counters
63 and and to display and reset the D-channel layer 2
64 (Q.921 LAPD protocol) statistics and error counters.
65 .Pp
66 The following options are available:
67 .Bl -tag -width Ds
68 .It Fl c
69 Display chipset specific statistics and/or error counters.
70 .It Fl e
71 Set debugging mask for the selected layer(s) to display errors only.
72 .It Fl g
73 Get the debugging mask for the selected layer(s).
74 .It Fl l
75 Specify the layer for which a command applies. Default is all layers.
76 .It Fl m
77 Set debugging mask for the selected layer(s) to display all possible
78 debugging messages (maximum output).
79 .It Fl q
80 Display the Q.921 (D-channel layer 2) frame receive/transmit statistics.
81 .It Fl r
82 Set debugging mask for the selected layer(s) to the compiled in default
83 (reset).
84 .It Fl s
85 Set debugging mask for the selected layer(s) to value. Value can be
86 specified in any number base supported by
87 .Xr sscanf 3 .
88 .It Fl u
89 Set the unit numbers for the -c, -q, -C and -Q flags.
90 .It Fl z
91 Set debugging mask for the selected layer(s) to no output at all (zero).
92 .It Fl H
93 Reset the chipset specific statistics and/or error counters to zero.
94 .It Fl Q
95 Reset the Q.921 (D-channel layer 2) frame receive/transmit statistics to zero.
96 .El
97 .Sh FILES
98 /dev/i4bctl
99 .Sh EXAMPLES
100 The command:
101 .Bd -literal -offset indent
102 isdndebug -g
103 .Ed
104 .Pp
105 displays the current debugging level for all ISDN layers
106 .Sh AUTHORS
107 The
108 .Nm
109 utility and this manpage were written by
110 .An Hellmuth Michaelis Aq hm@kts.org .