home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / SKILL20.ZIP / SPOTKILL.DOC < prev    next >
Text File  |  1992-12-27  |  16KB  |  305 lines
  1.                         ┌─────────────────────────┐
  2.                         │      Spot Kill 2.0      │
  3.                         └─────────────────────────┘
  4.  
  5.  
  6.                              !!!! WARNING !!!!
  7.    !!   This Program Is Designed for GT 16.00 or 17.00 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.  
  74.        ──────────────────────────────────────────────────────────────
  75.                                 What is It?
  76.        ──────────────────────────────────────────────────────────────
  77.          A simple little program that will go to your netmail message
  78.          area and "Spot Kill" (or just mark them as bagged if you prefer)
  79.          any messages you choose.  SPOTKILL reads from a configuration file
  80.          (discussed below) and deletes selectively by Message Sender,
  81.          Receiver, or Subject.  In the config file you must specify the
  82.          path of the message area to process, whether the message has to be
  83.          Received, Bagged, Incoming Any_Stat (Bagged or Received),
  84.          Both_Stat (Bagged AND Received), or IN_Received (Incoming message
  85.          that has been received). Any messages that are found must match
  86.          the text you have chosen to search for and the bagged / received /
  87.          incoming flag combinations before the message will in any way be
  88.          removed. Bear in mind however the text you choose will be searched
  89.          for in a case insensitive manner.  If the text appears ANYWHERE in
  90.          the section you have chosen to search (Sender Receiver or Subject)
  91.          the message will be subject to deletion.  For example, if you
  92.          choose to delete any Received messages with "NET" in the subject,
  93.          the following Subject lines would be subject to deletion: Netmail
  94.          System Report Net 064 Discussions FIDONETWORK Expo
  95.  
  96.          As you can see, if NET appears ANYWHERE in the text and the
  97.          Received flag was set on the message, this message would be
  98.          history.
  99.  
  100.  
  101.        ──────────────────────────────────────────────────────────────
  102.                                   Why Is It?
  103.        ──────────────────────────────────────────────────────────────
  104.  
  105.          You may be asking about now, Why would you want to do this?
  106.          It's simple.  On my system, there are several messages that
  107.          travel through concerning, Automated File Attach Messages,
  108.          Netmail Reports, Echo Requests, etc.  With SPOTKILL I can
  109.          automatically remove these type messages automatically each night
  110.          after they have either been bagged or received without any manual
  111.          intervention.
  112.  
  113.        ──────────────────────────────────────────────────────────────
  114.                                  Execution..
  115.        ──────────────────────────────────────────────────────────────
  116.          Running the program is very easy.  The only things that are
  117.          required are: 1. A valid GTPATH statement,  2. SPOTKILL.CNF
  118.          located in <GTPATH>\HOTWARE directory. (described below).
  119.  
  120.          Now for this SPOTKILL.CNF file:
  121.  
  122.          SPOTKILL.CNF may contain information for an unlimited number of
  123.          message areas.  Each section is divided by the word END.  The
  124.          start of each Message Area section must start with the full path
  125.          of the message are to be process.  Following the full path
  126.          SPOTKILL will read two lines for each "Text Search" that will take
  127.          place.  The number of searches that SPOTKILL can perform on each
  128.          run is unlimited.  The format of the file looks like this, (The
  129.          offsets after the text search is optional, although suggested for
  130.          easier readability of your .CNF file):
  131.  
  132.          E:\GTMAIL\NETMAIL
  133.            "Text To Search For"
  134.               "Search Area"  "Flags"
  135.          END
  136.  
  137.          A practical Example:
  138.  
  139.          E:\GTMAIL\NETMAIL
  140.            GT-TOOLS
  141.              SENDER BAGGED
  142.            ECHOMAIL REPORT
  143.              SUBJECT RECEIVED
  144.            ROB ROESCH
  145.              RECEIVER BOTH_STAT
  146.            NETMAIL SYSTEM
  147.              ANY_LOC ANY_STAT
  148.          END
  149.          E:\GTMAIL\NETMAIL2
  150.            GT-TOOLS
  151.              SENDER BAGGED
  152.          END
  153.  
  154.          The above example would make four passes through the message area
  155.          E:\GTMAIL\NETMAIL.  The first Pass would look for the
  156.          text "GT-TOOLS" (case insensitive) in the Sender section of the
  157.          message.  If this was found, SPOTKILL would look to see if the
  158.          message had been bagged, and if so the message would be deleted.
  159.          If the message had not yet been bagged, the message would NOT be
  160.          deleted.  The second pass would look for "ECHOMAIL REPORT" (again
  161.          case insensitive) only this time the text would be looked for in
  162.          the Subject of the message.  If "ECHOMAIL REPORT" were found
  163.          anywhere in the Subject of the message, and the message had been
  164.          marked as received the message would be deleted.  On the third
  165.          pass "Rob Roesch" would be searched for in the Receiving section
  166.          of the message.  If "Rob Roesch" is found the message must be BOTH
  167.          received and bagged before the message will be deleted.  On the
  168.          fourth pass, if "NETMAIL SYSTEM" were found in ANY of the three
  169.          areas (Sender, Receiver, or Subject) and either the BAGGED >OR<
  170.          RECEIVED flags were set, the message would be deleted.  After
  171.          E:\GTMAIL\NETMAIL was completely processed SPOTKILL would start
  172.          the same process again only in the message area E:\GTMAIL\NETMAIL2.
  173.          Please note that END (starting in column 1) separates the two
  174.          message areas.  Without the END statement SPOTKILL will not know
  175.          to start processing the next message area.
  176.  
  177.          Valid "Search Area" arguments are:
  178.  
  179.                SENDER  RECEIVER  SUBJECT  ANY_LOC
  180.  
  181.          Nothing else will be recognized and the program will exit with an
  182.          error.
  183.  
  184.          Valid "Flags" arguments are:
  185.  
  186.               BAGGED  RECEIVED  BOTH_STAT  ANY_STAT  KILL_ALL
  187.                           INCOMING    IN_RECEIVED
  188.  
  189.                  BAGGED      Any BAGGED message meeting the "Text Search"
  190.                              criteria will be deleted.
  191.                  RECEIVED    Any RECEIVED message meeting the "Text Search"
  192.                              criteria will be deleted.
  193.                  BOTH_STAT   Any BAGGED *AND* RECEIVED message meeting the
  194.                              "Text Search" Criteria will be deleted.
  195.                  ANY_STAT    Any BAGGED  *OR* RECEIVED message meeting the
  196.                              "Text Search" criteria will be deleted.
  197.                  INCOMING    Any INCOMING messages meeting the "Text
  198.                              Search" criteria will be deleted.
  199.                  IN_RECEIVED Any INCOMING messages, that have be previously
  200.                              received AND meed the "Text Search" criteria
  201.                              will be deleted.
  202.                  KILL_ALL    >>ALL<<  messages meeting the "Text Search"
  203.                              criteria will be deleted.  USE WITH CAUTION!
  204.  
  205.          Nothing else will be recognized and the program will exit with an
  206.          error.
  207.  
  208.  
  209.          Note:  SPOTKILL.CNF  MUST be in a directory off your GTPATH
  210.                 directory named HOTWARE.  ie. if your GTPATH is set
  211.                 to C:\GT then SPOTKILL.CNF must be in C:\GT\HOTWARE
  212.  
  213.        ──────────────────────────────────────────────────────────────
  214.                           Command Line Parameters
  215.        ──────────────────────────────────────────────────────────────
  216.          There's only three.
  217.  
  218.  
  219.              /LOG
  220.  
  221.          If you want SPOTKILL to keep a log file of the messages that
  222.          were deleted simply put /LOG on the command line.
  223.  
  224.              /MB
  225.  
  226.          If you want SPOTKILL to mark messages as bagged rather than
  227.          delete them, put a /MB (Mark Bagged) on the command line.  No
  228.          message will be deleted, but they won't travel off your BBS
  229.          either.
  230.  
  231.              /REGISTER
  232.  
  233.          If you would like to use the Auto Registration feature of
  234.          SPOTKILL, use this parameter.  SPOTKILL will send a registration
  235.          message to ROB ROESCH at 064/003 via netmail when this parameter
  236.          is used.
  237.  
  238.        ──────────────────────────────────────────────────────────────
  239.                            Active Keyboard Input
  240.        ──────────────────────────────────────────────────────────────
  241.  
  242.          Spotkill has the ability to exit various levels of execution at
  243.          your request.  There are three distinct "breaks" out of the
  244.          program.  Listed at the top of the execution screen you will
  245.          notice that the F1 F2 and F3 keys will allow you to break out of
  246.          the various Spotkill Loops.  F1 will break out of the current
  247.          search and continue with the next search in the message area.
  248.          F2 will tell Spotkill to continue on to the next message area.
  249.          F3 will do a graceful and immediate exit from the program.
  250.  
  251.        ──────────────────────────────────────────────────────────────
  252.                                  Errorlevels
  253.        ──────────────────────────────────────────────────────────────
  254.          Here are the possible errorlevel exits the program will give.
  255.       
  256.                   ERRORLEVEL 0  No Problems, Good Run.....
  257.                   ERRORLEVEL 1  GTPATH Not Set
  258.                   ERRORLEVEL 2  Cannot find SPOTKILL.CNF
  259.                   ERRORLEVEL 3  Cannot Open GTMDIR.BBS
  260.                   ERRORLEVEL 4  Cannot Find NETMAIL Area in GTMDIR.BBS
  261.                   ERRORLEVEL 5  Cannot Open MESSAGE.CTL
  262.  
  263.  
  264.        ──────────────────────────────────────────────────────────────
  265.                                 Registration
  266.        ──────────────────────────────────────────────────────────────
  267.  
  268.         I am not requesting any money for this program, but I would
  269.         not turn any down either <g>.  If you want to slip $5.00 into
  270.         and envelope I'll accept it.  Although I don't require a
  271.         registration fee I would appreciate knowing that you are using
  272.         the program on a normal basis.  Therefore I have provided a
  273.         simple and easy way for you to register this program.  From
  274.         the DOS prompt type:   
  275.  
  276.  
  277.          SPOTKILL /REGISTER
  278.  
  279.       SPOTKILL will the proceed to send me a netmail message informing me
  280.       that you are using the program.  Please use this feature ONCE.
  281.  
  282.  
  283.        ──────────────────────────────────────────────────────────────
  284.                             Who Is Responsible for This?
  285.        ──────────────────────────────────────────────────────────────
  286.                                  Rob Roesch
  287.                               The HOTware BBS
  288.                          GT Power Net-Node 064/003
  289.                                 Rt 7 Box 566
  290.                                Mocksville, NC
  291.                          704-492-2081 (USR 16.8 DS)
  292.  
  293.           If you start using this utility, and get a chance, let me know 
  294.           (see above procedures.  If you don't have any use for it, delete
  295.           it for your total refund of all the disk space that it was
  296.           occupying.  This program comes with no warranty, no guarantee,
  297.           and no promises.  If it works GREAT, if not let me know and I
  298.           will gladly take a look at it in my spare time.  If you really
  299.           really really like the program and want to make any donations,
  300.           feel free, but it is not a requirement.....
  301.  
  302.  
  303.  
  304.  
  305.