b4ffe140d69ed1527f3014ae1452144bd840d1c3
[dragonfly.git] / usr.sbin / i4b / isdntest / isdntest.8
1 .\"
2 .\" Copyright (c) 1997, 1999 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: isdntest.8,v 1.10 1999/12/13 22:11:55 hm Exp $
26 .\"
27 .\" $FreeBSD: src/usr.sbin/i4b/isdntest/isdntest.8,v 1.7.2.7 2003/03/11 21:13:49 trhodes Exp $
28 .\" $DragonFly: src/usr.sbin/i4b/isdntest/isdntest.8,v 1.2 2003/06/17 04:29:55 dillon Exp $
29 .\"
30 .\"     last edit-date: [Mon Dec 13 23:07:23 1999]
31 .\"
32 .Dd December 10, 1999
33 .Dt ISDNTEST 8
34 .Os
35 .Sh NAME
36 .Nm isdntest
37 .Nd isdn4bsd debugging and verification tool
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl c Ar unit
41 .Op Fl d Ar level
42 .Op Fl i Ar number
43 .Op Fl h
44 .Op Fl o Ar number
45 .Op Fl t Ar num
46 .Op Fl w
47 .Sh DESCRIPTION
48 The
49 .Nm
50 utility is part of the isdn4bsd package and may be used as a stimulation tool
51 for debugging the isdn4bsd kernel functionality.
52 .Pp
53 NOTE:
54 The
55 .Nm
56 utility must be run
57 .Em instead
58 of the
59 .Xr isdnd 8
60 daemon and cannot be used while the daemon runs.
61 .Pp
62 The following options are available:
63 .Bl -tag -width Ds
64 .It Fl c
65 Use controller unit number for test.
66 .It Fl d
67 Set the debugging level
68 .It Fl h
69 Use HDLC as the B channel layer 1 protocol instead of no protocol.
70 .It Fl i
71 Use number to verify the incoming number.
72 .It Fl o
73 Use number as the outgoing number to dial.
74 .It Fl t
75 Set number of times the test pattern on the B-channel is exchanged
76 .It Fl w
77 Wait for keyboard input for terminating the call.
78 .El
79 .Pp
80 The
81 .Nm
82 utility is currently of not much use for end users, it is primarily a debugging
83 tool for development and is part of the release in the hope, that someone
84 enhances it as a real self test and setup-verification tool!
85 .Pp
86 The
87 .Nm
88 utility does almost no error checking and error recovery, so unexpected
89 hangs or crashes may occur.
90 .Sh EXAMPLES
91 For the following example, it is assumed that a machine with isdn4bsd
92 installed is connected to an S0 bus and that one of the valid MSN's (MSN = Multiple Subscriber Number
93 = telephone number) on this bus is
94 .Em 42 .
95 The
96 .Xr isdnd 8
97 .Em must
98 not currently running on that machine! Executing:
99 .Bd -literal -offset indent
100 isdntest -i 42 -o 42
101 .Ed
102 .Pp
103 will setup an outgoing call from that machine to itself, connect to itself
104 and disconnect after 5 seconds.
105 The
106 .Nm
107 utility has to be finished by the user by entering Control-C.
108 .Sh FILES
109 .Bl -tag -width indent
110 .It Pa /dev/i4b
111 .El
112 .Sh AUTHORS
113 The
114 .Nm
115 utility and this manpage were written by
116 .An Hellmuth Michaelis Aq hm@kts.org .