home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR4 / SCRUNCH1.ZIP / SCRUNCH.DOC < prev    next >
Text File  |  1993-09-15  |  5KB  |  140 lines
  1. SCRUNCH Program documentation
  2.  
  3.          SCRUNCH Copyright (C) Dave Hala Jr.
  4.  
  5. What's SCRUNCH?
  6.  
  7.          SCRUNCH is a utility designed to be used with a Spitfire
  8.          BBS. SCRUNCH upon execution will search for your Callers,
  9.          Heysysop and CNact logs. It will then ZIP them using a
  10.          a file name consisting of a two letter prefix followed
  11.          by the date in the format explained below. Assuming 
  12.          that todays date is 04-07-93, the names of your Zipped 
  13.          logs would be:
  14.  
  15.          Callers.log  :    CL040793
  16.  
  17.          Heysysop.log :    HL040793
  18.  
  19.          CNact.log    :    CN040793
  20.  
  21. SCRUNCH Operation
  22.  
  23.          When SCRUNCH is executed it first looks for its data 
  24.          file.(SCRUNCH.DAT) Then it retrieves the System date 
  25.          and generates a file name as shown above. After changing
  26.          to the Dir configured as the LOG storage dir, SCRUNCH
  27.          then ZIPS the callers, heysysop, and CNact.log. After 
  28.          these logs are Zipped, SCRUNCH deletes the origonals.
  29.          To help keep the SYSOP informed, SCRUNCH makes a new 
  30.          HEYSYSOP.log and places a brief statement in this log 
  31.          saying when the log was created and when SCRUNCH was 
  32.          executed. At the present time you must Zip all three
  33.          logs, you can't pick and choose. As they say, "It is all
  34.          or nothing."
  35.  
  36. Set-up
  37.  
  38.          Change into your Spitfire work directory and make a
  39.          backup copy of your Callers.log and your Heysysop.log.
  40.          You may also want to go into your Circuitnet dir. and
  41.          make a backup copy of your CNact.log too. Be sure to
  42.          store these in a safe place. (Just in case)
  43.  
  44.          Now copy SCRUNCH.EXE into your BBSs home dir. Change
  45.          to your BBSs home directory. Now at the Dos prompt
  46.          type SCRUNCH and please <ENTER>
  47.  
  48.          SCRUNCH searches for a data file called SCRUNCH.DAT and
  49.          and when it can't find it will beep and show you the
  50.          following prompt on the screen.
  51.  
  52.          Can't find Squish.dat  Create it (Y/n)
  53.  
  54.          select "Y"
  55.  
  56.  
  57.          Now "***** SCRUNCH FILE PATH CONFIG *****" will appear
  58.          on the screen.
  59.  
  60.          You will be prompted for the Dir for your Callers,
  61.          Heysysop and Circuitnet logs. You will also be prompted
  62.          for a Dir to store logs in and also your BBSs home dir.
  63.  
  64.          Example :
  65.  
  66.            Enter the Dir for your Callers.log      ?
  67.            Enter the Dir for your Heysysop.log     ?
  68.            Enter the dir for your Circuitnet log   ?
  69.            Enter the Dir to store logs in          ?
  70.            Enter your BBSs home dir                ?
  71.  
  72.  
  73.          DO NOT SUFFIX THESE PATHS WITH THE LOGS FILENAME! 
  74.          SCRUNCH ONLY NEEDS TO KNOW THE DIR THE LOG IS IN. DO 
  75.          NOT SUFFIX THE DIR WITH A "\"
  76.  
  77.          Example:
  78.  
  79.            My callers.log is in the dir :  C:\sf\work
  80.            so I would enter :              C:\sf\work
  81.  
  82.  
  83.          After you have entered these paths SCRUNCH will ask you
  84.          if you want to write them to the data file. Select "Y".
  85.          SCRUNCH will then proceed to save these paths and go
  86.          ahead and ZIP your logs...
  87.  
  88. Usage
  89.  
  90.          Using SCRUNCH myself, I have configured it as a weekly
  91.          event on my BBS. You may also just execute it manually  
  92.          from the dos prompt.
  93.  
  94. Tips  
  95.  
  96.          When running SCRUNCH as an event be sure to run it last.
  97.          Most sysops use some type of bulletin generator that 
  98.          reads the Callers.log. If SCRUNCH "stores" these logs then  
  99.          your bulletin generator will not find a Callers.log 
  100.  
  101. About SCRUNCH
  102.  
  103.          SCRUNCH was coded using MS Quickbasic v4.5 and was com-
  104.          piled over MSDOS v 6.0
  105.  
  106. Credits
  107.  
  108.          Warren Miller came up with the format for the filenames.
  109.          Birgit Murphy had the Idea for the name "SCRUNCH" and of  
  110.          course I wrote and compiled the code.
  111.  
  112. Registration 
  113.  
  114.          SCRUNCH is my attempt to give something back to the Spit-
  115.          fire BBS community. Sysop's may use SCRUNCH without any 
  116.          fee and may distribute it, as long as no fee is charged 
  117.          for this program.
  118.  
  119. Feedback
  120.  
  121.          I'd welcome any feedback about the use of SCRUNCH. 
  122.          You may call my BBS or contact me VIA CircuitNet.
  123.  
  124.          The Cyberspace BBS  (515)-752-4059   14.4 DS
  125.          Dave Hala  CN 515004
  126.  
  127.  
  128. DISCLAIMER 
  129.  
  130.          Dave Hala Jr. will in no way be held liable for any 
  131.          damages incurred by the use of SCRUNCH. The user takes 
  132.          all responsibility for any damages that occur from the use 
  133.          of SCRUNCH.
  134.  
  135.  
  136.          Spitfire is Copyright (C) Mike Woltz & Buffalo Creek software.
  137.          MS DOS and MS Quickbasic is Copyright (C) Microsoft corp.
  138.          CircuitNet software is Copyright (C) Dave Stahl & Cybertech
  139.  
  140.