home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 7 / FreshFishVol7.bin / bbs / comm / fidomon-1.0.lha / FidoMon / FidoMon.doc < prev    next >
Text File  |  1994-09-12  |  21KB  |  469 lines
  1.  
  2.  
  3.  
  4.                             FidoMon Version 1.0
  5.                Copyright September, 1994 by Elton VonCannon
  6.  
  7.  
  8.  
  9. ---------------------------------------------------------------------------
  10.                                Introduction:
  11. ---------------------------------------------------------------------------
  12.  
  13. FidoMon   provides  a  real-time  display  of  TrapDoor's  inbound/outbound
  14. directories.   It  provides  a  simple mechanism to change NetMail and Flow
  15. file  status, and it can execute a user defined polling script based on the
  16. address of a selected file.  It also provides FidoNet file type and address
  17. information  at a glance, and even more information is often available with
  18. a  few clicks of a mouse button.  Finally, it provides a mechanism by which
  19. a  user  can edit some of FidoNet's text based files without worrying about
  20. the   carriage  return/line  feed  conversions  that  are  often  otherwise
  21. necessary for FidoNet files.
  22.  
  23.  
  24. ---------------------------------------------------------------------------
  25.                                 Disclaimer:
  26. ---------------------------------------------------------------------------
  27.  
  28. This  software is provided "as is", with no warranty of any kind.  Although
  29. every  effort  has  been made to ensure the quality of this software, in no
  30. event  will  the  author,  Elton VonCannon, be liable for direct, indirect,
  31. incidental  or consequential damages or data loss resulting from its use or
  32. application.   The entire risk as to the results and/or performance of this
  33. software is assumed by you, the user.
  34.  
  35.  
  36. ---------------------------------------------------------------------------
  37.                           Licensing Requirements:
  38. ---------------------------------------------------------------------------
  39.  
  40. This  program  is  copyrighted  material  and  is  not placed in the public
  41. domain.   You  are authorized to use FidoMon for any legal purpose, as long
  42. as you don't modify it in any way.  You may also distribute the archive for
  43. any  non-commercial  purpose  as  long as its contents remain unaltered and
  44. intact.   Any  commercial  distribution,  with the exception of Fred Fish's
  45. disks, requires the explicit permission of the author.
  46.  
  47. FidoMon is being released as shareware.  If you use it, you're requested to
  48. suggest  how to improve it.  Without your support, I will not be making any
  49. enhancements to FidoMon.
  50.  
  51.  
  52. ---------------------------------------------------------------------------
  53.                         Operational Considerations:
  54. ---------------------------------------------------------------------------
  55.  
  56. My  utmost  concern  was to make FidoMon as unobtrusive to the operation of
  57. TrapDoor  as possible.  If FidoMon crashed the system or trashed (or caused
  58. another  application  to  trash) an important file or if it interfered with
  59. TrapDoor's  file  transfers in any way, it would be worthless to myself and
  60. any   potential  users.   Therefore  FidoMon  checks  the  inbound/outbound
  61. directories only about once every 3-4 seconds (sometimes longer).  Patience
  62. is definitely a virtue when file transfers are involved.
  63.  
  64.  
  65. ---------------------------------------------------------------------------
  66.                            System Requirements:
  67. ---------------------------------------------------------------------------
  68.  
  69. AmigaDos version 2.1 or higher.
  70. TrapDoor version 1.83 or higher.
  71. TrapList.library version 4 or higher.
  72. ReqTools.library version 2 or higher.
  73.  
  74. FidoMon  also  requires  an  assignment  to  logical  device  "T:"  for its
  75. temporary  Info and Edit files.  Ideally, this would be made to a directory
  76. somewhere on a fast device (such as RAM:).
  77.  
  78. An external ASCII text editor such as Ed, CED, MicroEmacs, or TurboText.
  79. An external ASCII text reader such as More (or you can just use an editor).
  80. An external dialing program (for calling with TrapDoor).
  81.  
  82. In  addition,  FidoMon  needs the following directories in order to perform
  83. its magic (these are required by TrapDoor anyway but you may need to inform
  84. FidoMon of your paths, if they are other than the defaults listed here):
  85.   Inbound directory  - defaults to "Mail:Inbound/"
  86.   Outbound directory - defaults to "Mail:Outbound/"
  87.   NodeList directory - defaults to "NodeList:"
  88. Note:   If  your  system already uses these defaults for TrapDoor, you need
  89. not specify them to FidoMon.
  90.  
  91.  
  92. ---------------------------------------------------------------------------
  93.                                    Bugs:
  94. ---------------------------------------------------------------------------
  95.  
  96. None known, but...
  97.  
  98.  -  Some  might  consider HiJack mode's behavior when FidoMon exits to be a
  99.     bug,  but  since  this  behavior is  predictable  (and  even documented
  100.     below), I don't.
  101.  
  102.  -  If  FidoMon  opens  a file and TrapDoor immediately tries to delete it,
  103.     TrapDoor  may  not be able to.  This isn't a bug,  this is just the way
  104.     that  a  multitasking filing system works.  My advice is that you don't
  105.     try reading any files at the same time that TrapDoor is sending them.
  106.  
  107.  
  108. ---------------------------------------------------------------------------
  109.                                Installation:
  110. ---------------------------------------------------------------------------
  111.  
  112.  1.  Copy it to a location where you'll be able to find it again.  :-)
  113.  
  114.  2.  If you want FidoMon's window to appear on TrapDoor's screen, you will
  115.      also need to add the following lines to TrapDoor's configuration file
  116.      if they do not already exist:
  117.        a.  Add the line "SCREENMODE PUBLIC".
  118.        b.  Add the line "PUBLICSCREENNAME TrapDoor".  (Note:  Screen names
  119.            other  than  "TrapDoor" are perfectively acceptable also.  Just
  120.            take  note of the  name so that you can tell FidoMon what it is
  121.            later.)
  122.      NOTE: Depending on your operating system version, the screen name may
  123.            be case sensitive.
  124.  
  125.  
  126. ---------------------------------------------------------------------------
  127.                              Starting FidoMon:
  128. ---------------------------------------------------------------------------
  129.  
  130. FidoMon  is  a CLI (or shell) only program.  If you really want to start it
  131. from  Workbench,  you  could  probably create a script and execute it using
  132. IconX, but I haven't tried that.
  133.  
  134. When  you  start FidoMon, you do NOT want to use "RunBack" (or even "Run").
  135. Just type "FidoMon" and hit return and FidoMon will "RunBack" itself.
  136.  
  137. NOTE:   If  you  rename  FidoMon, it will refuse to run correctly.  If this
  138. causes any problems, let me know and I'll address it in a later release.
  139.  
  140.  
  141. If  you  type "FidoMon ?", FidoMon will display a multitude of command line
  142. options  that aren't described here, but you are only required to provide a
  143. public  screen  name in order to get started.  If you already have TrapDoor
  144. running  on a public screen named "TrapDoor" and if your inbound, outbound,
  145. and  NodeList  directory  paths  are "Mail:Inbound/", "Mail:Outbound/", and
  146. "NodeList:"  then  you  won't  have  to  worry  about telling FidoMon about
  147. anything  at  all (you can set up everything else via the program's menus).
  148. Otherwise, FidoMon may ask you for the paths to your inbound, outbound, and
  149. NodeList   directories.    If   the   default   paths   "Mail:Inbound"  and
  150. "Mail:Outbound"  exist,  and  for  some  reason  you aren't using them with
  151. TrapDoor,  you  can  change  them  via  a menu from within FidoMon (or just
  152. specify the correct paths on the command line to begin with).
  153.  
  154. After  FidoMon  is  running, you can save all of its user definable options
  155. (including  its  window  position)  in  a  convenient  configuration  file.
  156. Thereafter,  whenever  FidoMon  is  started,  it will automatically get its
  157. information  from  this configuration file (although you will still be able
  158. to  override any pre-configured options from the command line when you next
  159. start  FidoMon,  or  you can just change them from within the program using
  160. its menus...  The menus are described in a later section).
  161.  
  162. See  the  "The  Configuration Options Menu" section for more information on
  163. customizing your installation.
  164.  
  165.  
  166.  
  167. ---------------------------------------------------------------------------
  168.