home *** CD-ROM | disk | FTP | other *** search
/ PC-Online 1998 February / PCOnline_02_1998.iso / filesbbs / dos / flit10d.exe / FLIT.DOC < prev    next >
Encoding:
Text File  |  1995-09-03  |  9.9 KB  |  250 lines
  1.  
  2.  
  3.         FFFFFFFFF  LLLL       IIII  TTTTTTTTTT
  4.         FFFF       LLLL       IIII     TTTT
  5.         FFFFFFFFF  LLLL       IIII     TTTT
  6.         FFFF       LLLL       IIII     TTTT
  7.         FFFF       LLLLLLLLL  IIII     TTTT
  8.  
  9.         File       LIst                Tool
  10.  
  11.         FLIT 1.0d (C) 1994 Whirlwind Software
  12.         A FILES.BBS-compatible file list compiler for DOS BBSes
  13.  
  14.         ╔══════════╗
  15.         ║ Features ║
  16.         ╚══════════╝
  17.  
  18.         - Flat text-file configurability
  19.         - One-pass total and new-files mode
  20.         - Global totals stored in 64-bit integers - no 4 gig rollover!
  21.         - Support for CD-ROMs and other systems where FILES.BBS is in
  22.             a different directory from the files
  23.         - Space-efficient "Terse" mode
  24.         - "Verbose" mode with wrapped descriptions up to 240 characters
  25.         - SysOp definable headers and footers
  26.         - FAST!  Faster than FEBBS 1.92 and AvaiList 1.60
  27.         - Low-cost registration: Only $10
  28.  
  29.         ╔═══════════╗
  30.         ║ Shareware ║
  31.         ╚═══════════╝
  32.  
  33.         FLIT is inexpensive shareware.  I believe it is superior in many
  34.         ways to other similar programs which cost more.  If you appreciate
  35.         getting value for your money then you won't be disappointed by this
  36.         program.  Registration will remove the "Unregistered Evaluation"
  37.         message in the footer.
  38.  
  39.         To register this program, send your name, address and $10 (US)
  40.         to:
  41.  
  42.                         Whirlwind Software
  43.                         P.O. Box 5874
  44.                         Victoria, B.C.
  45.                         Canada   V8R 6S8
  46.  
  47.         Please specify disk format (3-1/2" or 5-1/4").  Also, please
  48.         mention FLIT so that we know which of our many products you're
  49.         registering!
  50.  
  51.  
  52.         ╔════════════════════════╗
  53.         ║ The Configuration File ║
  54.         ╚════════════════════════╝
  55.  
  56.         By default, the configuration file is FLIT.CFG in the current
  57.         directory.  You can specify a different file name by using the
  58.         /C command line parameter (q.v.).
  59.  
  60.         The configuration file is a simple text file with several
  61.         options.
  62.  
  63.         The OUTPUT option determines the filename to write the main list
  64.         to.  By default, it is FLIT.TXT.  Example:
  65.  
  66.         output          FLIT.TXT
  67.  
  68.  
  69.         The HEADER option determines the filename of an optional Header
  70.         file, that is, a text file of your choosing prepended to the
  71.         main list.  By default, it is FLIT.HDR.  Example:
  72.  
  73.         header          FLIT.HDR
  74.  
  75.  
  76.         The FOOTER option, as you may have guessed, is the opposite of
  77.         the HEADER, and specifies a text file to be appended to the end
  78.         of the main and new-file lists.  By default, it is FLIT.FTR.
  79.         Example:
  80.  
  81.         footer          FLIT.FTR
  82.  
  83.  
  84.         The TERSE and VERBOSE options determine whether FLIT operates in
  85.         terse or verbose mode.  In verbose mode, the full description
  86.         from FILES.BBS (up to 240 characters) is preserved in the list
  87.         and is word-wrapped for easy reading.  In terse mode, any
  88.         description which would require more than one line to properly
  89.         display is unceremoniously truncated just before the end of the
  90.         line.  This way each file entry is guaranteed to occupy only one
  91.         line in the list, and such a list is more compact.  The terse
  92.         mode may be better if you have a truly huge file count and want
  93.         to keep the size of the list manageable; the verbose mode is
  94.         better if the full descriptions are more important to you.  By
  95.         default, FLIT uses verbose mode.  Note the use of a semicolon to
  96.         "comment-out" the unwanted option below.
  97.  
  98.         terse
  99.         ;verbose
  100.  
  101.  
  102.         The NEWONLY option instructs FLIT not to generate a main file
  103.         list at all, but rather to generate a new-files list only.  This
  104.         has the same effect as the /N command line switch.  By default,
  105.         FLIT will generate a main list.  Example:
  106.  
  107.         newonly
  108.  
  109.  
  110.         The NEW option has as a parameter the number of days old a file
  111.         should be to be considered "new."  Files which are "new" are
  112.         included in the new-files list and are also indicated with an
  113.         asterisk in the main list.  If this option is not present or is
  114.         commented out, no new-files list will be generated.  In the
  115.         example below, FLIT will list all files 30 days or newer in its
  116.         new-files lists.
  117.  
  118.         new             30
  119.  
  120.  
  121.         The NEWHEADER option specifies a header file for the new-files
  122.         list.  This is similar to the HEADER option, except that you
  123.         might want to include notation in your new-files header that it
  124.         is a list of new files.  By default, this header file is
  125.         FLIT-NEW.HDR.  Example:
  126.  
  127.         newheader       FLIT-NEW.HDR
  128.  
  129.  
  130.         The NEWOUTPUT option specifies the output filename for the
  131.         new-files list.  By default, it is FLIT-NEW.TXT.  Example:
  132.  
  133.         newoutput       FLIT-NEW.TXT
  134.  
  135.  
  136.         The MISSING option instructs FLIT to include files which are
  137.         listed in the FILES.BBS file but which do not actually exist.
  138.         By default, missing files are not listed.
  139.  
  140.         missing
  141.  
  142.  
  143.         If missing files are listed, the MISSINGMSG option specifies the
  144.         string to be placed where the file size and date would normally
  145.         be.  This string can be up to 15 characters long and should
  146.         indicate that the file is missing.  By default this string is
  147.         --- MISSING ---.  Example:
  148.  
  149.         missingmsg      ((( Missing )))
  150.  
  151.  
  152.         The BOX option specifies the characters used to make up the
  153.         borders around the area headers and totals footer.  As you can
  154.         see from the example below, it is a six-character string.  The
  155.         first character is the upper-left corner, the second is the
  156.         upper-right, the third is the lower-left, the fourth is the
  157.         lower-right corner.  The fifth character is a horizontal line
  158.         and the sixth is a vertical line.  You can change these to any
  159.         combination that makes sense.
  160.  
  161.         box             ╔╗╚╝═║
  162.  
  163.  
  164.         The SKIPBLANK option instructs FLIT to ignore blank (zero
  165.         length) lines.  If you use such lines as comments in your
  166.         FILES.BBS you will not want to use this option, however if your
  167.         files are spaced apart (perhaps unintentionally) by such lines
  168.         then this option will produce a neater looking list.  By default
  169.         FLIT will not skip blank lines.
  170.  
  171.         ;skipblank
  172.  
  173.  
  174.         The AREA option can be repeated as many times as you need - once
  175.         for each file area.  It has several parameters.  First is the
  176.         directory where the actual files live.  Normally, FLIT also
  177.         looks for FILES.BBS in this area.  There is an optional second
  178.         parameter.  You can specify another path or filename for
  179.         FILES.BBS by putting an at-sign ("@") before this path as the
  180.         second parameter - see the example below.  If you specify only a
  181.         path in this second parameter, FLIT will look for FILES.BBS in
  182.         this location.  If you specify a filename, FLIT will look for
  183.         that filename in the same path as the file path (first
  184.         parameter).  If you specify a fully pathed filename, FLIT will
  185.         take it verbatim and expect to find a FILES.BBS-compatible
  186.         textfile at that location.  If the second parameter is not
  187.         present (i.e. if you don't specify a second path or file name
  188.         with an @ in front) then everything after the first parameter is
  189.         assumed to be a description of the file area.
  190.  
  191.         The examples below show two normal file area entries and two on
  192.         CD-ROMs which have separate FILES.BBS listings on a hard disk.
  193.  
  194.         area    c:\file\uploads         New Upload Files
  195.         area    c:\file\terminal        Telecom Software
  196.         ;
  197.         ;
  198.         area    d:\file\wordpro  @c:\cdrom\wordpro.bbs  CD-ROM: Word Processing Files
  199.         area    d:\file\games    @c:\cdrom\games.bbs    CD-ROM: Games for Fun
  200.  
  201.  
  202.  
  203.  
  204.         ╔═════════════════════════╗
  205.         ║ Command Line Parameters ║
  206.         ╚═════════════════════════╝
  207.  
  208.         There are only two command line parameters:
  209.  
  210.                 /Cfilename : This specifies a file name other than
  211.                              FLIT.CFG for the config file.  This way,
  212.                              you can produce topical lists automatically
  213.                              by using multiple config files.
  214.  
  215.                 /N : This instructs FLIT to produce only a new-files
  216.                      list.
  217.  
  218.         If you have a properly defined FLIT.CFG, you ought to be able to
  219.         run FLIT effectively with no command line parameters at all!
  220.  
  221.  
  222.         ╔══════════╗
  223.         ║ Warranty ║
  224.         ╚══════════╝
  225.  
  226.         No warranties of any kind.  We do not even warrant this program
  227.         to occupy space, nor even that you will be satisfied with the
  228.         space it may or may not occupy.  When we start making enough
  229.         money to hire a starving law student for a few hours to draft up
  230.         a mickeymouse warranty that we can actually honour in any
  231.         situation, we'll do it, otherwise this program has a warranty of
  232.         30 angstroms or 30 picoseconds, whichever comes first (grin).
  233.  
  234.  
  235.         ╔═══════════════════════╗
  236.         ║ Contacting the Author ║
  237.         ╚═══════════════════════╝
  238.  
  239.         This program is written by Gerald Albion of Whirlwind Software.
  240.         Gerald can be reached for comments, bug reports, questions and
  241.         suggestions, at ue075@freenet.victoria.bc.ca on the Internet, or
  242.         at 1:340/26 on Fidonet.
  243.  
  244.         Support is also available by BBS on THC BBS:
  245.  
  246.            +1 604 361 4549  (300-33600 bps USR DS V*.*)
  247.            +1 604 380 6467  (300-28800 bps Hayes V.FC)
  248.            +1 604 360 0628  (300-14400 bps Vanilla V.32bis)
  249.  
  250.