ab650eeaa1a0a80e41412537044fc96bbf62507d
[dragonfly.git] / usr.sbin / i4b / isdnmonitor / isdnmonitor.8
1 .\"
2 .\" Copyright (c) 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: isdnmonitor.8,v 1.8 1999/12/13 22:11:55 hm Exp $
26 .\"
27 .\" $FreeBSD: src/usr.sbin/i4b/isdnmonitor/isdnmonitor.8,v 1.8.2.6 2003/03/11 21:13:49 trhodes Exp $
28 .\" $DragonFly: src/usr.sbin/i4b/isdnmonitor/isdnmonitor.8,v 1.2 2003/06/17 04:29:55 dillon Exp $
29 .\"
30 .\"     last edit-date: [Mon Dec 13 23:04:25 1999]
31 .\"
32 .Dd September 25, 1999
33 .Dt ISDNMONITOR 8
34 .Os
35 .Sh NAME
36 .Nm isdnmonitor
37 .Nd isdn4bsd / isdnd remote monitoring tool
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl c
41 .Op Fl d Ar debuglevel
42 .Op Fl f Ar filename
43 .Op Fl h Ar hostspec
44 .Op Fl l Ar pathname
45 .Op Fl p Ar portspec
46 .Sh DESCRIPTION
47 The
48 .Nm
49 utility is used to remotely monitor the operation of the isdn daemon,
50 .Xr isdnd 8 ,
51 which manages all ISDN related connection and disconnection of ISDN
52 devices supported by the isdn4bsd package.
53 .Pp
54 The options are as follows:
55 .Bl -tag -width Ds
56 .It Fl c
57 Switch to (curses-) fullscreen mode of operation. In this mode,
58 .Nm
59 behaves nearly exactly as
60 .Xr isdnd 8
61 in fullscreen mode. In fullscreen mode, entering the control character
62 .Em Control-L
63 causes the display to be refreshed and entering
64 .Em Carriage-Return
65 or
66 .Em Enter
67 will pop-up a command window. Because
68 .Nm
69 will not listen to messages while the command window is active,
70 this command window will disappear automatically after 5 seconds without
71 any command key press.
72 .Pp
73 While the command window is active,
74 .Em Tab
75 or
76 .Em Space
77 advances to the next menu item. To execute a command, press
78 .Em Return
79 or
80 .Em Enter
81 for the highlighted menu item, or enter the number corresponding to the
82 item to be executed or enter the capitalized character in the menu item
83 description.
84 .It Fl d
85 If debugging support is compiled into
86 .Nm
87 this option is used to specify the debugging level.
88 .\" The debugging level is the sum of the
89 .\" following values:
90 .\" .Pp
91 .\" .Bl -tag -width Ds -compact -offset indent
92 .\" .It Ar 0x001
93 .\" general debugging.
94 .\" .It Ar 0x002
95 .\" rates calculation.
96 .\" .It Ar 0x004
97 .\" timing calculations.
98 .\" .It Ar 0x008
99 .\" state transitions.
100 .\" .It Ar 0x010
101 .\" retry handling.
102 .\" .It Ar 0x020
103 .\" dialing.
104 .\" .It Ar 0x040
105 .\" process handling.
106 .\" .It Ar 0x080
107 .\" isdn4bsd kernel i/o calls.
108 .\" .It Ar 0x100
109 .\" controller and channel busy/free messages.
110 .\" .It Ar 0x200
111 .\" isdnmonitor.rc configuration file processing.
112 .\" .El
113 .\" .Pp
114 .\" The value can be specified in any number base supported by the
115 .\" .Xr sscanf 3
116 .\" library routine.
117 .Pp
118 In addition, this option accepts also the character 'n' as an argument to
119 disable displaying debug messages on the full-screen display.
120 .Pp
121 .It Fl f
122 Specifying this option causes
123 .Nm
124 to write its normal output and - if enabled - debugging output to a file
125 which name is specified as the argument.
126 .It Fl l
127 is used to specify a Unix local domain socket name to be used for communication
128 between
129 .Xr isdnd 8
130 and
131 .Nm .
132 .It Fl h
133 is used to specify a hostname or a dotted-quad IP address of a machine
134 where an
135 .Xr isdnd 8
136 is running which should be monitored.
137 .It Fl p
138 This option may be used to specify a remote port number in conjunction
139 with the
140 .Fl h
141 option.
142 .El
143 .Sh ENVIRONMENT
144 The following environment variables affect the execution of
145 .Nm :
146 .Bl -tag -width Ds
147 .It Ev TERM
148 The terminal type when running in full-screen display mode.
149 See
150 .Xr environ 7
151 for more information.
152 .El
153 .Sh EXAMPLES
154 For a first try, the following command should be used to start
155 .Nm
156 to monitor a locally running isdnd:
157 .Bd -literal -offset indent
158 isdnmonitor -h localhost
159 .Ed
160 .Sh DIAGNOSTICS
161 Exit status is 0 on success, 1 on error.
162 .Sh SEE ALSO
163 .Xr isdnd 8
164 .Sh BUGS
165 Still one (or) more left.
166 .Sh AUTHORS
167 .An -nosplit
168 The
169 .Nm
170 utility was written by
171 .An Martin Husemann
172 and
173 .An Hellmuth Michaelis Aq hm@kts.org .
174 This manual page was written by
175 .An Hellmuth Michaelis .