home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-387-Vol-3of3.iso / s / skill25.zip / SPOTKILL.DOC < prev    next >
Text File  |  1993-03-07  |  19KB  |  351 lines
  1.                         ┌─────────────────────────┐
  2.                         │      Spot Kill 2.5      │
  3.                         └─────────────────────────┘
  4.  
  5.  
  6.                              !!!! WARNING !!!!
  7.   !!   This Program Is Designed for GT 16.00 and Higher Specifically   !!
  8.   !!   Use on any other version could prove hazardous to your system   !!
  9.  
  10.        ──────────────────────────────────────────────────────────────
  11.                                   History
  12.        ──────────────────────────────────────────────────────────────
  13.  
  14.          01-26-92   Ver 1.0 Initial Release
  15.          01-29-92   Ver 1.1 Added 'ANY' argument to "Search Area" and
  16.                     "Flags"
  17.          02-02-92   Ver 1.2 Added /P: Parameter to Command Line.
  18.                     (Ability to search Alternate Echo Path)
  19.          02-03-92   Ver 1.3 Added /C: Parameter to Command Line.
  20.                     (Ability to specify Alternate Config File)
  21.          02-08-92   Ver 1.4 Added Result Logging.  Unless a /NL is
  22.                     placed on the command line SPOTKILL will write a
  23.                     progress log to a file called SPOTKILL.LOG in the
  24.                     GTPATH directory.
  25.          04-05-92   Ver 1.5 Added ALL Argument to the "FLAGS" area of
  26.                     the CFG file.  If you add ALL to the "FLAGS" area
  27.                     every message meeting the "Search Area" and  "Text
  28.                     Search" parameter WILL be deleted whether it has
  29.                     been bagged or received.  USE WITH CAUTION!
  30.          11-07-92   Version 1.6  SpotKill has received an overhaul.
  31.                     ALL command line parameters are now obsolete, they
  32.                     are no longer needed as the configuration file has
  33.                     been almost completely redesigned.  Please read the
  34.                     WHATS.NEW file for upgrade information.
  35.          11-08-92   Version 1.7  This release fixes some minor bugs
  36.                     that was found in version 1.6.  Corrections include
  37.                     ability to use /REGISTER with the QWK compatible
  38.                     GTMDIR.BBS and corrected a never ending loop that
  39.                     would happen if the last END statement was not
  40.                     placed into the SPOTKILL.CNF.
  41.          11-09-92   Version 1.8  Improved result logging.  SPOTKILL
  42.                     now puts the date (the correct one which was fixed),
  43.                     the message are being processed, and a listing of
  44.                     all messages deleted.  SPOTKILL also reports if no
  45.                     messages were deleted in the log file.
  46.          12-06-92   Version 1.9  Several Additional and Modified Flags,
  47.                     as well as some feature changes.  The two new flags
  48.                     for SpotKill are INCOMING and IN_RECEIVED.  You can
  49.                     now specify the message to be an INCOMING message
  50.                     or an INCOMING/RECEIVED message prior to deletion.
  51.                     Three flags have been renames ALL is now KILL_ALL,
  52.                     ANY is now ANY_STAT and BOTH is now BOTH_STAT.  In
  53.                     the search location the ANY has changed to ANY_LOC.
  54.                     SpotKill will now also allow you to Mark Messages
  55.                     as bagged rather than completely deleting them.
  56.                     If you would prefer to simply mark your offending
  57.                     message as bagged rather than kill them, place a
  58.                     /MB (mark bagged) on the command line.
  59.          12-27-92   Version 2.0  Some additions have been made at the
  60.                     suggestion of Bob Butcher.  The first change is the
  61.                     addition of the "Message - O - Meter".  The "meter"
  62.                     will give you graphic representation of the percentage
  63.                     of the message base that has been scanned, and how
  64.                     much remains.  The second addition is the ability to
  65.                     make three distinct "breaks" out of the program.
  66.                     Listed at the top of the screen you will notice that
  67.                     the F1 F2 and F3 keys will allow you to break out of
  68.                     the various Spotkill Loops.  F1 will break out of the
  69.                     current search and continue with the next search in the
  70.                     message area.  F2 will tell Spotkill to continue on to
  71.                     the next message area.  F3 will do a graceful and
  72.                     immediate exit from the program.
  73.           2-01-93   Version 2.1  Two new features have been added to
  74.                     SPOTKILL.  SPOTKILL can now GLOBALLY process each
  75.                     message area listed in the GTMDIR.BBS file.  To force
  76.                     a GLOBAL process, place the word GLOBAL in the
  77.                     SPOTKILL.CNF file instead of a PATH to the message
  78.                     area.  When SpotKill see's GLOBAL as the pathname, each
  79.                     and every message area listed in the GTMDIR.BBS file
  80.                     will be searched.  SPOTKILL also has a new command line
  81.                     parameter /NOMETER.  If you don't want to see
  82.                     SpotKill's MESSAGE - O - METER use /NOMETER.
  83.           2-02-93   Version 2.2  Bug Fix.  Corrected Problem reading
  84.                     GTMDIR.BBS
  85.           2-03-93   Version 2.3  Bug Fix.  Corrected Problem in the F1
  86.                     (Skip Current Search) routine.  Thanks to Bob Butcher
  87.                     for catching this one (one day late though ).
  88.           2-14-93   Version 2.4  Added Alternate Config File Command Line
  89.                     Option.  If you wish to use a Config FIle other than
  90.                     <GTPATH>\HOTWARE\SPOTKILL.CNF then you can specify a
  91.                     /C:<ALT_CONFIG> where <ALT_CONFIG> is the full path and
  92.                     filename of the file you wish to use for the
  93.                     configuration file.
  94.           3-07-93   Version 2.5  Now only the message areas that actually
  95.                     have messages deleted or marked bagged will be logged
  96.                     into the SPOTKILL.LOG.  No more searching the log
  97.                     file in search of actual work....
  98.  
  99.        ──────────────────────────────────────────────────────────────
  100.                                 What is It?
  101.        ──────────────────────────────────────────────────────────────
  102.          A simple little program that will go to your netmail message
  103.          area and "Spot Kill" (or just mark them as bagged if you prefer)
  104.          any messages you choose.  SPOTKILL reads from a configuration file
  105.          (discussed below) and deletes selectively by Message Sender,
  106.          Receiver, or Subject.  In the config file you must specify the
  107.          path of the message area to process, whether the message has to be
  108.          Received, Bagged, Incoming Any_Stat (Bagged or Received),
  109.          Both_Stat (Bagged AND Received), or IN_Received (Incoming message
  110.          that has been received). Any messages that are found must match
  111.          the text you have chosen to search for and the bagged / received /
  112.          incoming flag combinations before the message will in any way be
  113.          removed. Bear in mind however the text you choose will be searched
  114.          for in a case insensitive manner.  If the text appears ANYWHERE in
  115.          the section you have chosen to search (Sender Receiver or Subject)
  116.          the message will be subject to deletion.  For example, if you
  117.          choose to delete any Received messages with "NET" in the subject,
  118.          the following Subject lines would be subject to deletion: Netmail
  119.          System Report Net 064 Discussions FIDONETWORK Expo
  120.  
  121.          As you can see, if NET appears ANYWHERE in the text and the
  122.          Received flag was set on the message, this message would be
  123.          history.
  124.  
  125.  
  126.        ──────────────────────────────────────────────────────────────
  127.                                   Why Is It?
  128.        ──────────────────────────────────────────────────────────────
  129.  
  130.          You may be asking about now, Why would you want to do this?
  131.          It's simple.  On my system, there are several messages that
  132.          travel through concerning, Automated File Attach Messages,
  133.          Netmail Reports, Echo Requests, etc.  With SPOTKILL I can
  134.          automatically remove these type messages automatically each night
  135.          after they have either been bagged or received without any manual
  136.          intervention.
  137.  
  138.        ──────────────────────────────────────────────────────────────
  139.                                  Execution..
  140.        ──────────────────────────────────────────────────────────────
  141.          Running the program is very easy.  The only things that are
  142.          required are: 1. A valid GTPATH statement,  2. SPOTKILL.CNF
  143.          located in <GTPATH>\HOTWARE directory. (described below).
  144.  
  145.          Now for this SPOTKILL.CNF file:
  146.  
  147.          SPOTKILL.CNF may contain information for an unlimited number of
  148.          message areas.  Each section is divided by the word END.  The
  149.          start of each Message Area section must start with the full path
  150.          of the message area to process OR the word GLOBAL.  If GLOBAL is
  151.          used SpotKill will read the GTMDIR.BBS file in your GTPATH and
  152.          execute on each valid message area.  Following the full path
  153.          SPOTKILL will read two lines for each "Text Search" that will take
  154.          place.  The number of searches that SPOTKILL can perform on each
  155.          run is unlimited.  The format of the file looks like this, (The
  156.          offsets after the text search is optional, although suggested for
  157.          easier readability of your .CNF file):
  158.  
  159.          E:\GTMAIL\NETMAIL
  160.            "Text To Search For"
  161.               "Search Area"  "Flags"
  162.          END
  163.  
  164.          A practical Example:
  165.  
  166.          E:\GTMAIL\NETMAIL
  167.            GT-TOOLS
  168.              SENDER BAGGED
  169.            ECHOMAIL REPORT
  170.              SUBJECT RECEIVED
  171.            ROB ROESCH
  172.              RECEIVER BOTH_STAT
  173.            NETMAIL SYSTEM
  174.              ANY_LOC ANY_STAT
  175.          END
  176.          GLOBAL
  177.            SPONSOR
  178.              RECEIVER KILL_ALL
  179.          E:\GTMAIL\NETMAIL2
  180.            GT-TOOLS
  181.              SENDER BAGGED
  182.          END
  183.  
  184.          The above example would make four passes through the message area
  185.          E:\GTMAIL\NETMAIL.  The first Pass would look for the text
  186.          "GT-TOOLS" (case insensitive) in the Sender section of the
  187.          message.  If this was found, SPOTKILL would look to see if the
  188.          message had been bagged, and if so the message would be deleted.
  189.          If the message had not yet been bagged, the message would NOT be
  190.          deleted.  The second pass would look for "ECHOMAIL REPORT" (again
  191.          case insensitive) only this time the text would be looked for in
  192.          the Subject of the message.  If "ECHOMAIL REPORT" were found
  193.          anywhere in the Subject of the message, and the message had been
  194.          marked as received the message would be deleted.  On the third
  195.          pass "Rob Roesch" would be searched for in the Receiving section
  196.          of the message.  If "Rob Roesch" is found the message must be BOTH
  197.          received and bagged before the message will be deleted.  On the
  198.          fourth pass, if "NETMAIL SYSTEM" were found in ANY of the three
  199.          areas (Sender, Receiver, or Subject) and either the BAGGED >OR<
  200.          RECEIVED flags were set, the message would be deleted.  After
  201.          E:\GTMAIL\NETMAIL was completely processed SPOTKILL would start
  202.          the process again only this time GLOBALLY for each message area
  203.          found in the GTMDIR.BBS file.  SpotKill will search each message
  204.          area looking for SPONSOR in the Receiver section of the message
  205.          header.  After the GLOBAL process is complete SPOTKILL would start
  206.          in the message area E:\GTMAIL\NETMAIL2. Please note that END (starting in column 1)
  207.          separates the three sections.  Without the END statement
  208.          SPOTKILL will not know to start processing the next message area.
  209.  
  210.          Valid "Search Area" arguments are:
  211.  
  212.                SENDER  RECEIVER  SUBJECT  ANY_LOC
  213.  
  214.          Nothing else will be recognized and the program will exit with an
  215.          error.
  216.  
  217.          Valid "Flags" arguments are:
  218.  
  219.               BAGGED  RECEIVED  BOTH_STAT  ANY_STAT  KILL_ALL
  220.                           INCOMING    IN_RECEIVED
  221.  
  222.                  BAGGED      Any BAGGED message meeting the "Text Search"
  223.                              criteria will be deleted.
  224.                  RECEIVED    Any RECEIVED message meeting the "Text Search"
  225.                              criteria will be deleted.
  226.                  BOTH_STAT   Any BAGGED *AND* RECEIVED message meeting the
  227.                              "Text Search" Criteria will be deleted.
  228.                  ANY_STAT    Any BAGGED  *OR* RECEIVED message meeting the
  229.                              "Text Search" criteria will be deleted.
  230.                  INCOMING    Any INCOMING messages meeting the "Text
  231.                              Search" criteria will be deleted.
  232.                  IN_RECEIVED Any INCOMING messages, that have be previously
  233.                              received AND meed the "Text Search" criteria
  234.                              will be deleted.
  235.                  KILL_ALL    >>ALL<<  messages meeting the "Text Search"
  236.                              criteria will be deleted.  USE WITH CAUTION!
  237.  
  238.          Nothing else will be recognized and the program will exit with an
  239.          error.
  240.  
  241.  
  242.          Note:  SPOTKILL.CNF  MUST be in a directory off your GTPATH
  243.                 directory named HOTWARE.  ie. if your GTPATH is set
  244.                 to C:\GT then SPOTKILL.CNF must be in C:\GT\HOTWARE
  245.  
  246.        ──────────────────────────────────────────────────────────────
  247.                           Command Line Parameters
  248.        ──────────────────────────────────────────────────────────────
  249.          There's five.
  250.  
  251.              /LOG
  252.  
  253.          If you want SPOTKILL to keep a log file of the messages that
  254.          were deleted simply put /LOG on the command line.
  255.  
  256.              /MB
  257.  
  258.          If you want SPOTKILL to mark messages as bagged rather than
  259.          delete them, put a /MB (Mark Bagged) on the command line.  No
  260.          message will be deleted, but they won't travel off your BBS
  261.          either.
  262.  
  263.              /NOMETER
  264.  
  265.          If you would like to shut of SpotKill's Message - O - Meter,
  266.          use this parameter.  SPOTKILL will execute somewhat faster
  267.          without the meter, and besides if your running it automatically
  268.          at midnight, why would you want the meter there....
  269.  
  270.               /C:<ALT_CONFIG>
  271.  
  272.          If you wish to use a Config FIle other than
  273.          <GTPATH>\HOTWARE\SPOTKILL.CNF then you can specify a
  274.          /C:<ALT_CONFIG> where <ALT_CONFIG> is the full path and filename
  275.          of the file you wish to use for the configuration file.
  276.  
  277.              /REGISTER
  278.  
  279.          If you would like to use the Auto Registration feature of
  280.          SPOTKILL, use this parameter.  SPOTKILL will send a registration
  281.          message to ROB ROESCH at 064/003 via netmail when this parameter
  282.          is used.
  283.  
  284.        ──────────────────────────────────────────────────────────────
  285.                            Active Keyboard Input
  286.        ──────────────────────────────────────────────────────────────
  287.  
  288.          Spotkill has the ability to exit various levels of execution at
  289.          your request.  There are three distinct "breaks" out of the
  290.          program.  Listed at the top of the execution screen you will
  291.          notice that the F1 F2 and F3 keys will allow you to break out of
  292.          the various Spotkill Loops.  F1 will break out of the current
  293.          search and continue with the next search in the message area.
  294.          F2 will tell Spotkill to continue on to the next message area.
  295.          F3 will do a graceful and immediate exit from the program.
  296.  
  297.        ──────────────────────────────────────────────────────────────
  298.                                  Errorlevels
  299.        ──────────────────────────────────────────────────────────────
  300.          Here are the possible errorlevel exits the program will give.
  301.       
  302.                   ERRORLEVEL 0  No Problems, Good Run.....
  303.                   ERRORLEVEL 1  GTPATH Not Set
  304.                   ERRORLEVEL 2  Cannot find SPOTKILL.CNF
  305.                   ERRORLEVEL 3  Cannot Open GTMDIR.BBS
  306.                   ERRORLEVEL 4  Cannot Find NETMAIL Area in GTMDIR.BBS
  307.                   ERRORLEVEL 5  Cannot Open MESSAGE.CTL
  308.  
  309.  
  310.        ──────────────────────────────────────────────────────────────
  311.                                 Registration
  312.        ──────────────────────────────────────────────────────────────
  313.  
  314.         I am not requesting any money for this program, but I would
  315.         not turn any down either <g>.  If you want to slip $5.00 into
  316.         and envelope I'll accept it.  Although I don't require a
  317.         registration fee I would appreciate knowing that you are using
  318.         the program on a normal basis.  Therefore I have provided a
  319.         simple and easy way for you to register this program.  From
  320.         the DOS prompt type:   
  321.  
  322.  
  323.          SPOTKILL /REGISTER
  324.  
  325.       SPOTKILL will the proceed to send me a netmail message informing me
  326.       that you are using the program.  Please use this feature ONCE.
  327.  
  328.  
  329.        ──────────────────────────────────────────────────────────────
  330.                             Who Is Responsible for This?
  331.        ──────────────────────────────────────────────────────────────
  332.                                  Rob Roesch
  333.                               The HOTware BBS
  334.                          GT Power Net-Node 064/003
  335.                                 Rt 7 Box 566
  336.                                Mocksville, NC
  337.                          704-492-2081 (USR 16.8 DS)
  338.  
  339.           If you start using this utility, and get a chance, let me know 
  340.           (see above procedures.  If you don't have any use for it, delete
  341.           it for your total refund of all the disk space that it was
  342.           occupying.  This program comes with no warranty, no guarantee,
  343.           and no promises.  If it works GREAT, if not let me know and I
  344.           will gladly take a look at it in my spare time.  If you really
  345.           really really like the program and want to make any donations,
  346.           feel free, but it is not a requirement.....
  347.  
  348.  
  349.  
  350.  
  351.