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