usr.sbin/isdn/isdnmonitor/isdnmonitor.8

   1 .\" $NetBSD: isdnmonitor.8,v 1.3 2002/01/19 03:18:52 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1999 Hellmuth Michaelis. All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\"     $Id: isdnmonitor.8,v 1.4 2002/07/29 00:54:46 wiz Exp $
  27 .\"
  28 .\" $FreeBSD$
  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 isdnmonitor
  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 .Nm
  48 is used to remotely monitor the operation of the ISDN demon,
  49 .Xr isdnd 8 ,
  50 which manages all ISDN related connection and disconnection of ISDN
  51 devices supported by the isdn4bsd package.
  52 .Pp
  53 The options are as follows:
  54 .Bl -tag -width Ds
  55 .It Fl c
  56 Switch to (curses-) fullscreen mode of operation. In this mode,
  57 .Nm
  58 behaves nearly exactly as
  59 .Xr isdnd 8
  60 in fullscreen mode. In fullscreen mode, entering the control character
  61 .Em Control-L
  62 causes the display to be refreshed and entering
  63 .Em Carriage-Return
  64 or
  65 .Em Enter
  66 will pop-up a command window. Because
  67 .Nm
  68 will not listen to messages while the command window is active,
  69 this command window will disappear automatically after 5 seconds without
  70 any command key press.
  71 .Pp
  72 While the command window is active,
  73 .Em Tab
  74 or
  75 .Em Space
  76 advances to the next menu item. To execute a command, press
  77 .Em Return
  78 or
  79 .Em Enter
  80 for the highlighted menu item, or enter the number corresponding to the
  81 item to be executed or enter the capitalized character in the menu item
  82 description.
  83 .It Fl d
  84 If debugging support is compiled into
  85 .Nm isdnmonitor
  86 this option is used to specify the debugging level.
  87 .\" The debugging level is the sum of the
  88 .\" following values:
  89 .\" .Pp
  90 .\" .Bl -tag -width Ds -compact -offset indent
  91 .\" .It Ar 0x001
  92 .\" general debugging.
  93 .\" .It Ar 0x002
  94 .\" rates calculation.
  95 .\" .It Ar 0x004
  96 .\" timing calculations.
  97 .\" .It Ar 0x008
  98 .\" state transitions.
  99 .\" .It Ar 0x010
 100 .\" retry handling.
 101 .\" .It Ar 0x020
 102 .\" dialing.
 103 .\" .It Ar 0x040
 104 .\" process handling.
 105 .\" .It Ar 0x080
 106 .\" isdn4bsd kernel i/o calls.
 107 .\" .It Ar 0x100
 108 .\" controller and channel busy/free messages.
 109 .\" .It Ar 0x200
 110 .\" isdnmonitor.rc configuration file processing.
 111 .\" .El
 112 .\" .Pp
 113 .\" The value can be specified in any number base supported by the
 114 .\" .Xr sscanf 3
 115 .\" library routine.
 116 .Pp
 117 In addition, this option accepts also the character 'n' as an argument to
 118 disable displaying debug messages on the full-screen display.
 119 .Pp
 120 .It Fl f
 121 Specifying this option causes
 122 .Nm
 123 to write its normal output and - if enabled - debugging output to a file
 124 which name is specified as the argument.
 125 .It Fl l
 126 is used to specify a Unix local domain socket name to be used for communication
 127 between
 128 .Xr isdnd 8
 129 and
 130 .Nm
 131 .It Fl h
 132 is used to specify a hostname or a dotted-quad IP address of a machine
 133 where an
 134 .Xr isdnd 8
 135 is running which should be monitored.
 136 .It Fl p
 137 This option may be used to specify a remote port number in conjunction
 138 with the
 139 .Fl h
 140 option.
 141 .El
 142 .Sh ENVIRONMENT
 143 The following environment variables affect the execution of
 144 .Nm isdnmonitor :
 145 .Bl -tag -width Ds
 146 .It Ev TERM
 147 The terminal type when running in full-screen display mode.
 148 See
 149 .Xr environ 7
 150 for more information.
 151 .El
 152 .Sh EXAMPLES
 153 For a first try, the following command should be used to start
 154 .Nm
 155 to monitor a locally running isdnd:
 156 .Bd -literal -offset indent
 157 isdnmonitor -h localhost
 158 .Ed
 159 .Sh DIAGNOSTICS
 160 Exit status is 0 on success, 1 on error.
 161 .Sh SEE ALSO
 162 .Xr isdnd 8
 163 .Sh AUTHORS
 164 The
 165 .Nm
 166 utility was written by
 167 .An Martin Husemann
 168 and
 169 .An Hellmuth Michaelis .
 170 This manual page was written by
 171 .An Hellmuth Michaelis Aq hm@kts.org .