home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / programs / comms_networking / pppmon / !ReadMe next >
Text File  |  1998-12-15  |  6KB  |  199 lines
  1.                            PPPMon V0.12
  2.                            ~~~~~~~~~~~~
  3.  
  4. Index
  5. ~~~~~
  6.  
  7.     1    Introduction & Installation
  8.     2    Usage
  9.     2.1  Starting up
  10.     2.2  The Wimp task
  11.     3    Disclaimer & Licensing
  12.     4    Bug Reports
  13.     5    History
  14.  
  15.   
  16. 1 Introduction & Installation
  17.   ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18.  
  19. PPPMon is a module that adds a new text box to the Voyager toolbar
  20. the shows either the total bytes transmitted and received during
  21. the current connection, or the current reception and transmission
  22. rates.
  23.  
  24. To install PPPMon, open the Voyager iconbar icon menu, and select
  25. Preference->VIX Manager. Drop the PPPMoo/vix file onto the arrow,
  26. and installation will proceed.
  27.  
  28.  
  29. 2 Usage
  30.   ~~~~~
  31.  
  32. PPPMon provides both a Wimp task (which does the monitoring) and
  33. a new command "pppmon" which can be used to configure it.
  34.  
  35. The syntax of the new command is:
  36.  
  37. pppmon <flags> [<update> [<timeout>]]
  38.  
  39. The first parameter, flags, acts like the BASIC 'LISTO' command -
  40. i.e. it is a set of (currently) 3 switches, set by the values of
  41. the least significant bits:
  42.  
  43.   Bit    Meaning
  44.   0 (1)  Clear: The Voyager toolbar shows the total bytes transmitted
  45.                 and received.
  46.          Set  : The toolbar shows the current tx/rx rates.
  47.        
  48.   1 (2)  If set, PPPMon will display a warning message when the tx/rx
  49.          rates have both been zero for a specified time (if the
  50.          timeout parameter is zero, a default of 30 seconds is used
  51.          for the delay).
  52.        
  53.   2 (4)  If set, PPPMon will sound a beep as well as displaying the
  54.          warning message. If bit 1 is clear, setting this bit has
  55.          no effect.
  56.  
  57. Examples:
  58.  
  59.  Flags   Meaning
  60.    1     Display the rx/tx rates. Do not give a warning when the modem
  61.          goes idle.
  62.          
  63.    2     Display total bytes transferred. Give a warning message, but
  64.          no audio tone, when the modem goes idle.
  65.          
  66.    7     Display rx/tx rates. Give a warning message and beep when the
  67.          modem goes idle.
  68.  
  69.  
  70. The second (optional) parameter gives the time (in cs) between updates
  71. of the data.
  72.  
  73. The third (optional) paramter is the number of seconds that the rx/tx
  74. rates must be zero before displaying a warning message.
  75.  
  76. All parameters must be integers, greater than or equal to zero; any
  77. other values will generate an error. However, if <update> is > 500
  78. (5 secs), a value of 500 will be used.
  79.  
  80. An update of zero is interpreted as "No change" (so you can alter
  81. the timeout value without changing the update rate).
  82.  
  83.  
  84. NB. It is perfectly legal to change these parameters while connected;
  85. the change will take affect the next time the display is updated.
  86.  
  87. NNB. If the modem goes idle, causing the warning window to be displayed,
  88. and the modem then becomes active again, the window will automatically
  89. be closed.
  90.  
  91. 2.1 Starting up
  92.     ~~~~~~~~~~~
  93.  
  94. PPPMon is automatically started when Voyager is run, and the same
  95. parameters can be passed into the module (when the module is run,
  96. it is legal to provide no parameters - in this case <rate> will be
  97. assumed to be zero and <update> will be 100).
  98.  
  99. As distributed, PPPMon will be started with flags=7, update=25. If
  100. these values are not to your liking, you can change these default
  101. settings by editing the !Voyager.VIX.PPPMon.!Boot file; it should
  102. be obvious how to do this.
  103.  
  104.  
  105. 2.2 The wimp task
  106.     ~~~~~~~~~~~~~
  107.  
  108. It is now possible to kill the wimp task off using the Task Manager
  109. window, but this will not kill off the module; you must use RMKill
  110. to do this.
  111.  
  112. If the task or module has been killed off, Voyager will restart it
  113. the next time you connect - it will restart with the same parameters
  114. as the last setting. If, however, you quit Voyager the settings are
  115. lost, and the next time Voyager is started PPPMon will have the
  116. parameters set in the PPPMon !Boot file.
  117.  
  118.  
  119. 3 Disclaimer & Licensing
  120.   ~~~~~~~~~~~~~~~~~~~~~~
  121.  
  122. PPPMon is distributed as is, and the author will not accept any
  123. responsibility for any resultant damage, whatever its form.
  124.  
  125. PPPMon is FREEWARE, not Public Domain. It should only be copied
  126. and/or distributed in its entirety (including this document),and
  127. copyright remains with me.
  128.  
  129.  
  130. 4 Bug Reports
  131.   ~~~~~~~~~~~
  132.  
  133. Irrespective of the formal disclaimer above, I am perfectly
  134. happy to receive emails describing any bugs discovered, and I
  135. will do my best to fix them quickly. Please try to be precise
  136. as to what went wrong - what you (and Voyager) were doing, what
  137. aberrant behaviour resulted, etc.
  138.  
  139.  
  140. Nick Roberts
  141. tigger@argonet.co.uk
  142.  
  143.  
  144. 5 History
  145.   ~~~~~~~
  146.  
  147.    Vrsn   Description
  148.  
  149.    0.01   First release version (possibly a bit beta!)
  150.    0.02   Slight change to formatting of results
  151.  
  152.           Can now kill off the task using the Task Manager
  153.           (but this leaves the module in RMA, and the task
  154.           cannot be restarted).
  155.           
  156.           Total bytes tx/rx and peak rate send to Voyager
  157.           log window.
  158.           
  159.    0.03   Improved obey file to avoid "Module not found"
  160.           on Voyager quit if PPPMon has been RMKill'd.
  161.           (with thanks to Adny!).
  162.           
  163.           Altered VIX Id so it doesn't clash with AddNewsHdr
  164.           
  165.           Corrected idiotic error in computation of transfer
  166.           rate.
  167.           
  168.           Added CRC error count to Voyager window log.
  169.           
  170.    0.04   Very flakey development version, supposedly able to
  171.           restart the task from an obey file; not distributed.
  172.           
  173.    0.05   Fix to flakiness in 0.04 - it now seems to work!
  174.           (With oodles of thanks to Adny for suggestions!)
  175.           
  176.           Error statistics, if any, sent to Voyager window log.
  177.  
  178.    0.06   Fixed bug which demanded that changes to the !Boot
  179.           parameters needed to be duplicated in the !Restart
  180.           file.
  181.  
  182.    0.07   Added "timeout" handling. Limited beta release.
  183.    
  184.    0.08   Modified shutdown reporting to Voyager window log to
  185.           drop one "unwanted" frame - this is always present,
  186.           so reporting it as an error is misleading.
  187.           
  188.    0.09   Timeout window now moveable; audio warning can now
  189.           be configured on or off by first parameter flags.
  190.           
  191.    0.10   Corrected syntax message (for *HELP)
  192.           Added syntax for Vicen !help
  193.           
  194.    0.11   There are occasions when there isn't a spare
  195.           unwanted frame (leading to minus 1 errors). Hence,
  196.           the unwanted frame is only dropped if there is
  197.           exactly one of them.
  198.  
  199.    0.12   Duration of idle time added to timeout window.