home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 15 / CD_ASCQ_15_070894.iso / vrac / tfl110.zip / TFL.DOC < prev    next >
Text File  |  1994-06-06  |  9KB  |  176 lines
  1.                 TFL v1.1
  2.                 (c) 1994 Aphelion Software
  3.                 By Daniel Mecklenburg
  4.  
  5. Here's yet another File List generator for TAG BBS. Only thing I can 
  6. promise is that is will work with version 2.7 standard!
  7.  
  8. To use, call TFG with one parameter, the name of the config file. 
  9. Example:  TFG TFG.CFG
  10.  
  11. The config file contains information on how the list(s) are to be created
  12. These key words are:
  13.  
  14.     FBOARDS = <path and name of the FBOARDS.DAT file>
  15.         This keyword defines the location of the FBOARDS.DAT file. It
  16.         is required and must appear before any LIST keyword. Only one
  17.         is allowed per config file. This keyword is global only.
  18.  
  19.     MFILEPATH = <path to the multi file directory\>
  20.         This keyword defines the location of the MULTI directory. It
  21.         is only required if *.DIR contain a "`" before them to specify
  22.         that the .DIR file is located in the MULTI directory. Only one
  23.         is allowed per config file. This keyword is global only.
  24.  
  25.     DFILEPATH = <path to the DFILES directory\>
  26.         This keyword defines the location of the DFILES directory. It
  27.         is only required if *.DIR contains a "@" before them to specify
  28.         that the .DIR file is located in the DFILES directory. Only one
  29.         is allowed per config file. This keyword is global only.
  30.  
  31.     LISTHEADER = "<string>"
  32.         These keywords (up to ten) describe the file list header. The
  33.         <string> information can contain variables but it is not 
  34.         recommended for the listheader as no information has been obtained
  35.         for the files as of yet. You may get unknown information if you
  36.         do.  See STRINGS for information on variables. This command can
  37.         either be global (applies to all lists) or local (applied to only
  38.         this list).
  39.  
  40.     LISTFOOTER = "<string>"
  41.         These keywords (up to ten) describe the file list footer. The
  42.         <string> information can contain variables.  See STRINGS for 
  43.         information on variables. This command can either be global 
  44.         (applies to all lists) or local (applied to only this list).
  45.  
  46.     AREAHEADER = "<string>"
  47.         Examples: AREAHEADER = "Area Name: %A"
  48.                   AREAHEADER = "Filename      Description"
  49.         These keywords (up to ten) describe the area list header. The
  50.         <string> information can contain variables.  See STRINGS for 
  51.         information on variables. This command can either be global 
  52.         (applies to all lists) or local (applied to only this list).
  53.  
  54.     AREAFOOTER = "<string>"
  55.         Example: AREAFOOTER = "Total file(s): %K"
  56.         These keywords (up to ten) describe the area list footer. The
  57.         <string> information can contain variables.  See STRINGS for 
  58.         information on variables. This command can either be global 
  59.         (applies to all lists) or local (applied to only this list).
  60.  
  61.     FORMAT = "<string>"
  62.         Example: FORMAT = "%F %I"
  63.         These keywords (up to ten) describe the file descriptor. The
  64.         <string> information can contain variables.  See STRINGS for 
  65.         information on variables. This command can either be global 
  66.         (applies to all lists) or local (applied to only this list).
  67.  
  68.     LIST = <path and name of this list file>
  69.     ENDLIST
  70.         Example: LIST = C:\LISTS\ALLFILES.TXT
  71.         These two keywords define a list file and what is to be contained
  72.         in it. Any commands falling inbetween a LIST and ENDLIST are
  73.         local keywords. Any commands falling outside are global. LISTs
  74.         can not be imbedded and at least one must be in the config file.
  75.         If no AREAHEADER's, AREAFOOTER's, or FORMAT's are described inside
  76.         a list block, global definitions are used.
  77.  
  78.     DSL = <list of DSL's>
  79.         Example: DSL = 10-30,50
  80.         This keyword defines the DSL's that will appear in the file list.
  81.         The list of DSL's must be in the format of # or #,#,... or #-#,...
  82.         whereas # is a security level. This is a local only keyword and is
  83.         optional. If it is left off, *all* DSL's will be included in this
  84.         list.
  85.  
  86.     AR = <list of AR flags>
  87.         Example: AR = @-M,X
  88.         This keyword defines the AR flags that will appear in the file list.
  89.         The list of AR flags must be in the format of # or #,#,... or #-#,...
  90.         whereas # is an AR flag. This is a local only keyword and is
  91.         optional. If it is left off, *all* AR flags will be included in this
  92.         list.
  93.  
  94.     BOARDS = <list of board numbers>
  95.         Example: BOARDS = 0,20-51,53-55,75
  96.         This keyword defines the boards that will appear in the file
  97.         list. This list of boards must be in the format of # or #,#,... or
  98.         #-#,... whereas # is a board number. This is a local only keyword
  99.         and is optional. If it is left off, *all* boards will be included
  100.         in this list.
  101.  
  102.     UNVALIDATED
  103.     CDROM
  104.     OFFLINE
  105.         If any of these three local only commands appear in a LIST block,
  106.         either unvalidated files, files from CD-ROM's, and/or offline files 
  107.         will be included in the list.
  108.  
  109.     FIXSIZE
  110.         This keyword will tell TFL to correct any error with file sizes
  111.         or to mark files not found as offline. This only works with
  112.         Non-CD-Rom areas.
  113.  
  114.     FIXDATE
  115.         This keyword will tell TFL to correct the upload file date to
  116.         match that on the file itself. This only works with Non-CD-Rom 
  117.         areas.
  118.  
  119.     DOWNLOADS = <minimum number of times downloaded>
  120.     ULAGE = <age of file from ul date in days>
  121.     FILEAGE = <age of file from date/time stamp in days>
  122.         These additional local only commands are used to further filter
  123.         out files from the list. These can be used to create lists of
  124.         popular or new file lists.
  125.  
  126.     Notes: In order for a file to appear in the list, all criteria must
  127.         be meet. The board number, DSL, AR, unvalidated and/or CDRom
  128.         specifiers are all tested and if the file passes, it is written
  129.         to the list.
  130.  
  131.     STRINGS: Strings used in LISTHEADER's, LISTFOOTER's, AREAHEADER's,
  132.         AREAFOOTER's, and FORMAT's all use strings enclosed in double
  133.         quotes. No double quotes can appear in the string whatsoever.
  134.         Variables may appear in the strings. These appear as a % followed
  135.         by a letter.  These are replaced with information prior to
  136.         writting data to the list file. Variable are:
  137.  
  138.            VAR. DESCRIPTION             SIZE
  139.            ---- ----------------------- ---------
  140.             %A  area name               26 characters
  141.             %B  file blocks              5 characters
  142.             %C  date of upload           8 characters (mm/dd/yy)
  143.             %D  date on file             8 characters (mm/dd/yy)
  144.             %E  file extenion only       3 characters
  145.             %F  full file name          12 characters- packed
  146.             %G  file name only           8 characters
  147.             %H  file description        must be the last field, no word wrap
  148.             %I  file description        must be the last field, word wrapped
  149.             %J  name of uploader        36 characters
  150.             %K  number of files in area  4 characters
  151.             %L  path here files live    60 characters
  152.             %M  area size                7 characters ( "##,###k")
  153.             %N  area size               10 characters ( "##,###,###")
  154.             %O  file size                7 characters ( "##,###k",
  155.                                                         "OFFLINE",
  156.                                                         "UNVAL'D")
  157.             %P  file size               10 characters ( "####,###,###",
  158.                                                         "   OFFLINE",
  159.                                                         "UNVALIDT'D")
  160.             %Q  time of file             5 characters (hh:mm)
  161.             %R  times downloaded         5 characters (#####)
  162.             %S  number of areas in list  5 characters
  163.             %T  Area number              5 characters
  164.  
  165.         ANSI, TAG color codes, and/or RIP sequences can appear in the
  166.         strings as well with no difficulty with the exception of the %I 
  167.         variable. Due to the special codes, the position where the line
  168.         is broke and continues for word wrap will be miss places. Use
  169.         as your own risk! To be safe, DO NOT put special color/control
  170.         characters in strings containg the %I varaible!
  171.  
  172.     CD-ROM files are not check for actual file size and time stamps.
  173.         It the time is required for CD-ROM files, a ??:?? is used.
  174.  
  175.     If you find this program useful, send yourself $10.
  176.