home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / HATCH / WSM104.ZIP / WSM.DOC < prev    next >
Text File  |  1995-12-02  |  17KB  |  372 lines
  1. ┌────────────────────────────────────────────────────────────────────────────┐
  2. │──────────══─────────────────══────════════════────══──────────══───────────┤
  3. │───────────══───────────────══────══──────────══───════──────════───────────│
  4. │────────────══──────═──────══─────══───────────────══─══────══─══───────────│
  5. │─────────────══────═══────══───────════════════────══──══──══──══───────────│
  6. │──────────────══──══─══──══───────────────────══───══───═══────══───────────│
  7. │───────────────════───════────────══──────────══───══────═─────══───────────│
  8. │────────────────══─────══──────────════════════────══──────────══───────────│
  9. │                                         │
  10. │                         WWIV System Monitor v1.04                          │
  11. │              Copyright (c) 1995 by Cris McRae                 │
  12. │                 All Rights Reserved                 │
  13. │                                         │
  14. └────────────────────────────────────────────────────────────────────────────┘
  15.  
  16. ┌────────────────────────────────────────────────────────────────────────────┐
  17. │░░░░ INTRODUCTION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  18. └────────────────────────────────────────────────────────────────────────────┘
  19.  
  20. WWIV System Monitor Features:
  21.  
  22.   ■ Displays instance information
  23.   ■ Displays BBS statistics
  24.   ■ Chat with users
  25.   ■ Read mail for any user
  26.   ■ View network pending list
  27.   ■ View BBS log files
  28.   ■ View ZLOG activity information
  29.   ■ Built-in screen saver
  30.   ■ Configurable BBS locations
  31.  
  32. WWIV System Monitor (WSM) is a utility that displays information about your
  33. WWIV system.  It will show information about all the instances you are
  34. running, and it also gives you statistics about your BBS.
  35.  
  36. WSM can display information for 1-99 instances of WWIV.  It cannot possibly
  37. display all of this information on one screen, so WSM lets you scroll in a
  38. window with instance information.
  39.  
  40. WSM will adapt to any screen size you want to use, including 80x25 (normal
  41. screen), 80x43, and 80x50.  If you are running more than 5 instances, you
  42. might want to run in 80x43 or 80x50 mode to display more instances per
  43. window.  On a 80x25 screen, only 5 instances will be shown in a window.
  44.  
  45. The limit of 99 instances was implemented to provide more room for the other
  46. instance information.  If you need a copy of this program that supports more
  47. than 99 instances, registered users can ask for a custom compilation.
  48.  
  49. ┌────────────────────────────────────────────────────────────────────────────┐
  50. │░░░░ REQUIREMENTS ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  51. └────────────────────────────────────────────────────────────────────────────┘
  52.  
  53.   ■ 200K free RAM
  54.   ■ WWIV v4.23 or higher
  55.   ■ VGA monitor (if using the screen saver)
  56.  
  57. ┌────────────────────────────────────────────────────────────────────────────┐
  58. │░░░░ INSTALLATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  59. └────────────────────────────────────────────────────────────────────────────┘
  60.  
  61. To install WWIV System Monitor v1.04, you must unzip WSM104.ZIP to your main
  62. WWIV BBS directory.  Here is what should be included in the archive:
  63.  
  64.     WSM     .DOC - WWIV System Monitor v1.04 documentation file
  65.     WSM     .EXE - WWIV System Monitor v1.04 executable file
  66.     REGISTER.LST - List of registered WWIV System Monitor users
  67.     REGISTER.TXT - WWIV System Monitor v1.04 registration form
  68.     FILE_ID .DIZ - File description
  69.  
  70. ┌────────────────────────────────────────────────────────────────────────────┐
  71. │░░░░ CONFIGURATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  72. └────────────────────────────────────────────────────────────────────────────┘
  73.  
  74. The configuration information for WWIV System Monitor is located in WWIV.INI.
  75. If this file already exists, WSM will append it's configuration info to the
  76. end of the file.  Otherwise, it will create it.
  77.  
  78. You must run WSM once in order for the configuration information to be written
  79. to the WWIV.INI file.  Once you have done that, you can edit and add new
  80. options to the WWIV.INI section for WSM.
  81.  
  82. Here is a sample WWIV.INI entry for WSM:
  83.  
  84. [WSM]
  85. POLL_TIME         =10
  86. SCREEN_SAVER         =Yes
  87. SCREEN_SAVER_DELAY   =3
  88. CHAT_ROOM            =Yes
  89. LOCATIONS[99]        =At Matrix Logon Menu
  90. LOCATIONS[100]       =QWK Door
  91.  
  92. An explanation of each line follows:
  93.  
  94. POLL_TIME:
  95. ~~~~~~~~~
  96. This is the default number of seconds between each screen update.  The default
  97. value is 10 seconds.
  98.  
  99. SCREEN_SAVER:
  100. ~~~~~~~~~~~~
  101. This option allows you to turn on the screen saver feature of WSM.  If you are
  102. using DESQview, the screen saver just blanks your screen.  If not using
  103. DESQview, the screen saver basically scrolls the 256 color VGA palette and
  104. looks cool.  Note that if you are using an OS/2 windowed DOS session, the
  105. screen saver will do nothing.  The default for this option is No.
  106.  
  107. If you would like to force the screen to go blank, you may specify Yes,Blank.
  108.  
  109. SCREEN_SAVER_DELAY:
  110. ~~~~~~~~~~~~~~~~~~
  111. This option is only used if you have the SCREEN_SAVER enabled.    This allows
  112. you to configure the number of minutes to wait before initiating the screen
  113. saver.  If no value is given, WSM will default to 5 minutes.
  114.  
  115. CHAT_ROOM:
  116. ~~~~~~~~~
  117. This option is only used if you are using the WWIV source modification that
  118. came with WSM v1.03 or higher to enable external chatting.  If you have
  119. installed that mod, you should enable this feature.  You can then hit Alt-C
  120. to go into chat with the user on the highlighted instance, if they are
  121. available for chat.
  122.  
  123. When you hit Alt-C, you will be asked to input the user number of the person
  124. you want to chat as.  This is normally the #1 sysop account, so it will
  125. default to "1".  This allows other local sysops to chat with users without
  126. appearing to be the #1 sysop.
  127.  
  128. To exit chat, you must type "/q" just like in the regular chat room.
  129. Unregistered copies of WSM will only allow you to chat for 5 minutes.
  130.  
  131. NOTE: The mod may not be required for future (v4.25+) versions of WWIV.  I
  132.       am trying to get external sysop chat support build into WWIV v4.25.
  133.  
  134. LOCATIONS[xxx]:
  135. ~~~~~~~~~~~~~~
  136. This option allows you to define additional locations for your WWIV system.
  137. You should not use this option unless you have modified your WWIV source code
  138. and added new locations at the top of the VARDEC.H WWIV source file.  The
  139. example given above would correspond to these lines in your VARDEC.H file:
  140.  
  141. #define INST_LOC_MATRIX       99
  142. #define INST_LOC_QWK         100
  143.  
  144. You can define up to 100 new locations.  There is one limitation.  They must
  145. fall between 50 and 1000.  For example, you cannot do something like this:
  146.  
  147. #define INST_LOC_MATRIX     5000
  148.  
  149. The location string can be up to 34 characters in length.  If a location
  150. string exceeds this limit, the string will be truncated to 34 characters.
  151.  
  152. One last note about this feature.  You cannot override location descriptions
  153. already built into WSM.  Those locations are stock 4.24 locations, which
  154. include 0-48, and 65535.
  155.  
  156. ┌────────────────────────────────────────────────────────────────────────────┐
  157. │░░░░ USAGE ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  158. └────────────────────────────────────────────────────────────────────────────┘
  159.  
  160. If you are using a multitasker such as Windows, DESQview, or OS/2, you need
  161. to run WWIV System Monitor in a separate window.
  162.  
  163. There are currently no command-line parameters.  All you need to do to run
  164. the program is type WSM.
  165.  
  166. There are many commands available while running WSM.  You can list these
  167. commands by pressing F1 when the program is running.  Here is a list of these
  168. commands:
  169.  
  170.     ESC  Quit
  171.   Alt-A  Shut Down All Instances
  172.   Alt-B  Broadcast Message to All Instances
  173.   Alt-C  Chat with User on Current Instance
  174.   Alt-L  View Logs
  175.   Alt-M  Send Message to Current Instance
  176.   Alt-O  DOS Shell
  177.   Alt-P  Network Pending List
  178.   Alt-R  Read User E-Mail
  179.   Alt-S  Shut Down Current Instance
  180.   Alt-U  User Information
  181.   Alt-X  Fast Exit
  182.   Alt-Z  View ZLOG Information
  183.     [,]  Decrease/Increase Poll Time
  184.  
  185. The Poll Time refers to the number of seconds between each information poll.
  186. In other words, how often WSM updates the information displayed on the screen.
  187.  
  188. It should be noted that the Activity Percentage is not calculated the same
  189. way WWIV calculates activity percentage.  WSM calculates the activity
  190. percentage using the number of minutes since midnight, instead of just
  191. the total number of minutes in the day.
  192.  
  193. For example, if it is 12:00pm, there have only been 12 hours in the current
  194. day.  If your BBS has been active for 4 hours (240 minutes) on this day, then
  195. your BBS has been active 33%.  This is different than how WWIV calculates
  196. activity.  It would tell you your BBS has only been active 16%, because it has
  197. only been active for 4 hours out of 24 hours.  However, your BBS has NOT been
  198. up for 24 hours since midnight.  It has only been up 12 hours (assuming you
  199. haven't taken it down).
  200.  
  201. ┌────────────────────────────────────────────────────────────────────────────┐
  202. │░░░░ COMMAND-LINE USAGE ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  203. └────────────────────────────────────────────────────────────────────────────┘
  204.  
  205. If you would like to shut down instances without loading WSM, you can do so
  206. from the command-line.
  207.  
  208. Here are the parameters:
  209.  
  210.     /A       - Shut down all instances.
  211.     /L<inst> - Displays location of an instance.  Returns the following
  212.                errorlevels:
  213.                0 - Offline
  214.                1 - WFC
  215.                2 - Other location
  216.                3 - Error
  217.     /S<inst> - Shut down a single instance.
  218.     /?       - Help screen
  219.  
  220. ┌────────────────────────────────────────────────────────────────────────────┐
  221. │░░░░ PROGRAM AUTHENTICITY ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  222. └────────────────────────────────────────────────────────────────────────────┘
  223.  
  224. WWIV System Monitor has been archived with PKWARE's PKZIP 2.04g using
  225. Authenticity Verification.  When you unzip the archive, you should see "-AV"
  226. displayed after every file name.  When completed, a message that looks like
  227. this will be displayed:
  228.  
  229. Authentic files Verified!   # KRK282
  230. Cris McRae
  231.  
  232. If this authenticity statement is not displayed, or the authenticity code is
  233. not "KRK282", then you have a copy of WWIV System Monitor that has been
  234. tampered with.    Do >not< use any of the files contained within a tampered
  235. archive, as they may contain viruses, trojans, or other harmful things.
  236.  
  237. WWIV System Monitor has also been encrypted by a powerful encryption program.
  238. If the executable file is tampered with, it will display a CRC warning and
  239. will not run.
  240.  
  241. ┌────────────────────────────────────────────────────────────────────────────┐
  242. │░░░░ COPYRIGHT/LICENSE ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  243. └────────────────────────────────────────────────────────────────────────────┘
  244.  
  245. This document and the program files ("the software") are copyrighted by the
  246. author.  The copyright owner hereby licenses you to use the software given
  247. these restrictions:
  248.  
  249.     ■ The software shall be supplied in its original, unmodified form, which
  250.       includes this documentation;
  251.  
  252.     ■ The software may not be included or bundled with other goods or
  253.       services;
  254.  
  255.     ■ No fee is charged; an exception is granted to non-profit user's
  256.       groups, which are permitted to charge a small fee (not to exceed $5)
  257.       for materials, handling, postage, and general overhead.  No other
  258.       organization is permitted to charge any amount for distribution of
  259.       copies of the software or documentation, or to include copies of the
  260.       software or documentation with sales of their own products.
  261.  
  262. The software and documentation are Copyright (c) 1993-1995 by Cris McRae
  263.  
  264. ┌────────────────────────────────────────────────────────────────────────────┐
  265. │░░░░ REGISTRATION ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  266. └────────────────────────────────────────────────────────────────────────────┘
  267.  
  268. WWIV System Monitor is shareware.  This gives the user an opportunity to
  269. evaluate the program before actually registering the software.    If, after a 30
  270. day period, you wish to continue to use WWIV System Monitor, you are required
  271. to register your copy of WWIV System Monitor with the author.  To register,
  272. please fill out REGISTER.TXT and send it to:
  273.  
  274.     Cris McRae
  275.     P.O. Box 1351
  276.     Burbank, CA  91507
  277.  
  278. Registration is $15.00 US per copy of WWIV System Monitor.
  279.  
  280. Note:  Registration system used is REGKEY.
  281.  
  282. ┌────────────────────────────────────────────────────────────────────────────┐
  283. │░░░░ DISCLAIMER ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  284. └────────────────────────────────────────────────────────────────────────────┘
  285.  
  286. The author makes no warranties, expressed or implied, as to the quality or
  287. performance of this program.  Your use of this program constitutes your
  288. release of the author from liability or litigation for any indirect or
  289. consequential damages arising from the use of this program or its associated
  290. files.
  291.  
  292. In no event will the author be liable to you for any damages, including any
  293. lost profits, lost savings or other incidental or consequential damages
  294. arising out of your use or inability to use the program, or for any claim by
  295. any other party.
  296.  
  297. ┌────────────────────────────────────────────────────────────────────────────┐
  298. │░░░░ REVISIONS ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  299. └────────────────────────────────────────────────────────────────────────────┘
  300.  
  301. Version 1.00 (02/12/95)
  302.   ■ Initial release
  303.  
  304. Version 1.01 (04/17/95)
  305.   ■ Fixed bug in registration routines.  They were left out!
  306.   ■ Fixed problem with the "broadcast to all instances" routine.  I was doing
  307.     it the way WWIV 4.24 does it internally, checking to see if a user has
  308.     their availability flag set.  However, in WSM, we will assume the sysop
  309.     wants to override this setting and force the user to receive the message.
  310.   ■ Added ability to shut down all instances from the command-line.
  311.   ■ Added ability to shut down a specific instance from the command-line.
  312.  
  313. Version 1.02 (06/17/95)
  314.   ■ Fixed memory corruption bug.
  315.     (Bug found by Frank Reid)
  316.   ■ Added command-line help screen.
  317.   ■ Added command-line parameter to display location of a specific instance.
  318.     Location is also returned as an errorlevel.
  319.     (Requested by Calvin)
  320.  
  321. Version 1.03 (11/18/95)
  322.   ■ Added the ability to send messages as System Announcements.
  323.     (Requested by Spam Burger)
  324.   ■ Added the ability to force the screen to blank for the screen saver.
  325.     (Requested by Bob Chilcote)
  326.   ■ Added the ability to chat with users.  Requires modification to the WWIV
  327.     source code.
  328.   ■ Added user information screen.  If you have UEDIT.EXE or PBUEDIT2.EXE
  329.     installed, they will be run instead.
  330.   ■ Added SysOp Mail display which shows how much mail the sysop has waiting.
  331.   ■ Added swapping spawn to provide more memory when shelling to DOS.
  332.   ■ Changed input routine so you can hit ESC to abort entering a message.
  333.  
  334. Version 1.04 (12/02/95)
  335.   ■ Added mail read capability.
  336.   ■ Added network pending list.
  337.   ■ Added log file viewer.
  338.   ■ Added ZLOG viewer.
  339.   ■ Changed swapping spawn from XSPAWN to Ralf Brown's SPAWNO.
  340.   ■ Increased registration fee from $10 to $15.
  341.  
  342. ┌────────────────────────────────────────────────────────────────────────────┐
  343. │░░░░ CREDITS ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
  344. └────────────────────────────────────────────────────────────────────────────┘
  345.  
  346. WWIV System Monitor is Copyright (c) 1995 by Cris McRae
  347. WWIV is Copyright (c) 1988-1995 by Wayne Bell
  348. PKZIP is Copyright (c) 1989-1993 by PKWARE Inc.
  349. REGKEY is Copyright (c) 1992 by Brian Pirie
  350. IniFile Class is Copyright (c) 1993-1995 by Matt Hucke
  351. SPAWNO is Copyright (c) 1990-1992 by Ralf Brown
  352.  
  353. If you have any comments or questions about this program, you can reach me
  354. at the following network addresses:
  355.  
  356.     TerraNET : 1@1
  357.     WWIVnet  : 1@3809
  358.     IceNET   : 1@8857
  359.     WWIVLink : 1@18857
  360.     Internet : cris@bluethun.com
  361.  
  362. If you are a sysop on one of the above WWIV networks, you may also subscribe
  363. to my support sub.  The sub name is "JAFO's Software Support".  The sub type
  364. is JAFOSUP.  This sub is also gated to many other networks by other sysops.
  365.  
  366. You may also call my BBS system:
  367.  
  368.                   Blue Thunder BBS
  369.                         USR 28.8 V.34 Dual Standards
  370.                    Open 24 Hours
  371.                    (818)848-4101
  372.