home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / KILLRQ31.ZIP / KILLRQ.DOC < prev    next >
Text File  |  1992-08-13  |  6KB  |  129 lines
  1.  
  2.  
  3.  
  4.                              KillRQ v 3.1
  5.  
  6.  
  7.      INTRODUCTION:  KillRQ is an automated message base deletion
  8. system for Hudson-style message bases (QuickBBS, Remote Access,
  9. SuperBBS, etc).  KillRQ is provided free of charge for use in non-
  10. commericial environments.   Use in commercial or governmental
  11. environments is not authorized.  No warranty is expressed or implied. 
  12. If you break KillRQ or if KillRQ breaks you, it is your problem.  Free
  13. software is worth exactly what you pay for it.  :+)
  14.  
  15.  
  16.      COMMAND LINE:  KillRQ is executed from the command line or batch
  17. file as follows:
  18.  
  19. KILLRQ.EXE <config filename>
  20.  
  21.      The config file name is optional.  If no config file name is
  22. present, KillRQ will default to file KILLRQ.CFG in the current
  23. directory.  If a filename is provided on the command line, KillRQ will
  24. append a .CFG extension onto it and attempt to use that as a filename
  25. for the config file.  No extension should be placed on the command line --
  26. KillRQ will append a .CFG extension anyway and an extension already there
  27. will cause KillRQ to be unable to find the config file.
  28.  
  29.      If the config file is not found, KillRQ will abort.
  30.  
  31.  
  32.      CONFIG FILE:  The config file is a text (ASCII) file created by
  33. the sysop which tells KillRQ what it is supposed to do.  Config
  34. commands are listed one to a line, each line being terminated by a
  35. hard carraige return (ASCII #13). Text after a semi-colon ";" character
  36. will be ignored.  A sample config file is included with the distribution
  37. archive.  Each line is in the following format:
  38.  
  39. <command word> <board #> <identification text>
  40.  
  41.      ALL may be used in place of a board number to delete from all
  42. board numbers.  In the identification text field, an underscore (_)
  43. should be used to identify a space between words.  All comparisons are
  44. done in a case-insensitive manner -- "MEAN GUY" is exactly the same as
  45. "mean guy" in the eyes of the program.
  46.  
  47.      Seven command words are enabled in this version of KillRQ.
  48.  
  49.      1)  RESTRIP:  RESTRIP need not have either a board number or
  50. identification text parameter.  RESTRIP will cause KillRQ to strip RE:
  51. and Re: from the subject lines in the message base.  As KillRQ is
  52. going to scan all messages in the message base at one time or another
  53. anyway, this capability is a natural "throw-in" which may be useful on
  54. many systems to normalize subject lines.
  55.  
  56.      2)  KILLFROM or KF:  The KILLFROM (abbreviation KF) command word
  57. instructs KillRQ to delete messages which are FROM the individual
  58. specified in the identification text and which are on the board number
  59. specified (or all boards if the ALL word is used).
  60.  
  61.      3)  KILLTO or KT:  The KILLTO (abbreviation KT) command word
  62. instructs KillRQ to delete messages which are TO the individual
  63. specified in the identification text and which are on the board number
  64. specified (or all boards if the ALL word is used).
  65.  
  66.      4)  KILLSUBJ or KS:  The KILLSUBJ (abbreviation KS) command word
  67. instructs KillRQ to delete messages in which the identification text
  68. is a part of the subject and which are on the board number specified
  69. (or all boards if the ALL word is used).
  70.  
  71.       5)  KILLTEXT or KX:  The KILLTEXT (abbreviation KX) command word
  72.  instructs KillRQ to delete messages in which the identified text appears
  73.  within the same sentence or phrase and which are on the board number
  74.  specified (or all boards if the ALL word is used). ( *NOTE*  This
  75.  operation can be a VERY time-consuming one.)
  76.  
  77.       6)  FULLSCAN:  FULLSCAN will cause KillRQ to begin scanning from
  78. the start of the message base header file, ignoring the last-read marker.
  79.  
  80.       7)  SHAREMODE:  SHAREMODE will enable KillRQ to operate while
  81. other share-aware software is accessing the message base.  This is very
  82. necessary for multi-line operations or places where mail may process
  83. congruant to other-program access of the message base (BBS in local mode or
  84. sysop offline reader).
  85.  
  86.      RUNTIME METHOD:  When run, KillRQ will first check for its config
  87. file, terminating if the config file is not found.  It will then
  88. attempt to process the config file.  If no valid commands are found in
  89. the config file, KillRQ will terminate.
  90.  
  91.      After processing the config file, KillRQ will attempt to open the
  92. message base files.  If the message base files are not found in the
  93. current directory or if there is a problem detected with the message
  94. base files (such as size errors), then KillRQ will terminate.
  95.  
  96.      After opening the message base files, KillRQ will open a file
  97. with the same name as the config file although with the extension
  98. .CTL.  This file is where KillRQ "remembers" the last message number
  99. scanned.  If this file is not found or the number within is higher
  100. than the highest number in the message base (such as following a
  101. message base pack), KillRQ will start with the first message in the
  102. message base.
  103.  
  104.      Starting at the number thus determined, KillRQ will scan to the
  105. end of the message base, automatically deleting messages in accordance
  106. with the parameters defined in the config file.  Each deletion will be
  107. reported on the screen.  Speed tests indicate that KillRQ is quite
  108. fast, being able to scan an entire 4000 messages in about 15 seconds
  109. on a 386SX/16 machine and a 18ms hard drive.
  110.  
  111.      After it is done scanning, KillRQ will store the number of the
  112. last message scanned back into the .CTL file and end.
  113.  
  114.      
  115.      BUGS, SUGGESTIONS, AND FUTURE PLANS:  Bug and problem reports may
  116. be sent to Jason Steck at 1:104/424@FidoNet and 200:5000/400@MetroNet. 
  117. Flames and treatsies on the (de)merits of censorship should be sent to
  118. the nearest available bit bucket--I just makes 'em, I don't forces
  119. anyone to uses 'em.  However, compliments and input for improvements
  120. are always welcome.  
  121.  
  122.  
  123.                     Jason Steck
  124.                     1:104/424@FidoNet
  125.                     200:5000/400@MetroNet
  126.                     8:7703/10@FMLYNet
  127.      
  128.  
  129.