home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / top2src.zip / TOPMAINT.ZIP / TOPMAINT.DOC < prev   
Text File  |  1996-11-07  |  8KB  |  186 lines
  1.  
  2.                                 TOPMaint v2.00a
  3.                      User Maintenance Utility for TOP v2.00
  4.  
  5.     Introduction
  6.     ------------
  7.  
  8.     TOPMaint is simple utility that lets you manage your TOP v2.00 user file.
  9. It replaces the crude TOP EDIT and TOP PACK modes in TOP v2.00 and adds some
  10. extra functionality as well.
  11.  
  12.     TOPMaint requires The Online Pub v2.00.  It should also work with v2.00g1
  13. and might even work with RAP (RA Pub) v1.82/v1.82a, but it has only been tested
  14. with TOP v2.00.
  15.  
  16.     Though TOPMAINT.EXE is a DOS program, it will work with the DOS, OS/2, and
  17. Win95 versions of TOP.
  18.  
  19.     Installation
  20.     ------------
  21.  
  22.     Installation of TOPMaint is very easy.  Simply unpack the entire contents
  23. of the TOPMaint Distribution Archive (TMTD200A.ARJ, or .ZIP, etc.) to your main
  24. TOP directory (the same one with TOP.EXE and USERS.TOP).
  25.  
  26.     Operation
  27.     ---------
  28.  
  29.     TOPMaint features four modes of operation, which are described briefly
  30. below:
  31.  
  32.     DELETE mode lets you delete a user from USERS.TOP.  It works much like the
  33. crude user deletor in TOP EDIT mode, but is a lot easier to use.
  34.  
  35.     PURGE mode is a new feature which lets you remove idle or "twit" users from
  36. the user file.  By specifying a number of days, you can delete users that have
  37. not entered TOP in a certain number of days.  By specifying a minimum security
  38. level, you can instruct TOP to delete all users who's security is less that
  39. that level.  Specifying both allows you to perform idle deletion on users while
  40. "protecting" those users with a high enough security, for example sysops,
  41. subops, or paid users.
  42.  
  43.     PACK mode is identical to the TOP PACK mode that is built into TOP.  It
  44. should always be used instead of TOP PACK, as it runs faster and is more
  45. suitable for batch file operation.
  46.  
  47.     SETSEC mode works the same as the SYSOP SETSEC command inside TOP.  It
  48. replaces the extremely crude "set user to 65535 security" option in TOP EDIT
  49. mode, which makes it a lot easier to upgrade sysops and other users.
  50.  
  51.     The specific operation of each mode is explained in TOPMAINT.EXE itself.
  52. Simply run TOPMaint as follows to get a list of commands:
  53.  
  54. TOPMAINT ?
  55.  
  56.     WARNING:  No users must be inside TOP while TOPMaint is running!  Running
  57. TOPMaint while users are chatting in TOP can permanently damage your user file!
  58.  
  59.     Tips, Suggestions, and Warnings
  60.     -------------------------------
  61.  
  62.     Below are some tips and suggested uses for TOPMaint, as well as warnings
  63. about what TOPMaint can and can't do.
  64.  
  65.     - Always backup your user file (USERS.TOP) before running TOPMaint.
  66. TOPMaint does not do very much errorchecking (to keep it small and fast), so if
  67. a problem arises it could spell big trouble for your user file.  The simplest
  68. and safest way to avert this is to use the following line (either manually or
  69. in a batch file) before TOPMaint is run:
  70.  
  71. COPY USERS.TOP USERS.BAK
  72.  
  73.     This will backup your user file.  Be sure that no users are inside TOP
  74. before this command is run.  See below for details on how to do this in a batch
  75. file.
  76.  
  77.     - The PURGE and PACK modes of TOPMaint are best suited for inclusion in
  78. the nightly maintenance batch file that most BBSs use.  Here is an example
  79. snippet from a batch file:
  80.  
  81. COPY USERS.TOP USERS.BAK
  82. TOPMAINT PURGE /S10000 /D30
  83. TOPMAINT PACK
  84.  
  85.     Replace 10000 with the sysop, cosysop, or subop security (whichever is
  86. lowest) so important users will not be deleted.  Replace 30 with the number of
  87. days that you wish to allow users to remain idle before they are deleted.
  88. Ideally, this latter figure should be the same number of days that you delete
  89. idle users from your BBS entirely, if you do so.
  90.  
  91.     - Because TOPMaint can't be run while users are inside TOP, if you are
  92. using TOPMaint in your nightly maintenance and nodes are allowed to remain
  93. logged into the system while maintenance is running, you will have to take
  94. special steps to allow TOPMaint to be run.  First, change the batch file used
  95. to call TOP.EXE as follows:
  96.  
  97. CD \BBS\TOP
  98. ECHO . > TOP%1.FLG
  99. TOP %1
  100. DEL TOP%1.FLG
  101.  
  102.     Note that to use this batch file, you must pass the node number to the
  103. batch file as the first parameter.  This batch file creates simple semaphore
  104. flags while a user is in TOP, and deletes them once TOP finishes running.  You
  105. can then perform the following check in your nightly maintenance batch file to
  106. make sure no users are in TOP before running TOPMaint:
  107.  
  108. CD \BBS\TOP
  109. if not exist TOP*.FLG TOPMAINT PURGE /S10000 /D30
  110. if not exist TOP*.FLG TOPMAINT PACK
  111.  
  112.     - TOPMaint does not log its activities.  However, you can maintain a record
  113. of what TOPMaint does by using some fancy batch file work.  Below is an example
  114. of a nightly maintenance batch file snippet that runs TOPMaint and logs its
  115. activities.
  116.  
  117. CD \BBS\TOP
  118. TOPMAINT PURGE /S10000 /D30 > TMPLOG
  119. COPY TOPMAINT.LOG + TMPLOG TOPMAINT.LOG
  120. TOPMAINT PACK > TMPLOG
  121. COPY TOPMAINT.LOG + TMPLOG TOPMAINT.LOG
  122. DEL TMPLOG
  123.  
  124.     This batch file redirects TOPMaint's output to a file (TMPLOG), then
  125. appends this file to TOPMAINT.LOG (creating it if it does not exist).  A
  126. temporary file is necessary because files are overwritten when redirection is
  127. used.  This is why TMPLOG only needs to be deleted after the entire maintenance
  128. is finished.  Actually, it doesn't need to be deleted at all, but doing so
  129. keeps your TOP directory cleaner.
  130.  
  131.     Please note that TOPMaint uses some ASCII control codes so viewing a log
  132. file inside a text editor may look a little strange, though by no means
  133. unreadable.  However, the best method of viewing a log file is from DOS, as
  134. follows:
  135.  
  136. TYPE TOPMAINT.LOG | MORE
  137.  
  138.     This will pipe the log file through DOS's MORE command, allowing you to
  139. view it a screen at a time.  All control codes will perform their proper
  140. function, thus the output will be a lot more legible.
  141.  
  142.     Future Plans
  143.     ------------
  144.  
  145.     As the next version of TOP (v3.00) is at least a year away, a few more
  146. enhancements are planned for TOPMaint to provide some important features that
  147. weren't able to be included in TOP v2.00.  These include:
  148.  
  149.     - The ability to change a user's handle.
  150.  
  151.     - The ability to run TOPMaint before TOP to undo the automatic name
  152. capitalization that TOP forces on user's handles.
  153.  
  154.     - A native OS/2 version.
  155.  
  156.     Registration & Usage Licence
  157.     ----------------------------
  158.  
  159.     TOPMaint is covered by the same registration guidelines and licence as TOP
  160. v2.00 is.  See REGISTER.DOC and LICENCE.DOC from the TOP archive for more
  161. details.  In short, if you have registered TOP then you have registered
  162. TOPMaint.  If you are still running TOP on a trial basis then you are also
  163. running TOPMaint on a trial basis.
  164.  
  165.     Contacting the Author
  166.     ---------------------
  167.  
  168.     The author of TOPMaint and TOP can be reached as follows:
  169.  
  170.     FidoNet Netmail: 1:134/31 (address to Paul Sidorsky)
  171.     Internet Email : paulsid@nucleus.com
  172.     BBS            : (403)686-0449 (Press L at the Main Menu)
  173.  
  174.     Note that my Internet access has finally been renewed and I can once again
  175. be reached at paulsid@nucleus.com.  I again apologize for not having Internet
  176. access when TOP v2.00 was released, but when you're broke, you're broke!
  177.  
  178.     Please do not hesitate to contact me if you have a bug report or suggestion
  179. for TOPMaint or TOP!
  180.  
  181.     Revision History
  182.     ----------------
  183.  
  184.     Version 2.00a - Initial release.
  185.  
  186.