home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / FDTG_310.ZIP / FDTGFILE.DOC next >
Text File  |  1998-07-19  |  7KB  |  161 lines
  1.  
  2.         
  3.                                FDTGFILE v3.10
  4.               Telegard 3.1x/FrontDoor Download Counter Updater 
  5.                            Program Documentation
  6.  
  7.                    Copyright (C) 1991,1998 by Tim Strike
  8.                             All Rights Reserved.
  9.  
  10.                           Released: July 18, 1998
  11.  
  12.  
  13.         INTRODUCTION
  14.  
  15.              For use with Telegard 3.1x.  If used with any other versions 
  16.              of Telegard, FDTGFILE could cause unpredictable and 
  17.              unrepairable results.  FDTGFILE supports FrontDoor v2.02+ (and 
  18.              compatable) log file formats only.
  19.  
  20.              FDTGFILE was designed to search the FrontDoor logs and find 
  21.              transferred files, and then update the database in Telegard to 
  22.              properly reflect the number of downloads (in this case file 
  23.              requests and FREQ's) and last transfer dates.  These records 
  24.              would normally never be updated, but your system has possibly 
  25.              transferred these files to many boards, and they aren't as 
  26.              'inactive' as their statistics would appear.
  27.  
  28.              FDTGFILE also has the ability to update the system HISTORY 
  29.              logs to reflect the proper number of download counters for 
  30.              that day (both # files/K).
  31.  
  32.              FDTGFILE uses the quick file indexing system of Telegard to 
  33.              locate the files.  As long as this index is properly 
  34.              maintained, you will experience no problems with FDTGFILE.  
  35.              When diagnosing problems with FDTGFILE, please ensure that all 
  36.              your other utilities are properly maintaining the QFILES.IDX 
  37.              file -- and try using the # debug option to determine what 
  38.              might be causing the problem before submitting a bug report.
  39.  
  40.  
  41.         PROGRAM OPERATION
  42.  
  43.              FDTGFILE <filepath-of-CONFIG> <logfile> <output> <options>
  44.  
  45.              <filename-of-CONFIG> is the full path and filename to the 
  46.              Telegard configuration file that you want to use.  This will 
  47.              for most normal setups be in the main BBS directory as the 
  48.              /CONFIG.TG file.
  49.  
  50.              <logfile> is the FrontDoor logfile to check.  This log file 
  51.              will me renamed or deleted after use (so it can not be 
  52.              rechecked again to cause duplicate processing).  The full path 
  53.              and filename should be included.
  54.  
  55.              <output> is the filename to output.  This will contain a 
  56.              listing of all files processed by FDTGFILE and the file 
  57.              directory that they were processed in.
  58.  
  59.              <options> are used to control how FDTGFILE handles the various 
  60.              checks, updates and logfiles.  The options should all be run 
  61.              together with one command line switch -- stray options will 
  62.              not be seen.  The options list can contain any of the 
  63.              following characters to cause certain actions to be taken.
  64.               
  65.               A  Disable area path match file areas; do not check to see if 
  66.                      outbound path matches found file area (i.e. match to
  67.                      first area found instead of correct area by path).  If 
  68.                      they do not match, the files are considered "found" 
  69.                      but not "updated". DEFAULT: Path matching
  70.  
  71.               D  Delete FrontDoor log after processing.  DEFAULT: Rename 
  72.                     the log to <filename>.nnn where nnn is the next number 
  73.                     in sequence.
  74.  
  75.               E  Look for file to see if it exists before going any 
  76.                     further.  If it does not exist, consider "missing"
  77.                     and do not even look in file indexes.  DEFAULT: Do
  78.                     not look for files.
  79.  
  80.               H  Do not update HISTORY.DAT downloads/K.  DEFAULT: Update
  81.                 
  82.               L  Delete FDTGFILE log after processing.  DEFAULT: Keep
  83.                      Note: Even if you specify L in the options, you
  84.                      must provide a valid, non-existing <output> file.
  85.                      
  86.               #  Debug mode: outputs lines as they are parsed; if you find
  87.                      a runtime error during the operation, use this option
  88.                      to determine where the error is occuring.
  89.  
  90.              Sample command lines might be:
  91.         
  92.              FDTGFILE C:\BBS\CONFIG.TG C:\FD\FD.LOG C:\BBS\SYSOP\FDTG.LOG -DA
  93.              FDTGFILE C:\BBS\CONFIG.TG C:\FD\FD1.LOG C:\BBS\SYSOP\FDTG.LOG
  94.                                
  95.                                
  96.         VERSION HISTORY
  97.              
  98.              A general summary of new features, bug fixes, etc.  "+" 
  99.              indicates a new feature, "*" indicates an updated (fixed) 
  100.              feature.
  101.  
  102.              v3.00
  103.  
  104.                  + Written in Turbo Pascal 7.0 for TELEGARD 3.0
  105.                  
  106.              v3.10
  107.                 
  108.                  + Written in Borland Pascal 7.0 for TELEGARD 3.1x
  109.                  * Last downloaded dates now properly updated
  110.                  * Switched option "P" to "A", and reversed the default;
  111.                    it now defaults to area path matching (since the new
  112.                    Telegard can store more than one file with the like name
  113.                    in different paths, this was necessary).
  114.                  + Uses FrontDoor or Binkley style logs per Telegard 
  115.                    settings (Why Binkley if this is a FD utility?  Binkley 
  116.                    style logs supported since I'll add binkley download 
  117.                    support to FDTG shortly . . .)
  118.          
  119.          
  120.         LEGALITIES
  121.  
  122.              WARRANTY
  123.  
  124.              FDTGFILE is provided as-is without a warranty of any kind, 
  125.              either express or implied.  Under no circumstances shall the 
  126.              anyone related to the production of this utility be liable to 
  127.              you or anyone else for any damages, including (but not limited 
  128.              to) any lost profits, lost savings or other incidental or 
  129.              consequential damages arising out of the use or misuse of this 
  130.              program.  Usage of this program is an understanding and 
  131.              agreement of said statement.
  132.                 
  133.              COPYRIGHT
  134.  
  135.              The program, and all documents and files included in the 
  136.              original FDTGFILE release package are copyrighted to Tim 
  137.              Strike and Forbidden Knights Systems.  The included files may 
  138.              not be modified in any manner.
  139.            
  140.              CREDITS
  141.  
  142.              All brand and product names referenced in this document are 
  143.              trademarks, registered trademarks, or copyrighted works of 
  144.              their respective holders.
  145.  
  146.  
  147.         CONTACT INFORMATION
  148.  
  149.         Author   Tim Strike
  150.  
  151.         Fidonet  1:259/423
  152.         
  153.         Internet tim@telegard.net
  154.         WWW      http://www.interlog.com/~strike (until end of 1998)
  155.         FTP      ftp://telegard.net/pub/tg
  156.        
  157.         BBS      (905)820-7273
  158.                  2400-33,600 Dual Standard (HST/V34)
  159.                  24 hours, except ZMH (4:00-5:00pm)
  160.         
  161.