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