home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / TGFL_140.ZIP / TGFL.DOC < prev    next >
Text File  |  1998-11-19  |  39KB  |  926 lines
  1.  
  2.  
  3.  
  4.            Telegard File Lister Pro v1.40 Documentation
  5.          
  6.            Copyright (c) 1998 Dark Zone Software.
  7.            All rights reserved.
  8.  
  9.            File List Creater for Telegard bulletin board
  10.            software (BBS) v3.10 (3.09g?)
  11.  
  12.            Configuration and Reference Manual
  13.            Written by David Stumpf
  14.  
  15.            Dark Zone Software
  16.            7230 White Oak Circle
  17.            Houston, Texas 77040
  18.            USA
  19.  
  20.            Internet Email : David.Stumpf@Earthling.net
  21.            World Wide Web : http://www.dzs.home.ml.org
  22.  
  23.  
  24.  
  25.               TABLE OF CONTENTS
  26.  
  27.        Section 1.0    Software License Agreement
  28.        Section 1.1      Warranty Information
  29.        Section 1.2      Copyright Notice
  30.        Section 2.0    Product Information
  31.        Section 2.1      System Requirements
  32.        Section 3.0    Installation and Operation
  33.        Section 3.1      Installing the Software
  34.        Section 3.2      Command Line Options
  35.        Section 3.3      Config Files
  36.        Section 3.4      Include/Exclude Files
  37.        Section 3.5      Header/Footer Files
  38.        Section 3.6      MCI Codes
  39.        Section 4.0    Additional Product Information
  40.        Section 4.1      Product Revisions/Changes
  41.        Section 4.2      Product Coders and Testers
  42.        Section 5.0    Error Codes Defined
  43.        Section 6.0    Acknowledgments
  44.  
  45.  
  46.  
  47.  
  48.        Section 1.0       Software License Agreement
  49.  
  50.        Dark Zone Software  has  taken  every  precaution to  ensure
  51.        that no  harm  or damage will occur to systems running TGFL.
  52.        However, we  cannot  be responsible for any damages or other
  53.        losses  sustained  as a result of  running this  software on
  54.        your system.  The user assumes  full  responsibility for the
  55.        proper use of this program, whether damage occurs as a fault
  56.        of operator error or software error.
  57.        NO WARRANTIES ARE IMPLIED OR EXPRESSLY STATED.
  58.  
  59.        TGFL is distributed under the concept of FreeWare.   Users are
  60.        allowed to use as distribute this program as they see fit.  No
  61.        fees are required for the use or  distribution  of the package
  62.        nor can any be charged for the use, distribution or access too
  63.        this package.
  64.  
  65.        Dark Zone Software  grants an  unlimited  license  to  make and
  66.        distribute  TGFL which have been released to the public by Dark
  67.        Zone  Software.   Absolutely  no  modifications  to  the  files
  68.        contained in the software package, including this documentation
  69.        file,  may be  made  for distribution.  No  fee  may be charged
  70.        by anyone other than  Dark Zone Software beyond the actual cost
  71.        of providing these copies  without the prior written consent of
  72.        Dark Zone Software.
  73.  
  74.  
  75.  
  76.        Section 1.1      Warranty Information
  77.  
  78.       This  package is provided as-is, without warranty of any  kind,
  79.       either  expressed or implied, and is only guaranteed to  occupy
  80.       disk  space.  In no event will the author be liable to  you  or
  81.       anyone else for any damages, including (but not limited to) any
  82.       lost profits, lost savings or other incidental or consequential
  83.       damages  arising out of the use of, or inability to  use,  this
  84.       package.
  85.  
  86.       In short:  You're on your own.  If it works for you, great;  if
  87.       not,  or if it breaks something, c'est la vie.  As  the  saying
  88.       goes,  "Use it at your own risk, but if it breaks,  *YOU*  have
  89.       the pieces."
  90.  
  91.  
  92.  
  93.        Section 1.2      Copyright Notice
  94.  
  95.      This package and all files contained herein are Copyright (c) 1998
  96.      by  Dark  Zone  Software.   No  modifications  may be made to  any
  97.      part  of this  program  and/or  package  without  express  written
  98.      permission  from  Dark  Zone  Software.     This  package  may  be
  99.      distributed in  any  medium  so long as the  following  conditions
  100.      are  met;  a)  The package  must  be  unmodified    b)  No fees of
  101.      any  kind  may be charged for this package or directly for  access
  102.      to this package.  This software may be distrubited by CD-ROM media
  103.      and/or "pay-only" system.
  104.  
  105.  
  106.  
  107.        Section 2.0    Product Information
  108.  
  109.     TGFL is a file list creator.  In short, TGFL reads your Telegard
  110.     BBS files areas, and, according to the options that you use it
  111.     creates a list of files contained in your files base.  It also
  112.     has the ability to create several other files which can aid you
  113.     in running your BBS.
  114.  
  115.     This documentation will explain all of the availible options and
  116.     used of TGFL and how it can help you and your system.  Please
  117.     take the time to read this entire document.  Know exactly how
  118.     this software functions can help you use it more reliably and
  119.     safely.
  120.  
  121.  
  122.  
  123.  
  124.        Section 2.1      System Requirements
  125.  
  126.      TGFL requires the following minimal system to operate properlly.
  127.  
  128.         100% IBM Compatible Computer
  129.         80286 or above CPU
  130.         MS-DOS v4.00 or Compatible
  131.         Telegard v3.10 (3.09x)
  132.  
  133.         TGFL has been tested with MS-DOS v5.00, MS Windows v3.11,
  134.         MS Windows v95, 98, NT v4.0 and OS2 Warp 4 and has had
  135.         to problems.  Also, this software was written for Telegard
  136.         BBS Software v3.09g1, which is a pre-release of v3.10.
  137.         In the event any changes are made to Telegard before the
  138.         release of v3.10 TGFL will be update, although no changes
  139.         are expected.
  140.  
  141.  
  142.  
  143.  
  144.        Section 3.0    Installation and Operation
  145.  
  146.     The installation and operation of TGFL can be somewhat complicated
  147.     due to the large number of options it has and the range of things
  148.     it can preform.
  149.  
  150.     In the following sections, each and every option will be explained
  151.     in full detail.  In some instances a cross-reference may be listed
  152.     to help explain all possible operations.
  153.  
  154.  
  155.  
  156.        Section 3.1      Installing the Software
  157.  
  158.     To install TGFL simply unarchive the main package in to a directory
  159.     of your choice.  A sub directory off of your main BBS directory is
  160.     suggested, although you may place it anywhere you wish.
  161.  
  162.     Along with the installation procedures, you should add a line to
  163.     you AUTOEXEC.BAT file to help TGFL and many other utilities to
  164.     find your BBS software.  Telegard BBS software uses a standard
  165.     environment variable of "TELEGARD=C:\BBSDIR".  Some utilities
  166.     also support the "BBS=" environment variable.  If you are not
  167.     low on environment space, it is suggested that you place both
  168.     of these variables in your environment.  For more help on your
  169.     environment, refer to your operating system manual.
  170.  
  171.     Considerations when choosing a directory.
  172.  
  173.       1. Putting TGFL in your main BBS directory is not suggested,
  174.          the reason for this is simple.  TGFL has several optional
  175.          files it can be configured to use.  Even though at first
  176.          you may choose NOT to use these files, you may decide to
  177.          add them later.  The more files that are contained in your
  178.          main BBS directory the more difficult it is for you to
  179.          sort through them and know what file belongs to what other
  180.          application.
  181.  
  182.       2. It is strongly suggested that if you run a local network
  183.          that you place TGFL on a local drive.  Not only will your
  184.          computer be able to access TGFL faster, but TGFL creates
  185.          some temporary files that is uses to keep track of some
  186.          information.  TGFL will be able to access these files
  187.          and any others faster if it is not run over a network.
  188.  
  189.     After you have decided on a directory and unarchived this package
  190.     in to that directory, you will need to decide what it is that you
  191.     would like TGFL to do for you.  To help you decide I suggest that
  192.     you read the sections explaining the options that TGFL has and
  193.     review which ones you would like to use.
  194.  
  195.  
  196.  
  197.        Section 3.2      Command Line Options
  198.  
  199.     TGFL has many command line options that can be used to provide
  200.     several desired results.  All of the command line options will
  201.     be listed below with detailed information about each.  A short
  202.     description of all command line options is also provided by
  203.     TGFL when the /? or /H command line options are used, or when
  204.     no command line option is supplied.
  205.  
  206.     All options are list in alphabetical order;
  207.  
  208.     /?    This option tells TGFL to display a help screen.  The help
  209.           screen will also be displayed if no command line parameters
  210.           are given.
  211.  
  212.  
  213.     /#    This option tells TGFL to add the total number of downloads
  214.           for each file the list, below the file description.
  215.           (See also: Downloads=)
  216.  
  217.  
  218.     /BBSx This option tells TGFL to create a file named FILES.BBS
  219.           in each file directory that is processes.  This file can
  220.           be in one of four different formats.  To specify a format,
  221.           add the format number after the parameter. (Example: /BBS1)
  222.           (Note: CD-ROM areas are ignored)  (See also: MakeBBS=)
  223.           Below is a list of the formats.
  224.  
  225.            1 = RemoteAccess 1.xx  (13 spaces as long description seperator)
  226.            2 = RemoteAccess 2.xx  ("| " as long description seperator)
  227.            3 = ProBoard           ("+" as long description seperator)
  228.            4 = Maximus            (one long description line)
  229.  
  230.            If any number other than the above is specified, 1 is assumed.
  231.  
  232.  
  233.     /BL   This option tells TGFL to add a blank line at the end of every
  234.           file description.  This allows each file to be seperated by a
  235.           blank line for easier reading. (See also: SeperateDesc=)
  236.  
  237.  
  238.     /CFG: This option specifies a config or configuration file for
  239.           TGFL to use.  The config file can contain a number of options
  240.           and also makes it easier to configure multiple lists without
  241.           trying to get a command line just perfect.  The format for this
  242.           command is;
  243.  
  244.             TGFL /CFG:C:\DIR\TO\FILE\FILENAME.EXT
  245.  
  246.           The config file does NOT have to have any particular name OR
  247.           extension, as you must specify both on the command line, it
  248.           simply must be of the correct format.  (IE: plain text)
  249.           (See also: Config Files)
  250.  
  251.  
  252.     /D    This option tells TGFL to add the date on which the file was
  253.           uploaded to the list below the description.
  254.           (See also: UploadDate=)
  255.  
  256.  
  257.     /E    This option tells TGFL to display extended file information
  258.           after the file description.  This information tells wether
  259.           the file is a Free Download, Availible and wether or not it was
  260.           "Hatched" in to the file area.  This option ONLY works when
  261.           used with the /S option. (See also: ExtendedStatus=)
  262.  
  263.  
  264.     /EXC: This parameter specifies a path and filename to an Exclude
  265.           file. The Exclude file contains a list of file names of the
  266.           file bases.  These names are simply listed one on each line.
  267.  
  268.           For example;
  269.  
  270.             SYSOP
  271.             UPLOADS
  272.  
  273.           This will exclude the SYSOP and UPLOADS file areas from the
  274.           output files.  This filename and possibly the path are
  275.           specified the same way as the /CFG: command.
  276.           (See also: ExcludeFile=)
  277.  
  278.  
  279.     /FN   This option tells TGFL to filter extra spaces out of file
  280.           names.  So a name like "TEST    .ZIP" now becomes "TEST.ZIP".
  281.           This will make the list readible by many more programs such
  282.           as TimEd.  (See also: FilterName=)
  283.  
  284.  
  285.     /FTR: This option tells TGFL to use the specified FOOTER file.
  286.           This file is a basic ASCII (text) file that will be added
  287.           to the bottom of the output list file.  You can use this
  288.           file to provide detailed information about the files list
  289.           or your system.  (See also: FooterFile=)
  290.  
  291.  
  292.     /HDR: This option tells TGFL to use the specified HEADER file.
  293.           This files is a basic ASCII (text) file that will be added
  294.           to the top of the output list file.  This file works the
  295.           same as the footer file.  (See also: HeaderFile=)
  296.  
  297.     /HFT: This option tells TGFL to use the specified files as a
  298.           footer for all HTM files that it creates.  Since this
  299.           is a generalized footer, you cannot specify detailed
  300.           information about the file area directly.  Some MCI
  301.           codes can help provide this information though.
  302.           This file is layed out in HTML (HyperText Markup
  303.           Language) format and MUST end with;
  304.  
  305.             </body>
  306.             </html>
  307.  
  308.           (See also: HTMFooter= and Sample Files)
  309.           (Other HTML code may be used as well)
  310.  
  311.  
  312.     /HHD: This option tells TGFL to use the specified files as a
  313.           header for all HTM files that it creates.  Since this
  314.           is a generalized header, you cannot specify detailed
  315.           information about the file area directly.  Some MCI
  316.           codes can help provide this information though.
  317.           This file is layed out in HTML (HyperText Markup
  318.           Language) format and MUST end with;
  319.  
  320.             <html>
  321.             <body>
  322.  
  323.           (See also: HTMHeader= and Sample Files)
  324.           (Other HTML code may be used as well)
  325.  
  326.  
  327.     /HTMx This option tells TGFL to create an index.htm file in
  328.           each file directory that it processes.  This file contains
  329.           a list of all of the files in the directory, with size and
  330.           date information as well as description.  The HTML file
  331.           also contains links to the files for easy D/L from a web page.
  332.           Three different formats are accessable.
  333.  
  334.             1 = A table within a table, provides a nice border.
  335.             2 = A single table, no extra border.
  336.             3 = A single table, no borders at all, this makes
  337.                 the text seem to "float" on the page.
  338.  
  339.            Any number other than one of the above is ignored and
  340.            1 is assumed.  (See also: HTMType= & MakeHTM=)
  341.  
  342.     /IDXx This parameter instructs TGFL to create an index file
  343.           in the same directory as the files, for each area processed,
  344.           with a listing of only the files in that base.  This is a
  345.           simplified file and does not contain any totals information.
  346.           CD-ROM areas are ignored.  The optional "x" afterwards is a
  347.           number, either 1 or 2.  The default is 1.  This specifies the
  348.           desired file name only. (See also: IDXType= & MakeIDX=)
  349.  
  350.                    1 = 00index.txt
  351.                    2 = 00_index.txt
  352.  
  353.           The only difference in the two styles is the file name.
  354.  
  355.  
  356.     /INC: This parameter specifies a path and filename to an Include
  357.           file, this file contains a list of file names of the file bases.
  358.           These names are simply listed one on each line.  For example;
  359.  
  360.             GENERAL
  361.             TELEGARD
  362.  
  363.           This will include the GENERAL and TELEGARD file areas in the
  364.           output file (file list).  This filename and possible the
  365.           path are specified the same way as the /CFG: command.
  366.  
  367.           Rememver, if you specify an include file, ONLY the names
  368.           of the bases in this file will be in the output file.
  369.           (See also: IncludeFile=)
  370.  
  371.  
  372.     /IFT: This option tells TGFL to use the specified files as a
  373.           footer for all IDX files that it creates.  Since this
  374.           is a generalized footer, you cannot specify detailed
  375.           information about the file area directly.  Some MCI
  376.           codes can help provide this information though.
  377.           This file is layed out in plain ASCII.
  378.           (See also: IDXFooter= and Sample Files)
  379.  
  380.  
  381.     /IHD: This option tells TGFL to use the specified files as a
  382.           header for all IDX files that it creates.  Since this
  383.           is a generalized header, you cannot specify detailed
  384.           information about the file area directly.  Some MCI
  385.           codes can help provide this information though.
  386.           This file is layed out in plain ASCII.
  387.           (See also: IDXHeader= and Sample Files)
  388.  
  389.  
  390.     /LST: This option specifies the path and filename to an output
  391.           file.  If used the file that will be created by TGFL and
  392.           will contain the list of files in your files bases.  The
  393.           path and filename are specified the same as on the /CFG:
  394.           option. (See also: FileName=)
  395.  
  396.     /Nx   This option tells TGFL to list new files ONLY.  This is useful
  397.           when you want to create a list of new files that have been added
  398.           to your system recently.  You may optionally add a number ranging
  399.           between 0 and 9 after the N to denote the number of days old
  400.           an upload is before it is considered new.  The default age
  401.           is 5 days. (See also: NewDays=)
  402.  
  403.             NOTE:  The number zero (0) really means 10 days.
  404.  
  405.     /O    This option tells TGFL to append an "Overall Totals" area to
  406.           the bottom of the list with the total number of files and bytes
  407.           is all areas listed. (See also: OverallStats=)
  408.  
  409.     /S    This option tells TGFL to add a "Status" line, under the file's
  410.           description telling wether or not the file is offline or online,
  411.           and if it is validated or not. (See also: FileStatus=)
  412.  
  413.     /TF   This option tells TGFL to include a list of the top 10 overall
  414.           downloaded (i.e. most popular) files at the bottom of the output
  415.           list file. (See also: TopFiles=)
  416.  
  417.     /TI   This option tells TGFL to include the time of day next to the
  418.           date, if it is included (/D). (See also: UploadTime=)
  419.  
  420.     /TX   This option tells TGFL to make a basic text file which
  421.           contains no extended ASCII characters.  Very useful when
  422.           creating a list to be viewed on the www. (See also: BareText=)
  423.  
  424.             NOTE: This option does NOT filter ANY extended
  425.                   characters out of file descriptions.
  426.  
  427.     /U    This option tells TGFL to add the uploaders name to the list,
  428.           below the description. (See also: UploaderName=)
  429.  
  430.     /V    This option tells TGFL to NOT list files which are not validated
  431.           for download by the users yet. (See also: IgnoreUnvalidated=)
  432.  
  433.     
  434.  
  435.        Section 3.3      Config Files
  436.  
  437.     TGFL can optionally read a configuration file.  This file is a
  438.     simple ASCII (text) file containing a list of parameters for
  439.     the operation of TGFL.  This file can be extreemly helpful as
  440.     you can easily change settings without being forced to remember
  441.     a long and complicated command line.
  442.  
  443.     A config file is used by telling TGFL where it is.  Here is a
  444.     simple example;
  445.  
  446.                TGFL /CFG:TGFL.CFG
  447.                        or
  448.          TGFL /CFG:C:\BBS\TGFL\TGFL.CFG
  449.  
  450.     The file itself is layed out much like many other .cfg or .ini
  451.     files.  All lines starting with a simi-colon (;) are ignored,
  452.     as well as blank lines and lines containing text that is not
  453.     relivant.  Although, the more blank lines and lines containing
  454.     useless information there are the more time it will take TGFL
  455.     to read the file.
  456.  
  457.     An example file is proved in the SAMPLES.ZIP archive, it is
  458.     named TGFL.CFG.  Each possible option is listed in the file
  459.     and can be changed with ease.  There is also an easy reference
  460.     to the options in the Command Line Options section.  Each
  461.     command line option has a config file option as well.
  462.  
  463.  
  464.  
  465.        Section 3.4      Include/Exclude Files
  466.  
  467.     This section will explain the use of Include and Exclude files
  468.     with TGFL.
  469.  
  470.     Both of these files are layed out in the same format, the are
  471.     simple ASCII (text) file which contain a file name on each line
  472.     of the file.  The file names are the names of the data files
  473.     for each file area (base).  These names can be found from the
  474.     file bases editor within Telegard.  By default Telegard comes
  475.     packaged with two file areas.  These areas are the Sysop area
  476.     and the General Files area.  Thier default file names are SYSOP
  477.     and GENERAL.
  478.  
  479.     If you wanted to exclude your sysop area (which is strongly
  480.     suggested) from you over file list, you would use either an
  481.     exclude or include file to do so.  If you wanted to ONLY
  482.     exclude the sysop file area and to allow all other file areas
  483.     to be processed you would put the sysop area in the exclude
  484.     list and tell TGFL the filename of the exclude list so it
  485.     will use it.
  486.  
  487.     Both the include and exclude lists can contain a maximum of
  488.     1,000 areas each.  Both files may also be used at the same
  489.     time if you want, although the exclude file is processed
  490.     AFTER the include file, so if you added a base in the
  491.     include file to be processed and also listed it in the
  492.     exclude file as well, it would not be processed.
  493.  
  494.  
  495.  
  496.        Section 3.5      Header/Footer Files
  497.  
  498.     TGFL also has the option to use header and footer files.  The
  499.     format of these files varies depending on which ones they are.
  500.  
  501.     The normal header and footer files are plain ASCII, as well as
  502.     the IDX header and footer files.  The HTM header and footer
  503.     files are in HTML (Hyper Text Markup Language) format.
  504.  
  505.     When you create either a main list, idx files or htm files and
  506.     tell TGFL to use headers/footers it will add the information
  507.     contained in those files to the desired output files.
  508.  
  509.     These files can be used to contain extended information about
  510.     the files and the BBS system.  Examples of all of the files
  511.     are provided in the SAMPLES.ZIP archive included with TGFL.
  512.  
  513.     You may also use MCI code to provided up to date information
  514.     about the system within these files.  Check the MCI Codes
  515.     section for deatiled information about what MCI codes are
  516.     availible and how to use them.
  517.  
  518.  
  519.  
  520.        Section 3.6      MCI Codes
  521.    
  522.     TGFL will translate several MCI codes which can be put in any
  523.     of the header or footer files.  To use these codes, simply place
  524.     them in the header/footer file where you desire the information
  525.     to be placed.
  526.  
  527.        System Information
  528.        ~SA     System Name
  529.        ~SB     System Location
  530.        ~SF     System Phone #
  531.        ~SV     Telegard Version
  532.        ~FB     File Base Name
  533.  
  534.        Time/Date Information
  535.        ~DL     Day Name (Long)
  536.        ~DN     Abbreviated Day Name
  537.        ~DY     Day of month
  538.        ~DZ     Day of month (Leading Zero)
  539.        ~HR     Hour (1-12)
  540.        ~HZ     Hour (Leading Zero / 0-23)
  541.        ~MI     Minute (Leading Zero)
  542.        ~ML     Month Name (Long)
  543.        ~MN     Month Number (Leading Zero)
  544.        ~MS     Month Name (Short)
  545.        ~SC     Second (Leading Zero)
  546.        ~TP     PM/AM
  547.        ~YR     Year (xx)
  548.        ~YL     Year (xxxx)
  549.  
  550.  
  551.  
  552.        Section 4.0    Additional Product Information
  553.  
  554.     This section contains additional information about TGFL, the
  555.     people that have helped produce it and many other things.  If
  556.     you like TGFL, please take the time to read this section so
  557.     you can better understand the people that have worked on this
  558.     project and possible take a chance to send them a message to
  559.     say thanks for their help.
  560.  
  561.  
  562.  
  563.        Section 4.1      Product Revisions/Changes
  564.  
  565.             + Added     * Changed/Fixed   - Removed     ! Notes
  566.  
  567.  
  568.  
  569.                               v1.00
  570.  
  571.             ! First version.
  572.  
  573.  
  574.                               v1.10
  575.  
  576.             + Added the /N command line parameter.  This
  577.               tells TGFL to list new files ONLY.
  578.             + Added some TG version checking code.
  579.             + Added file list totals on the screen, now
  580.               list total number of files and areas scanned
  581.               including time (number of seconds) that it
  582.               took to create the list.
  583.             + Added Color Code Filtering (Both `xx and |xx)
  584.               in file descriptions as well as area names.
  585.             + Now also translates TG color codes in the area
  586.               descriptions (on local display while processing).
  587.             + Added checking for the "TELEGARD=" environment
  588.               variable.  If found, it is used to find the
  589.               CONFIG.TG file if one does not exist in the
  590.               directory that TGFL is in.
  591.             + Added (/O) Overall Totals option.
  592.             * Spruced things up so they look a little better.
  593.               Added some color and such.
  594.             * Fixed bug which caused files to not be listed
  595.               if there was no description.
  596.             * You can now use the "-" delimiter as well as "/"
  597.               for command line options.
  598.             * Fixed bug which caused the ignore list not to work
  599.               properly. (Causes by a last minute change, sorry
  600.               folks.)
  601.             * The "/ver" command line option is no longer case
  602.               sensitive.
  603.  
  604.  
  605.                               v1.11
  606.  
  607.             * Now filters the display of empty file bases.
  608.             * Description are now seperated with a CR/LF
  609.               instead of just a CR.  (Thanks Lars)
  610.             * Now excepts command line like;
  611.               (TGFL FILES.LST /#/d/o) with no spaces
  612.               between the options.
  613.             ! Minor bug fix over 1.10, which most folks
  614.               never saw.
  615.             ! TGFL currently chops the file descriptions at 45
  616.               characters MAX.  I'll see what I can do about
  617.               this in the future.
  618.  
  619.  
  620.                               v1.20
  621.  
  622.             + Added /TX option, which produces a simplified
  623.               ascii file similar to a FILES.BBS file.
  624.             + Added status bars.
  625.             * Now supports over 2gigs of files in listing.
  626.               (limit should now be roughly 2,147 gigs)
  627.             * Help screen is now displayed if no command line
  628.               is passed.
  629.             * Changed the local display around again.  ;}
  630.             * Blank line between descriptions is now optional
  631.               via the /B command line option.
  632.             * Filenames can now optionally have the spaces removed
  633.               to be more friendly to things like TimEd.
  634.             * The /T command line has been changed to /TI.
  635.             * You may now, optionally, specify the number of
  636.               days old a file needs to be to be considered
  637.               new.  Days range from 1 to 10.
  638.             * Fixed bug which caused the description to be
  639.               separated by a spare line if the extended
  640.               file stats were included.
  641.             * Re-wrote unix date code with some help from
  642.               SWAG donators.
  643.             * Fixed Pentium II (200mhz+) bug.
  644.             * Fixed bug which caused TG not to find .FA/.FAD
  645.               files if they were in a path other than the
  646.               default file path.
  647.  
  648.  
  649.                               v1.21
  650.  
  651.             * Fixed minor output bug which put the wrong title
  652.               line above the file area stats on a text list
  653.               when the overall totals were added.
  654.             * I did some work on the description reading
  655.               code.  All tests I have done show it to be
  656.               only slightly faster, but, it should be
  657.               more stable now.
  658.             * Fixed bug that caused TGFL to freeze up some
  659.               times if a description ended in a color code.
  660.               IE (Whatever`70) but not (Whatever`70{CR}{LF}).
  661.  
  662.  
  663.                               v1.30
  664.  
  665.             + Added a config file.
  666.             + Added top files (downloads) list.  (/TF)
  667.             + Added the include/exclude/header/footer file
  668.               names to the main screen so you know which ones
  669.               TGFL is using.
  670.             + TGFL now checks the environment for BBS= as well
  671.               as TELEGARD= in order to find the CONFIG.TG.
  672.             - Removed the default search for the exclude file.
  673.               This file must now either be specified on the
  674.               command line or via the config file.
  675.             * Fixed bug which removed the spaces from
  676.               file base headers in TEXT (/TX) mode.
  677.             * Removed the odd number from the local display
  678.               when TGFL was finished.  My appologies, it was
  679.               some debug code.
  680.             * Fixed bug which caused some descriptions (actually
  681.               most) to be ended with a blank line.  This was
  682.               caused by the new description reading code.
  683.             * The output file name on the command line has been
  684.               changed, it is no longer the first parameter, it
  685.               must now be specified via a command line switch.
  686.               This was done because of the command line changes
  687.               for the new config file.
  688.             * Worked on the error checking code some.  Fixed one
  689.               bug and made some changes to make it easier to know
  690.               what happened.
  691.             * Fixed visual bug which caused the name of the file
  692.               being processed to be right justified instead of
  693.               left justified if the filter spaces option is used.
  694.             - Removed the default search for the TGFL.HDR and
  695.               TGFL.FTR files, they are now passed via the command
  696.               line or config file.
  697.  
  698.  
  699.                               v1.40
  700.  
  701.             + Added code to check for OS version information,
  702.               which is now displayed near the top of the screen.
  703.               The main part of this code was donated by Tim Strike.
  704.               It will search and find OS2 v2.00+, DESQView v2.00+,
  705.               Windows v3.00+ (Including 95/98/NT) and MS-DOS
  706.               versions.  If TGFL finds OS2/DV/WIN it will release
  707.               time slices (one between each file area).
  708.  
  709.             + Added ability to translate some MCI codes in all header
  710.               & footer files.  Look at TGFL.DOC for a list of them.
  711.               At this time there are no justifing type MCI codes, I'll
  712.               likely add this later, I wanted to see if they MCI's are
  713.               going to work out and be useful first.
  714.  
  715.             + Added ability to create 00index.txt/00_index.txt files
  716.               in each file directory.
  717.  
  718.             + Added ability to create files.bbs files in each file
  719.               directory.  Four different formats are supported.
  720.               Special thanks to Jeff Irvine for his work on
  721.               TG2FBBS.EXE that helped me figure out the different
  722.               formats.
  723.  
  724.             + Added ability to create index.htm files in each
  725.               directory, these html files also have a link to the
  726.               file, for easy downloading.
  727.  
  728.             * Fixed minor bug, TGFL was NOT filtering the colors from
  729.               the base names unless you used TEXT output.  Sorry about
  730.               that.
  731.  
  732.             * Fixed old bug which was causing TGFL not to search
  733.               the environment for the "BBS=" variable.
  734.  
  735.             * Switched over to Tim Strike's time/date code for
  736.               handling the unix timestamps.
  737.  
  738.             * Changed the top files code around, thanks for the code
  739.               suggestions Ken.
  740.  
  741.             * TGFL is no longer dependant on creating a single all
  742.               files list.  You now may choose only to create say the
  743.               FILES.BBS, unlike the first addition of the 00index.txt
  744.               code where it was an add on.
  745.  
  746.             * Fixed bug which caused TGFL to error out if the config
  747.               file you specified did not exist.
  748.  
  749.             * The /B command line parameter has been changed to /BL to
  750.               make it easier to add te /BBSx command line parameter.
  751.  
  752.             * Fixed bug in the INI code which caused TGFL not to find
  753.               the number of days old a file is to be new.
  754.  
  755.             * Reworked the help screen, made it more user interactive.
  756.  
  757.             * Changed the error handling code output to be more screen
  758.               friendly, IE, it always puts all error messages in the
  759.               same color and in the same place now.
  760.  
  761.             * If only /CFG is used on the command line, the name
  762.               "TGFL.CFG" is assumed.
  763.  
  764.  
  765.  
  766.  
  767.  
  768.        Section 4.2      Product Coders and Testers
  769.  
  770.     Coders that have helped and how;
  771.  
  772.          David Stumpf  - TGFL main author.
  773.          Tim Strike    - Proveded a lot of code ideas as
  774.                          well as the majority of the
  775.                          multitasker code.
  776.          Ken Reaverson - Helped write the top 10 files code
  777.                          and provided many other helpful
  778.                          suggestions.
  779.          Doug Reynolds - Author of TGCOLOR, and very handy
  780.                          Pascal unit that made translating
  781.                          color codes for local display a lot
  782.                          easier.
  783.          Scott Adams   - Helped with a lot of code concepts
  784.                          and ideas.
  785.          Lars Hellsten - Helped with code concepts and ideas.
  786.  
  787.  
  788.     Product Testers
  789.  
  790.                    Name: Ken Reaverson
  791.                  Handle: Forsaken
  792.                   EMail: tremere@mindless.com
  793.                   BBS #: 770-985-7396
  794.                     WEB: http://www.darktech.org/shadowdale/
  795.                     ICQ: 12241816
  796.                  Duties: Preform pre-release testing of software
  797.                          to insure bug free releases and help with
  798.                          code concepts.  Did the majority of the
  799.                          FILES.BBS testing and also provided the
  800.                          format information.
  801.  
  802.                    Name: Arthur Stark
  803.                  Handle: Top
  804.                   EMail: tdm@tdm.vvm.com
  805.                   BBS #: (254) 539-8311
  806.                  Telnet: tdm.vvm.com
  807.                     FTP: ftp://tdm.vvm.com
  808.                     WWW: http://tdm.vvm.com/
  809.                     IRC: tdm.vvm.com port 6667
  810.                     ICQ: 4493333
  811.                     AIM: thangaar23
  812.                  Duties: Preform pre-release testing of software
  813.                          to insure bug free releases.  Did the
  814.                          majority of the IDX and HTM testing.
  815.  
  816.                    Name: Mike Jackson
  817.                   BBS #: 281-324-2745
  818.                  Duties: Preform pre-release testing of software
  819.                          to insure bug free releases.  Helped a
  820.                          lot with the first versions.
  821.  
  822.  
  823.  
  824.        Section 4.3      Future Plans
  825.  
  826.     Currently TGFL supports all of the options that have been asked
  827.     for by poeple.  If you have any more suggestions for it, please
  828.     feel free to send your suggestions.
  829.  
  830.     The current plan is to keep updating TGFL as long as it has a
  831.     strong user base and people continue to make suggestions.  I
  832.     hope you stick around and keep up with the development of this
  833.     application as I hope it will be around and kicking for a long
  834.     time to come.
  835.  
  836.  
  837.  
  838.        Section 5.0    Error Codes Defined
  839.  
  840.  
  841.         1       No Output format specified.  This error is caused by
  842.                 not specifing what type of file(s) you wish to create.
  843.  
  844.         2       FILE NOT FOUND; a file is missing that either was just
  845.                 existent, or is vital to operation
  846.  
  847.         3       PATH NOT FOUND; a invalid path was referenced
  848.  
  849.         4       TOO MANY OPEN FILES; increase your FILES= statement in
  850.                 your CONFIG.SYS to increase the number of file handles
  851.                 available to the system
  852.  
  853.         5       FILE ACCESS DENIED; commonly caused by READ-ONLY files
  854.                 which shouldn't be flagged RO; also caused by referencing
  855.                 a directory instead of a file; various other causes, 
  856.                 mostly due to poor programming (let me know about these ;)
  857.  
  858.  
  859.         I/O ERRORS
  860.  
  861.         100     DISK READ ERROR; a file is likely damaged or an incomplete
  862.                 record has been appended to the end.
  863.  
  864.         101     DISK WRITE ERROR; disk drive is full, get rid of some junk!
  865.  
  866.         102     FILE NOT ASSIGNED; design problem, report all such 
  867.                 occurrences immediately.
  868.  
  869.         103     FILE NOT OPEN; file has been prematurely closed (by this
  870.                 process or another process), report immediately.
  871.  
  872.         104     NOT OPEN FOR INPUT; a design problem, report immediately.
  873.         105     NOT OPEN FOR OUTPUT; a design problem, report immediately.
  874.  
  875.  
  876.         CRITICAL ERRORS
  877.  
  878.         These errors, with the exception of 162, are not likely to occur as
  879.         a result of program design; rather they are critical OS errors and
  880.         need to be fixed outside of the system -- at the OS level (i.e.
  881.         DISKFIX, etc).
  882.  
  883.         150     DISK IS WRITE PROTECTED
  884.         152     DRIVE NOT READY
  885.         156     DISK SEEK ERROR
  886.         157     UNKNOWN MEDIA TYPE
  887.         158     SECTOR NOT FOUND
  888.         159     PRINTER OUT OF PAPER
  889.         160     DEVICE WRITE FAULT
  890.         161     DEVICE READ FAULT
  891.         
  892.         162     HARDWARE FAILURE; reported as a result of SHARE or NETWORK
  893.                 errors; first check the other processes to ensure that they
  894.                 haven't locked the file from complete access and then 
  895.                 terminated (leaving the file unavailable).  Try rebooting 
  896.                 to see if that helps, and make sure two incompatible 
  897.                 processes are not being run at the same time.  Report all
  898.                 other occurrences immediately.
  899.  
  900.  
  901.         FATAL ERRORS
  902.  
  903.         200     DIVISION BY ZERO; error is potentially caused by program 
  904.                 design.
  905.  
  906.  
  907.         These errors are for the most part caused entirely by errors in
  908.         program design -- please report them immediately.
  909.                 
  910.         201     RANGE CHECK ERROR
  911.         202     STACK OVERFLOW
  912.         203     HEAP OVERFLOW
  913.         204     INVALID POINTER OPERATION
  914.  
  915.  
  916.  
  917.  
  918.        Section 6.0    Acknowledgments
  919.  
  920.     Telegard is Copyrighted by Tim Strike
  921.     MS-DOS is Copyrighted by MircoSoft Inc.
  922.     Windows is Copyrighted by MircoSoft Inc.
  923.     OS2 is Copyrighted by Internation Business Machines
  924.     IBM is Trademarked by Internation Business Machines
  925.     TimEd is Copyright Gerard van Essen
  926.