wmisdn/README

   1 This is wmisdn version 1.81
   2 ***************************
   3
   4 (if you're already familiar with wmisdn, you may want to check the CHANGES
   5  file instead)
   6
   7 What it is about and how to use it:
   8 -----------------------------------
   9
  10 wmisdn is a small isdn monitor that can be docked on the WindowMaker dock,
  11 the Afterstep Wharf or KDE2 kappdock, or used in any other window manager as a
  12 standalone window app. It gives some information about a specified ippp
  13 device and lets the user control the connection.
  14 wmisdn supports all current connection modes of an ippp device
  15 (as of Kernel 2.2.10)
  16
  17 off            - the ippp defice has no connection and dialing is disabled
  18 offline        - the ippp device has no connection and is ready to dial
  19 dialing        - the ippp device is trying to establish a connection
  20
  21 online         - the ippp device is connected to a ppp server
  22 fax            - ippp serving fax call
  23 voice          - ippp serving voice call
  24 modem          - ippp working as a modem device
  25 raw            - ippp working as a raw device
  26
  27 Every of the 5 connection states that indicate a connection mode has two
  28 modes - incoming and outgoing.
  29
  30 Additional information about the connection is displayed on a panel toggled
  31 by the small horizontal arrow located on the lower left corner of the main
  32 window. It containts the local and remote ip of the connection, the peer phone
  33 number and channel bundling information.
  34
  35 Connection control:
  36 ~~~~~~~~~~~~~~~~~~~
  37 The connection can be controlled using the three buttons on the upper side of
  38 the main window. The can be toggled either using the small vertical arrow on
  39 the lower left corner or using the -lamps command line option (see below).
  40 The buttons are green, yellow and red. The yellow one cuts the current connection.
  41 The red one does the same, as well as disabling the dialing for the specified
  42 device. The green one triggers the dialing for the specified device.
  43
  44 For those of you who find the lamps to be too small and hard to hit :)) - use
  45 the middle mouse button anywhere on the status display to trigger the
  46 connection on/off.
  47
  48 Channel bundling (aka MPPP):
  49 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  50 If the device shown is a master mppp device (for channel bundling), then the
  51 left mouse button is used to control the master connection and the right mouse
  52 button is used to control the slave connection, i.e. if ippp1 is shown and it
  53 is the master device of ippp2, then pressing the green lamp with the left
  54 mouse button starts the connection of ippp1 (master) while the right mouse
  55 button starts the connection of ippp2 (slave). The same applies to the yellow
  56 lamp.
  57 Please note that starting a slave connection while the master is offline
  58 automatically starts the master connection too. Respectively: stopping the
  59 master connection while the slave is on autimatically stops the slave too.
  60 Another useful thing to know is that you can start/stop your slave connection
  61 while the master connection is on without corrupting any downloads in progress.
  62 The only effect you notice is that your connection becomes faster or slower,
  63 and a small label "bundled" beneath the status display.
  64
  65 NOTE: You must have configured your ISDN system for channel bundling for these
  66       features to work.
  67
  68
  69 Multiple devices:
  70 ~~~~~~~~~~~~~~~~~
  71 As of version 1.7, wmisdn can handle different devices, which can be toggled
  72 by pressing on the device name at the lower right corner of the main window.
  73
  74
  75 Compiling and installing:
  76 -------------------------
  77 If you downloaded wmisdn as a binary, just put it anywhere you want. I'd
  78 recommend /usr/local/bin, but it's only a matter of taste, as long as your
  79 system knows where it is. Please note, that as wmisdn highly depends on the
  80 kernel (especially on the isdn4linux subsystem), a downloaded binary may not
  81 work for your system. In this case, you should use the source.
  82
  83 Detailed instructions for configuring your system (i.e. permissions for device
  84 files etc) as well as compiling from source can be found in the INSTALL file.
  85
  86 Command line options:
  87 ---------------------
  88
  89 Use the -w option if you want to dock wmisdn into the Windowmaker dock.
  90 The -s option is useful for Afterstep and other dock-enabled window managers.
  91
  92 The -dialmode option tells wmisdn which dialmode to use for the device when
  93 the user presses the yellow button requesting that the connection (if any)
  94 is stopped and the dialing is enabled. You can use 'auto' for enabling the
  95 autodialing feature of i4l or manual. If the option is not present wmisdn
  96 tries to get the current setting from the device. If the device's dialmode
  97 setting is set to 'off', indicating that the device has been disabled, the
  98 defualt setting 'auto' is assumed.
  99
 100 The -device option tells which ippp devices should be monitored. The devices
 101 are expected as a comma separated list of device names with NO BLANKS in it,
 102 i.e. "-device ippp0,ippp1,ippp5". The order of the device names is not
 103 important. On most systems the only configured device is ippp0 and this is
 104 the default setting if none specified.
 105 If you want to monitor a slave device (for mppp), you should also specify
 106 it using this option.
 107
 108 The -lamps option causes the connection control buttons to be displayed
 109 directly upon startup, as if some magic hand has pressed the
 110 vertical-arrow-button that toggles them. It is intended for users who need
 111 them permanently. If you have set the hangup timeouts and the default routes
 112 properly, so that dialing and hanging up is performed automatically, you
 113 won't need the control buttons very often and since I find that wmisdn looks
 114 better without them, they don't appear on the default display mode.
 115
 116 The -font option can be used to specify a different font for the info window
 117 and the device display (the default font is the LED-builtin). The font name
 118 must follow the X11 font naming conventions and must be placed in quotation
 119 marks (take a look at xfontsel if you don't know the font names on your
 120 system).
 121
 122 The -usescripts and -path options deal with the scripting feature of wmisdn.
 123 For more information, read the SCRIPTS file.
 124
 125 If it doesn't work:
 126 -------------------
 127
 128 If wmisdn starts and doesn't do what is expected, then take a look at your
 129 syslog messages. In most cases, there will be an error message. Check if the
 130 user rights are set properly (as explained above).
 131 Check your device using the isdnctrl and ifconfig commands.
 132
 133 Bugs, suggestions, etc.:
 134 ------------------------
 135
 136 There surely are some. I'm currently not aware of any, so feel free to mail
 137 me bug reports and suggestions. If you mail a bug report, please
 138 include the output of the following commands:
 139
 140 ifconfig
 141 isdnctrl list <name of you ippp device>
 142 cc -v
 143 uname -a
 144
 145 as well as the name of the Linux distribution you are using.
 146
 147 If you are missing features like real time packet flow graphs or load
 148 diagrams then take a look at wmifs or wmnd. These are really fine applets
 149 that implement these features for any network device, not only ippp and
 150 since they work fine and look good, I'm not planning to implement the same
 151 things in wmisdn.
 152
 153 Credits:
 154 --------
 155
 156 Klaus Steven     - he did a lot of work for bringing 1.7 to 1.8, especially
 157                    an importang bugfix for wmisdn/aplha and the scripting
 158                    feature, and gave me good ideas and advises throughout
 159 Tom Berger       - for helping me with the very early version of wmisdn (0.1 :))
 160                    and giving good ideas (Dialing mode, etc)
 161 Philip Lehman    - skins for wmisdn (coming soon :)
 162 Torsten Hilbrich - status check patch
 163 Jogi             - command line args parsing patch
 164
 165 and many others for their support and suggestions
 166
 167
 168 And:
 169 ----
 170
 171 Enjoy! Please mail me if you find the program useful so I can know if
 172 I should keep maintaining it.
 173
 174 ---------------------------------
 175
 176                                     Tasho
 177
 178                                     tasho.kaletha@gmx.de
 179
 180