home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / CEREBRUM / WWCFL220.ZIP / WWCFL.DOC < prev    next >
Text File  |  1995-07-14  |  10KB  |  249 lines
  1. ┌───────────────────[ A Cerebrum Programming Production ]────────────────────┐
  2. │                                         │
  3. │                 WWCFL v2.2                     │
  4. │             WWIV Conference File Lister                 │
  5. │            Copyright (c) 1993-1995 by Frank Reid             │
  6. │                 All Rights Reserved                 │
  7. │                                         │
  8. │            An External File List Creation Utility             │
  9. │             for WWIV v4.24 BBS Systems                 │
  10. │                                         │
  11. └────────────────────────────────────────────────────────────────────────────┘
  12.  
  13. I. Introduction.
  14.  
  15. WWCFL was created to fill a void.  I like to create a master files list during
  16. my external event for users to download and search offline.  With conferencing
  17. features in WWIV v4.23, it was necessary to separate my lists based upon both
  18. the conference and the DSL, so WWCFL was created!
  19.  
  20. WWCFL has the following features:
  21.  
  22.     - Self-installing!
  23.     - Create multiple lists based on conference or DSL (or both)
  24.     - Include from 0 to 10 lines of extended description
  25.     - Include sysop-configurable headers and network information
  26.     - Compress lists using your preferred archive method
  27.     - Automatically place lists in any defined download directory
  28.     - Use list as FILES.BBS for //UPLOADFILE function
  29.  
  30. WWCFL gives you a neat status screen to watch (should you be around and bored
  31. during your external event), but not at the expense of speed.  WWCFL is fast!
  32. On my Pentium-75, it took less than a minute to create, compress and upload a
  33. list containing more than 27,000 files!  (Your results may vary!)
  34.  
  35. II. Installation.
  36.  
  37. I wrote WWCFL to be as easy as possible to install and maintain.  Simply copy
  38. WWCFL.EXE to your main WWIV directory and type "WWCFL" from the prompt!  Do
  39. this for each list you want to create.    WWCFL will ask you a few questions to
  40. configure defaults for each list.
  41.  
  42. You can create as many lists as you like.  Type "WWCFL <number>" at the prompt,
  43. where 'number' is the number of the listing to create.  Then, in your external
  44. event, put 'WWCFL 1', 'WWCFL 2' and whatever other lists you defined.
  45.  
  46. Here's an explanation of the values created in WWIV.INI.  These values can be
  47. edited (like everything else in WWIV.INI) using any ASCII editor.
  48.  
  49.     REGNO
  50.  
  51.     The registration number you received when you registered WWCFL.
  52.     Hit <Enter> if you are unregistered.  There are no crippled
  53.     features in the unregistered version, but please do considering
  54.     registering to encourage WWCFL's future development!
  55.  
  56.     FILENAME
  57.  
  58.     Filename for the ASCII listing, such as MASTER or SYSOP.  WWCFL
  59.     will add the extension .BBS automatically to this name.  Hitting
  60.     <Enter> will use the name ALLFILES.
  61.  
  62.     ARCNAME
  63.  
  64.     Filename for the compressed listing, such as MASTER, GENERAL, etc.
  65.     The first archiver you have defined in INIT is used to compress
  66.     the list.  Again, the default name is ALLFILES.
  67.  
  68.     UPLDDIR
  69.  
  70.     Directory where you want to upload the compressed listing.
  71.     Hitting <Enter> shows you a list of directories.  WWCFL uses the
  72.     *.DIR filename, so this remains correct even if you later add or
  73.     remove directories from the BBS.
  74.  
  75.     EXTENDED
  76.  
  77.     Number of lines (0 to 10) of extended descriptions to include with
  78.     each file.    WWCFL only reads the number of lines you specify, so
  79.     a lower number means faster list creation.    The default is to use
  80.     no extended descriptions.
  81.  
  82.     TOPTEN
  83.  
  84.     WWCFL allows you to create a special area in each listing showing
  85.     the top ten downloaded files within that list.  This is a feature
  86.     unique to WWCFL, and it adds a nice flavor to your file list!  The
  87.     default is not to create a top ten list.
  88.  
  89.     INCLUDESYS
  90.  
  91.     Some sysops make directory #0 public and may wish to include it in
  92.     their listing.  The default is not to include the sysop directory.
  93.  
  94.     DOSDATE
  95.  
  96.     WWCFL gives you the option of reading the actual file date from
  97.     (from DOS) in place of the date uploaded for the listing.  Reading
  98.     from DOS will GREATLY increase the time to create a list.  WWCFL
  99.     won't even attempt this on CDROM directories!  The default is to
  100.     use the upload date.
  101.  
  102.     DSL
  103.  
  104.     You can specify the maximum directory DSL to include in a listing.
  105.     If you have non-public areas, you would want to make this less
  106.     than the DSL for those areas!  The default is to use DSL 255.
  107.  
  108.     CONFS
  109.  
  110.     WWCFL's greatest strength is its ability to create listings based
  111.     upon the conferences.  Here you can select which conferences to
  112.     include in this listing.  An asterisk (*) tells WWCFL to include
  113.     all conferences.  You may also "stack" conferences into one list,
  114.     e.g. "PGW" to include your <P>rogramming, <G>eneral and <W>indows
  115.     conferences, in that order.
  116.  
  117.     NETINFO
  118.  
  119.     This is a free-form line of text to include in the list header. If
  120.     left blank, nothing will be added.    You might include your modem
  121.     speed, network addresses, etc.
  122.  
  123.     HEADER
  124.  
  125.     This is the primary text in the file list header.  If blank, WWCFL
  126.     uses "Master File List from <your system name>."  You might wish
  127.     to customize this for different file listings, however.
  128.  
  129. III. Usage.
  130.  
  131. WWCFL can be run manually or during your nightly external event.  If you create
  132. multiple lists, run WWCFL for each one, e.g. "WWCFL 1", "WWCFL 2", etc.  WWCFL
  133. accepts no commandline option except the list number.
  134.  
  135. IV. Registration.
  136.  
  137. WWCFL is the product of many hours of hard work (and learning!)  Although it
  138. is uncrippled in unregistered form, I do ask that you considering donating to
  139. encourage its future development.
  140.  
  141. Registration is only $10.00!
  142.  
  143. Fill out the enclose ORDER.FRM or send your registration to:
  144.  
  145.     Frank Reid
  146.     9350 Harvest Way
  147.     Laurel, MD 20723
  148.  
  149. Remember to include the BBS telephone number in your registration!
  150.  
  151. V. Disclaimer.
  152.  
  153. The author makes no warranties, expressed or implied, as to the quality or
  154. performance of this program.  Your use of this program constitutes your
  155. release of the author from liability or litigation for any indirect or
  156. consequential damages arising from the use of this program or its associated
  157. files.
  158.  
  159. In no event will the author be liable to you for any damages, including any
  160. lost profits, lost savings or other incidental or consequential damages
  161. arising out of your use or inability to use the program, or for any claim by
  162. any other party.
  163.  
  164. VI. About Cerebrum
  165.  
  166. Cerebrum is a group of loosely-affiliated but highly-talented programmers who
  167. are working to improve the quality of modifications and utilities available to
  168. WWIV sysops.  Look for the many other Cerebrum products on a WWIV support BBS
  169. near you, and contribute to the future of WWIV by registering Cerebrum products
  170. you use!  If you are interested in hosting Cerebrum products on your own BBS as
  171. a Cerebrum Support Site, contact Dawg @2121.WWIVNET for an application.
  172.  
  173. VII. History.
  174.  
  175. Version 1.00 (02/11/94)
  176.   - Initial release
  177.  
  178. Version 1.01 (02/27/94)
  179.  
  180.   - Made -T (Top Ten Download List) the default, -T now toggles this off.
  181.   - Added -D option to use actual file date (vice upload date) for non CDROM.
  182.   - Cosmetic changes to the header box for each directory.
  183.  
  184. Version 2.00 (06/16/95)
  185.  
  186.   - Complete rewrite of screen routines.
  187.   - Now allows stacked conferencing.
  188.  
  189. Version 2.20 (07/14/95)
  190.  
  191.   - Fixed a quirk in the directory message box which could occasionally
  192.     show garbage instead of a directory name (though not affect operation).
  193.  
  194.   - Truly sped up the extended description routines.  For comparison, here's
  195.     what I found on my tests about 10,000 files in 36 directories:
  196.  
  197.                    Pentium-75       386/20
  198.     No extended descriptions   30 secs           2 mins, 40 secs
  199.     1 line of ext desc           2 mins, 30s       6 mins, 20 secs
  200.     5 lines of ext desc        3 mins           10 mins
  201.  
  202.     Insignificant on a Pentium, but a big difference on the 386!
  203.  
  204.   - Counts directory/file totals to provide a more accurate estimate of
  205.     overall time (and an accurate scroll bar).    As a result, you no longer
  206.     save time by excluding the top ten listing (so use it! :-)
  207.  
  208.   - Switched to a more conservative color set -- no more hot pink! :-)
  209.  
  210.   - Now strips WWIV color codes from the extended descriptions, instead of
  211.     just the main description.
  212.  
  213.   - Added an elapsed time routine which displays upon completion.
  214.  
  215.   - Fixed initialization of a variable which would cause the scroll bar
  216.     to scroll beyond the box.
  217.  
  218.   - Fixed a quirk which would cause "0 Directories" to show as a total.
  219.  
  220.   - Now strips WWIV colors from the Top Ten listing descriptions.
  221.  
  222.   - Changed date format from mm/dd/yy to mm-dd-yy for complete FILES.BBS
  223.     compatibility with other BBS types.
  224.  
  225.   - Fixed an quirk which put garbage (sometimes a previous filename) in the
  226.     extended description fields.
  227.  
  228.   - Smarter error-checking which should fix problems caused by directories
  229.     that don't have a corresponding *.DIR file.
  230.  
  231.   - Lot of variable declarations changed to unsigned to prevent negative
  232.     totals.
  233.  
  234. Thanks to all the Sysops who've made releasing modifications and utilities fun!
  235. Send comments, criticisms, suggestions and bug reports to:
  236.  
  237.     WWIVnet  : 1@8213
  238.     IceNET   : 1@3104
  239.     TerraNet : 1@3104
  240.     WWIVLink : 1@13104
  241.     FILEnet  : 1@1160
  242.     Fidonet  : 1:109/568
  243.  
  244. As always, look for the latest version on:
  245.  
  246.                   Eagle's Dare
  247.                  (301) 498-1984
  248.                  28.8k/24 Hours
  249.