home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 2 / crawlyvol2.bin / apps / bbs / nitro3 / nitro.doc < prev    next >
Text File  |  1994-07-10  |  6KB  |  154 lines
  1.  
  2.                                 NITRO-Scan
  3.                   (c) Copyright 1993 - 1994 Steve Barnes
  4.  
  5.           Supplied courtesy of the Logic Church BBS  (1:224/150)
  6.                     Steve.Barnes@lchurch.mcd.on.ca
  7.  
  8.                               Steve Barnes
  9.                           1166 Lorraine Street.
  10.                         Sudbury, Ontario, Canada
  11.                                 P3A-2V4
  12.                  (Voice) 705-560-3115, (BBS) 705-525-1307
  13.  
  14.  
  15. INTRODUCTION:
  16.  
  17.   NITRO-Scan is a replacement for the built-in mail scanning routines
  18.   in Quickbbs/ST. Normally, the standard routines do the job just
  19.   fine. However, my BBS run over a 275 message areas, with a good
  20.   portion of them echo areas. At any one time, their maybe upwards of
  21.   60000 messages in my system. Obviously, doing a mail scan would take
  22.   some time as you can imagine. So much so, that many of my users
  23.   would never bother doing it - let alone stand for it during logon!
  24.  
  25.   Something needed to be done as messages were getting renumbered
  26.   right out of the system with out ever being seen by the person they
  27.   were addressed too.
  28.  
  29.   Enter NITRO-Scan. I couldn't think of a good name for this beast,
  30.   and since, during development, it showed a real willingness to blow
  31.   up BIG TIME - I thought the name was appropriate. The name stuck
  32.   after I got it working reliably because as you will soon see, its
  33.   visciously FAST! So fast in fact, that it takes longer to display
  34.   new messages than it does to actually find them!
  35.  
  36.   NITRO-Scan uses two main algorithms for its blistering performance.
  37.   The first and probably the most important, is a high level BTree to
  38.   use as an index file. This provides the fast access. The second,
  39.   aids both speed and index file size, instead of keying on the ASCII
  40.   representation of a messages 'TO:' field, NITRO-Scan instead uses a
  41.   16 bit CRC of the recievers name. This saves a HUGE amount of disk
  42.   space (32 bytes per message!). If your run a large message area as
  43.   I do, this really adds up.
  44.  
  45. FUNCTION:
  46.  
  47.   Basically, NITRO-Scan has 3 operating modes as follows:
  48.  
  49.     -r  : Rebuild
  50.     -u  : Update
  51.     -s  : Scan
  52.  
  53.   Rebuild mode is run after you renumber or pack your message bases.
  54.   It completely rebuilds the index files from scratch. Update is run
  55.   after every caller or after a mail run. It adds any new messages to
  56.   the index files. Scan is run when you wish to search for and mark
  57.   new messages for a caller.
  58.  
  59.   NITRO-Scan does not alter ANY BBS files, it only reads them. All
  60.   files that are written too are NITRO-Scan's own files. Of which
  61.   they're two. The first - NITRO.NDX is the actual index file itself.
  62.   The second, is the NITRO.RUN file, which NITRO-Scan uses to speed
  63.   the updating function. Neither of these files are 'human' readable.
  64.  
  65. INSTALLATION:
  66.  
  67.   You will find in the archive two files NITRO.110 & NITRO.112. If
  68.   your running version 1.10 of QBBS, rename NITRO.110 to NITRO.TTP.
  69.   Likewise if your running version 1.12 of QBBS, rename NITRO.112 to
  70.   NITRO.TTP.
  71.  
  72.   This is the best part, NITRO-Scan doesn't even have a configuration
  73.   file. I've found the best way to run it is to create a folder
  74.   called NITRO and copy NITRO.TTP into it. You can run NITRO-Scan
  75.   from *anywhere* on your system, even on a different drive if you
  76.   wish.
  77.  
  78.   Next is probably the most important step. Forget this and
  79.   NITRO-Scan will not work at all. You must create an environment
  80.   variable called 'QBBS' case is important! This is done with your
  81.   command line program with the 'SET' command. I use TomShell myself
  82.   and it looks like:
  83.  
  84.   set QBBS \QBBS\
  85.  
  86.   Now you need to edit your batch files <GACK!>, don't panic, this is
  87.   really easy. After a caller logs off your system run NITRO-Scan
  88.   with an -U paramter, same thing after you import network mail.
  89.   After you do a full renumber or pack, run NITRO-Scan with an -R
  90.   parameter. Thats it.
  91.  
  92.   For the BBS side of things, the flat out easiest way to run
  93.   NITRO-Scan is via a .DOR file (I've even supplied mine for you to
  94.   copy over). After this, it's simply a matter of adding/changing the
  95.   menu entry for a new mail scan to run the door file. This is
  96.   parameter 7 with a parameter line of NITRO.DOR.
  97.  
  98.   Were done.
  99.  
  100. CONCLUSION:
  101.  
  102.   I hope you find NITRO-Scan as useful and as fast as I have.
  103.  
  104.   NITRO-Scan is being distributed as true shareware. Send me $10 or
  105.   whatever you feel its worth to you if you use it.
  106.  
  107.   Your are granted unlimited permission to distribute NITRO-Scan
  108.   provided it is distributed unaltered and intact. No fees may be
  109.   charged for distribution beyond media costs.
  110.  
  111.   The author makes no claims whatsoever regarding performance, fitness
  112.   for purpose and is no way liable for financial losses, real or
  113.   percieved through the use of NITRO-Scan. Your use of NITRO-Scan is
  114.   done entirely at your own risk.
  115.  
  116.  
  117. OTHER SOFTWARE BY STEVE BARNES:
  118.  
  119.   CALLID - Uses your phone companies Call-Display features to provide
  120.   real-time screening or validation of callers. Available for
  121.   Forem/Turbo/Turbo-2, QBBS/ST.
  122.  
  123.   NOTARY - Call back verifier for Forem/Turbo/Turbo-2 & QBBS/ST.
  124.   *FAR* to many options to list, perhaps the most feature packed call
  125.   back verifier available for ANY platform. Crippleware ($10) - note,
  126.   even in an 'unregistered' state, NOTARY provides a huge assortment
  127.   of features, but the bells and whistles are disabled. To give you
  128.   an idea of the popularity of NOTARY, do date, I've received over
  129.   100 registrations for it! (I didn't think their were that many
  130.   Atari BBS's in North America :)
  131.  
  132.   FREQList - Builds Binkley AVAIL/OKFILES based on Forem/Turbo file
  133.   databases. Includes automatic filename substitution, wild carding,
  134.   inclusion on download level and much more. Freeware with source
  135.   code.
  136.  
  137.   TurboTxt - Handy GEM based utility to add/strip control codes in
  138.   Forem/Turbo text files. Freeware.
  139.  
  140.  
  141. ADDENDUM:
  142.  
  143.   If you find that NITRO-Scan can't find the message areas, double
  144.   check to see that you have included the drive letter in the
  145.   QCONFIG option that specifies the path to the message areas. Same
  146.   thing applies to the environment variable.
  147.  
  148.   Also, message areas that have a [SPACE] as the first character will
  149.   not be indexed.
  150.  
  151.   If you have any recommendations for change to NITRO-Scan, please,
  152.   by all means feel free to contact me.
  153.  
  154.