home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / TGOFR100.ZIP / TGOFR.DOC < prev    next >
Text File  |  1998-09-23  |  11KB  |  212 lines
  1.                     Telegard Offline File Remover v1.00
  2.                             by Ken Reaverson
  3.                          For Telegard v3.09.g1+
  4.  
  5. ┌─────────────────────────────────────────────────────────────────────────────┐
  6. │▒▒ Introduction ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  7. └─────────────────────────────────────────────────────────────────────────────┘
  8.  
  9.  The Telegard Offline File Remover (referred to as TGOFR throughout this
  10.  document) is a relativly simple, though hopefully time saving utility.
  11.  What it essentially does is read through your filebase data files and
  12.  remove any entries which have been toggled as Offline.
  13.  
  14.  It does *not* delete any files, it simply removes them from Telegard. This
  15.  is a safety device, just in case the file was accidentally toggled offline.
  16.  
  17.  The speed at which TGOFR runs is entirely dependant on how many files you
  18.  have. If you have alot of files, it's going to take more time than it would
  19.  on a smaller system.
  20.  
  21.  NOTE: TGOFR automatically skips CD-ROM bases. Due to their rotating nature,
  22.        It is not unusual for a CD base to have all it's files offline at
  23.        any given time. Since I'm pretty sure a sysop would get tired of
  24.        reimporting a FILES.BBS (or worse, doing it manually) everytime
  25.        he wanted to run TGOFR, I decided it'd be best to just leave the
  26.        CD-ROM bases alone.
  27.  
  28.  What TGOFR does is this: It writes all files which are not toggled offline
  29.  to a temporary .FA file. If it finds a file marked Offline, it does not
  30.  add it to the temporary file. It opens the QFILES.IDX, searches for the
  31.  file in there, and toggles the deleted flag. When all files in the base
  32.  have been processed, TGOFR deletes the old .FA file and renames the temporary
  33.  one to the old .FA's filename.
  34.  
  35.  The QFILES.IDX is an index file of *every* file on your system. In order to
  36.  toggle a file's entry within the QFILES.IDX to deleted, TGOFR has to start
  37.  at the beginning of the file, and search until it finds a match. This is
  38.  the reason TGOFR will run a little slower on larger systems, there's a whole
  39.  lot more of a file to read, and it has to start from the beginning for
  40.  *every* file entry it needs to toggle.
  41.  
  42.  Yes, it's horribly inefficient. However, this took me a grand total of
  43.  30 minutes to code, so you're stuck with it. :) All told, using TGOFR is
  44.  alot faster than searching through your file bases manually to delete
  45.  those pesky offline files.
  46.  
  47.  Hopefully, TGOFR will save you some tedious work. There are a couple
  48.  caveats:
  49.  
  50.      - Make sure the nodes are clear, or at the very least, that no one
  51.        is listing files when TGOFR runs. Otherwise, your data files will
  52.        make a nice sacrifice on the Altar of Corruption.
  53.  
  54.      - It is my recommendation that you make a backup of all your .FA
  55.        files prior to running TGOFR. TGOFR does not touch the .FAD files,
  56.        so there's no need to worry about them. Likewise, it only reads from
  57.        FAREAS.DAT and CONFIG.TG. It does write to the QFILES.IDX, however
  58.        there's really no point in backing it up since you can rebuild it
  59.        entirely by running INDEX BUILD FILES.
  60.  
  61.      - Even though TGOFR toggles the flag correctly in the QFILES.IDX,
  62.        it is my sincere recommendation that anyone using TGOFR run
  63.        INDEX BUILD FILES immedietly after TGOFR has had it's way with your
  64.        data files. This will ensure that your QFILES.IDX is okay.
  65.  
  66. ┌─────────────────────────────────────────────────────────────────────────────┐ 
  67. │▒▒ License and Disclaimer ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  68. └─────────────────────────────────────────────────────────────────────────────┘ 
  69.  
  70.  The author of TGOFR is not responsible for any damaged, corrupted, lost,
  71.  or otherwise harmful occurences that may occur from use (or inability
  72.  thereof) of this program. It has been tested, and the author runs it on his
  73.  own system. To the best of my knowledge, TGOFR has no bugs and will not
  74.  destroy anything on your system. However, I guarentee nothing, except that
  75.  this program will take up hard drive space.
  76.  
  77.  If it breaks, you own both halves.
  78.  
  79. ┌─────────────────────────────────────────────────────────────────────────────┐ 
  80. │▒▒ Requirements ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  81. └─────────────────────────────────────────────────────────────────────────────┘ 
  82.  
  83.  TGOFR's requirements differ depending on which executable is being run:
  84.  
  85.    TGOFR/DOS:
  86.      - An 80286 processor or better
  87.  
  88.    TGOFR/2:
  89.      - OS/2 Warp 3 or higher
  90.      - An 80486 processor or better
  91.  
  92.  Both versions require Telegard BBS v3.09.g1 or higher.
  93.  
  94. ┌─────────────────────────────────────────────────────────────────────────────┐
  95. │▒▒ Installation ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  96. └─────────────────────────────────────────────────────────────────────────────┘ 
  97.  
  98.  Installation of TGOFR is pretty simple. First, decide which executable
  99.  you're going to use, and rename either TGOFR.DOS or TGOFR.OS2 to TGOFR.EXE.
  100.  After that, copy TGOFR.EXE to your main Telegard directory and type:
  101.  
  102.  TGOFR.EXE                                                                    
  103.  
  104.  If all goes well, TGOFR will engage in the merciless slaughter of any
  105.  offline file entries.
  106.  
  107. ┌─────────────────────────────────────────────────────────────────────────────┐ 
  108. │▒▒ Usage ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  109. └─────────────────────────────────────────────────────────────────────────────┘ 
  110.  
  111.    As mentioned above, running TGOFR.EXE from your main Telegard directory
  112.    is all you need to do. It will, however, accept the following commandline
  113.    parameter:
  114.  
  115.       /V  -  Version Information                                              
  116.  
  117.              Displays the Copyright and compilation information.              
  118.  
  119.    Yes, I'm vain. :)
  120.  
  121. ┌─────────────────────────────────────────────────────────────────────────────┐
  122. │▒▒ Notes ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  123. └─────────────────────────────────────────────────────────────────────────────┘ 
  124.  
  125.  TGOFR/DOS has been compiled with Borland Pascal v7.0.                        
  126.  
  127.  TGOFR/2 has been compiled with Virtual Pascal v1.10                          
  128.  
  129.  The source code to either version is not available to the public, and it     
  130.  is not for sale, so please don't ask. :)                                     
  131.  
  132. ┌─────────────────────────────────────────────────────────────────────────────┐ 
  133. │▒▒ Registration ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  134. └─────────────────────────────────────────────────────────────────────────────┘ 
  135.  
  136.  TGOFR is FreeWare. End of story. Live free or die, ladies and gentlemen. :)  
  137.  
  138.  If you appreciate the work I've put into the software, and if it's been      
  139.  useful to you, drop me a line via one of the below contact methods. The      
  140.  experience of writing the program has been payment enough for me, but it's   
  141.  always nice to hear 'Thanks dude!' once in awhile. :)                        
  142.  
  143. ┌─────────────────────────────────────────────────────────────────────────────┐ 
  144. │▒▒ Distribution ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  145. └─────────────────────────────────────────────────────────────────────────────┘ 
  146.  
  147.  TGOFR may be freely distributed in it's unmodified format. See PACKING.LST
  148.  for a list of what should be included in the archive. The archive's original
  149.  fornat is ZIP, and it has been stamped with my AV codes. If the archive
  150.  you've received is not a ZIP, be wary. When unzipping this archive, at
  151.  the very end, you should see the following:
  152.  
  153.  Authentic Files Verified!   # CIS105
  154.  Blood Enterprises, Inc.
  155.  
  156.  If this message is not present, the archive may have been tampered with.
  157.  
  158.  The most current version of TGOFR will always be available for FREQ
  159.  on Shadowdale with the magicname TGOFR. See below for my contact
  160.  information. Any new versions will be hatched down the FidoNet TG_SUP
  161.  filebone.
  162.  
  163. ┌─────────────────────────────────────────────────────────────────────────────┐
  164. │▒▒ Copyrights ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  165. └─────────────────────────────────────────────────────────────────────────────┘ 
  166.  
  167.      Telegard Offline File Remover is Copyright Blood Enterprises, 1998.
  168.                                       All Rights Reserved.
  169.  
  170.      Telegard is Copyright Tim Strike, 1994,1998. All Rights Reserved.        
  171.  
  172. ┌─────────────────────────────────────────────────────────────────────────────┐ 
  173. │▒▒ Acknowledgements ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  174. └─────────────────────────────────────────────────────────────────────────────┘ 
  175.  
  176.  Since this was just something I sat down and coded for the hell of it,
  177.  I won't go into the usual round of thank you's and ass kissing. :)
  178.  
  179.  Instead, I'd just like to say thanks as always to the following indivduals:
  180.  
  181.  Tim Strike, Kevin Watkins, The Telegard Beta Team, my buddy Dave Richmond,
  182.  Arthur Stark, Jeff Weese, and Sean Dennis.
  183.  
  184.  Hi Bruce. You can use this one, I took the filter out. ;)
  185.  
  186.  Thanks also to Jeff Irvine, because I borrowed the basic template for this
  187.  document from him. ;)
  188.  
  189.  BTW: You're welcome, Mitch. :)
  190.  
  191. ┌─────────────────────────────────────────────────────────────────────────────┐ 
  192. │▒▒ Service & Support ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│ 
  193. └─────────────────────────────────────────────────────────────────────────────┘ 
  194.  
  195.  Contact Information -                                                        
  196.  
  197.    Author: Ken Reaverson                                                      
  198.     Email: tremere@mindless.com                                               
  199.       WWW: http://adrianblood.home.mindspring.com                             
  200.       FTP: ftp://darktech.ml.org/telegard
  201.       BBS: Shadowdale - (770) 982-7859
  202.            Login: Guest  Password: PRAISETIM                                  
  203.   Netmail: 1:133/1004   - FidoNet                                             
  204.            111:4350/101 - Sysop's TechNet                                     
  205.  EchoMail: TG_SUPPORT (FidoNet)                                               
  206.            ADV_TG (AdventureNet)                                              
  207.  
  208.  If you have a question or a problem with the software, by all means, get     
  209.  into contact with me via one of the above methods. I welcome comments and    
  210.  suggestions, and if you find a bug in the software, I'll do my damndest to   
  211.  fix it with all speed.
  212.