home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / MKILL100.ZIP / MAILKILL.DOC next >
Text File  |  1992-05-26  |  8KB  |  192 lines
  1.  
  2.  
  3.                       M A I L K I L L   v 1 . 0 0
  4.                       ---------------------------
  5.  
  6.                    For Searchlight BBS Version 2.xx!
  7.               (c)1992 Cyclone Software. All Rights Reserved
  8.                          Release Date : 5/26/92
  9.  
  10. OVERVIEW:
  11.    MAILKILL is a small utility that will automatically delete old mail
  12.    from your MAIL subboard after a number of days which you specify on
  13.    the command line. This can be ran from either a door or from
  14.    Searchlight's nightly events.
  15.  
  16. o Allows you to specify how long to keep mail before deletion.
  17.  
  18. o Allows you to set the minimum times read before the message is
  19.   deleted. (optional)
  20.  
  21. o Can be ran from a door or from Searchlight's events to make MAILKILL
  22.   completely automatic!
  23.  
  24. o Designed to run safely on a multinode system! Does file locking!
  25.  
  26. o Uses color choices from your CONFIG.SL2 file.
  27.  
  28. o All command line driven. Easy setup!
  29.  
  30.  
  31. SETUP:
  32.    This documentation is brief but should give you a hand in setting up
  33.    MAILKILL with Searchlight 2.15 or 2.25:
  34.  
  35.    1) Place MAILKILL.EXE in the directory you would like it to be placed.
  36.       You can either create a new directory or stick it with the other
  37.       Searchlight datafiles (This program works GREAT with a RAMDISK!).
  38.  
  39.    2) MAILKILL can be done in one of two ways:
  40.  
  41.        1) From the EVENT.DEF file.
  42.        2) From a DOOR within Searchlight. (See below)
  43.  
  44.    METHOD 1:  Run MAILKILL from the EVENT.DEF file.
  45.  
  46.    Load up your EVENT.DEF file from Searchlight's 2-Sysop/Text Edit
  47.    command. And add in the following:
  48.  
  49.    0:00 {Path To MAILKILL} MAILKILL.EXE {See Below For Syntax}
  50.  
  51.    This will make MAILKILL run automatically at midnight and kill all
  52.    old mail. You can change the time in the first part to your likeing.
  53.    If you wish MAILKILL to be a monthly event place the following:
  54.  
  55.    00/01/00 0:00 {Path To MAILKILL} MAILKILL.EXE {See Below For Syntax}
  56.  
  57.    Thats it! You now have MAILKILL set to run automatically!
  58.  
  59.    METHOD 2:  Run MAILKILL as a DOOR (For Searchlight 2.15 and 2.25)
  60.  
  61.    (For Searchlight 2.25 Only)
  62.    Load up Searchlight's MENU program and proper menu you wish MAILKILL
  63.    to be in. Press F1 to edit commands. Then enter into the area you
  64.    wish MAILKILL to be displayed. Now press F1 again to add a new command
  65.    and choose DOOR. Now enter in the following:
  66.  
  67.         1. Command Name ................... MAILKILL
  68.         2. Command Key .................... {This is up to you}
  69.         3. Description .................... MailKill v1.00
  70.  
  71.        Items 4 through 8 you can set to your preferences.
  72.  
  73.         9. Help Levels .................... All
  74.       *10. Door Command ................... MAILKILL {See Below}
  75.       *11. Directory Path ................. {Path To MAILKILL}
  76.        12. Communications Support ......... Standard
  77.        13. Abort Method ................... Terminate
  78.        14. Write Protection ............... No
  79.        15. Parameter File ................. None
  80.        16. Pause After Door ............... No
  81.  
  82.    (From the DOORS.DEF file in Searchlight 2.15 or 2.25)
  83.    Enter the following command in the area you wish MAILKILL to be
  84.    displayed:
  85.  
  86.    1;0;1;xxx;MailKill - Kill Old Mail;xxxxx;MAILKILL.EXE {See Below}
  87.          ::                         ::
  88.          \/                         \/
  89.       Access Level            Path To MAILKILL
  90.  
  91. SYNTAX OF MAILKILL:
  92.  
  93.      The command syntax of MAILKILL is as follows:
  94.  
  95. MAILKILL [Path To CONFIG.SL2 File] [NUMDAYS] {MTREAD}
  96.  
  97. Where: [Path To CONFIG.SL2]         - Your current node's CONFIG.SL2 - REQUIRED
  98.        [NUMDAYS]                    - Start date (in days) to delete mail
  99.                                                                      - REQUIRED
  100.        {MTREAD}                     - Minimum Times Read For Deletion
  101.  
  102. Path to CONFIG.SL2 File (This is REQUIRED)
  103.    This tells MAILKILL where to look for the CONFIG.SL2 file. Just enter the
  104.    path to current node's CONFIG.SL2 file. Ex. C:\BBS1
  105.  
  106. NUMDAYS (This is REQUIRED)
  107.    This tells MAILKILL to start deleteing mail if it is {NUMDAYS} old or
  108.    older. This is the main feature of MAILKILL to tell when to start
  109.    deleting.
  110.  
  111. MTREAD (Optional)
  112.    This tells MAILKILL only to delete the messages if they have been
  113.    read at least {MTREAD} times. This allows you to make sure that the
  114.    receiver of the message has a chance to read it.
  115.  
  116.               THATS ALL! You now have MAILKILL all setup!
  117.  
  118.  
  119. DISCLAIMER:
  120.  
  121.     I, Travis Feisthamel, nor Cyclone Software are to be held liable for
  122.     any damages that MAILKILL should cause to your system or software. This
  123.     program has been tested to be bugfree to the best of our knowledge.
  124.     This means that if MAILKILL should corrupt a datafile or something, it
  125.     is your loss. USE AT YOUR OWN RISK!
  126.  
  127. REGISTRATION INFO:
  128.  
  129.    The good news is there is NO registration for MAILKILL. This program
  130.    written for fun and was released to FREEWARE by Cyclone Software.
  131.    Feel free to pass this file on to other Searchlight Sysops!
  132.  
  133. Look for our other Cyclone Software releases for Searchlight including:
  134.  
  135. SHAREWARE:
  136.  
  137. WELCOME - Mulitfunction Login Door For Searchlight 2.15 and 2.25
  138.           Welcomes callers, show expiration time remaining, shows
  139.           BBS and callers stats, sends SYSOP mail when new user calls,
  140.           send new user a message, sets QUOTE access level, much much more!
  141.  
  142. FREEWARE:
  143.  
  144. SL-STATLINE - Gives Omen Technologie's GSZ a Searchlight status!
  145.               See who's uploading and downloading!
  146.  
  147. REGUSER     - Gives a listing of all your users that are within specified
  148.               access levels in a three column format. This is useful to allow
  149.               your users to see who your "REGISTERED" or "PAYING" members
  150.               are. Alot of other uses also. Check this out!
  151.  
  152. PRIME TIME  - Allows you to set a special session time limit during
  153.               prime time hours which you specify on a command line. This
  154.               is completely command line driven so the sysop has
  155.               complete control. Also sets the EVENT flag so your users
  156.               can do a TIME VAULT or JACKPOT LOTTO to gain more time.
  157.               This door is useful to allow more callers during prime
  158.               time hours! (For Searchlight 2.25 Only!)
  159.  
  160. Any many more on the way soon!
  161.  
  162. SUPPORT:
  163.  
  164.    If you have any QUESTIONS, COMMENTS, or IDEAS direct them to me,
  165.    Travis Feisthamel, at one of the following BBS's:
  166.  
  167.          StarNet BBS - (315) 786-0778  1200-14,400 (US ROBOTICS DS HST)
  168.          StarNet BBS - (315) 786-0779  300-2400 Baud
  169.  
  170.                           * The StarNet BBS *
  171.    * OFFICIAL SEARCHLIGHT BBS DEALERSHIP FOR THE NEW ENGLAND STATES *
  172.  
  173.     Liberty Mall BBS - (315) 788-0232  300-2400 Baud
  174.     Searchlight BBS  - (516) 516-2566  300-14,400 (US ROBOTICS DS HST)
  175.  
  176.    For a faster responce please call the StarNet BBS.
  177.  
  178.   CREDITS:
  179.  
  180.     Searchlight BBS is a product of Searchlight Software
  181.     Mailkill, Prime Time, Welcome, Reguser, and SL-Statline are products of
  182.            Cyclone Software
  183.     GSZ is a product of Omen Technologies
  184.     Time Vault is product of CCS Systems and Jim Barry
  185.     Jackpot Lotto is a product of Tim Rossiter
  186.  
  187. NOTE: MAILKILL has been compressed using PKWARE's PKLITE utility to
  188.       save disk space and for faster loading. If you wish to uncompress this
  189.       program please use PKLITE to uncompress it. PKLITE can also be used on
  190.       all previous Cyclone Software releases to make the doors run faster
  191.       and save disk space.
  192.