home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / algen121.lzh / ALGEN.DOC < prev    next >
Text File  |  1993-09-25  |  8KB  |  172 lines
  1.                ALGEN v1.21 - the Avail List / ALlfiles GENerator
  2.                       Copyright 1992-93 by Richard Butler
  3.  
  4. ALGEN is an Avail List / Allfiles generator for FILES.BBS systems. ALGEN is an
  5. OS/2 2.x application and will not run under DOS. The source code and make file
  6. are available as ALSRC121.LZH. ALGEN was compiled using IBM C SET++ in C mode.
  7.  
  8. ALGEN CARRIES NO WARRANTIES WHETHER EXPRESSED OR IMPLIED, INCLUDING WITHOUT
  9. LIMITATION, WARRANTIES OF FITNESS AND MERCHANTABILITY WITH RESPECT TO THE
  10. INFORMATION IN THIS DOCUMENT AND INCLUDED SOFTWARE.
  11.  
  12. In other words, it's not guaranteed to do anything :-)
  13.  
  14. ALGEN is FreeWare and requires no registration fee.
  15.  
  16. If you use ALGEN please send me netmail at 1:396/61 and let me know. The more
  17. netmail I get the more work I'll do on ALGEN.
  18.  
  19. ALGEN was originally created to be an OS/2 clone of Harvey Parisien's HLIST.
  20. Any similarities between ALGEN and HLIST are completely intentional. There
  21. have been many changes due to user suggestions, but if anything in ALGEN even
  22. vaguely resembles something in HLIST then credit for it goes to Harvey. If you
  23. need a DOS based file list generator I would highly recommend HLIST.
  24.  
  25. -------------------------------------------------------------------------------
  26.  
  27. ALGEN configuration file:
  28. -------------------------
  29.  
  30. ALGEN now uses a keyword type configuration file. It was changed to make it
  31. easier to add new features and because I hate command line switches.
  32.  
  33.         KEYWORDS                DESCRIPTION
  34.         --------                -----------
  35.  
  36.         System                  Your system name
  37.  
  38.         NewDays                 Days old to qualify as NEW files. Default
  39.                                 is 14. ALGEN uses the Last Write Date for
  40.                                 all file dates.
  41.  
  42.         FileList                The path and name for the output FILE LIST
  43.                                 ie. C:\BBSUTIL\EUROPAFL.LST
  44.                                 (required)
  45.  
  46.         NewFileList             The path and name for the output NEW FILE
  47.                                 LIST. ie. C:\BBSUTIL\NEWFILES.LST
  48.                                 (optional)
  49.  
  50.         Header                  The path and name of your header file that
  51.                                 will appear at the top of your FILE LIST.
  52.                                 ie. C:\BBSUTIL\ALGEN.HDR
  53.                                 (optional)
  54.  
  55.         NewHeader               The path and name of your header file that
  56.                                 will appear at the top of your NEW FILE LIST.
  57.                                 ie. C:\BBSUTIL\NEW.HDR
  58.                                 (optional)
  59.  
  60.         StripFlags              This tells ALGEN not to include flags found
  61.                                 at the beginning of a file description in
  62.                                 the output lists. ie. Maximus's /tb flag.
  63.                                 It functions the same way that Maximus does,
  64.                                 if the first character is a /, the / and
  65.                                 everthing following it, up to and including
  66.                                 the first space, is not displayed in the
  67.                                 output.
  68.  
  69.         NoIBMchars              This tells ALGEN not to use IBM characters
  70.                                 for borders and area headers.
  71.  
  72.         AreaInclude             Begins with the keyword AREAINCLUDE and ends
  73.                                 with the keyword END. Contains 1 line per
  74.                                 area you have a files.bbs file on and want
  75.                                 ALGEN to process. The data is in this format...
  76.  
  77.                                 drive:\path\ YOUR TITLE TEXT
  78.  
  79.                                 If you want to use a different file list other
  80.                                 than the normal files.bbs (ie for cd rom use),
  81.                                 just put the complete path and filename after
  82.                                 your title but separate it with a carat like
  83.                                 this...
  84.  
  85.                     drive:\path\ YOUR TITLE TEXT^drive:\path\files_bbs_name.ext
  86.  
  87.         MaxAreas                This tells ALGEN to use your Maximus AREA.DAT
  88.                                 file. It should be followed by the path and
  89.                                 filename. ie MaxAreas C:\MAX\AREA.DAT
  90.  
  91.         AreaExclude             Begins with the keyword AREAEXCLUDE and ends
  92.                                 with the keyword END. Each line will contain
  93.                                 one area name (as defined in your Maximus
  94.                                 Filearea.Ctl) that you wish to exclude from
  95.                                 your file list.
  96.  
  97.         ShowMaxNames            This tells ALGEN to include Maximus's area
  98.                                 name in the file area descriptions.
  99.  
  100.         NoEmptyAreas            This tells ALGEN not to include empty file
  101.                                 areas in your FILE LIST and NEW FILE LIST.
  102.  
  103.         Indent                  Number of spaces to indent each description
  104.                                 line after the first one. This is useful if
  105.                                 you use d/l counters. Default is 0. Max is 16.
  106.  
  107.         ShowSummary             This tells ALGEN to include summary information
  108.                                 for your file areas at the end of your
  109.                                 FILE LIST and NEW FILE LIST.
  110.  
  111.         UseFIDX                 This tells ALGEN to use Maximus's FILES.IDX and
  112.                                 FILES.DAT to find file sizes and file dates.
  113.                                 This should speed things up for use with cd rom
  114.                                 since ALGEN wil not have to access the cd rom.
  115.  
  116.         IgnoreBadDates          This tells ALGEN to ignore file dates > todays
  117.                                 date when determining whether a file is new.
  118.  
  119.  
  120. Lines in your config file prefaced by a ; are considered comments.
  121.  
  122. You can tell ALGEN to use an alternate config file by including it on the
  123. command line like so:
  124.  
  125. ALGEN Other.Cfg
  126.  
  127. -------------------------------------------------------------------------------
  128.  
  129. ALGEN treats any line in your FILES.BBS that begins with a - or a space as a
  130. comment and copies it exactly as it appears to the output file list. No word
  131. wrapping is done on comment lines.
  132.  
  133. ALGEN will preserve the case of filenames. ALGEN does not support long file
  134. names at this time since most files.bbs systems do not support long file names.
  135.  
  136. ALGEN now supports paths in your FILES.BBS.
  137.  
  138. -------------------------------------------------------------------------------
  139.  
  140. Thanks go to:
  141. - Harvey Parisien for his HLIST program upon which ALGEN is based.
  142. - Erik Vanriper for releasing the source for his FILELIST program which
  143.   served as a reference while writing ALGEN.
  144. - Scott Dudley for his great work on Maximus and for making all the file
  145.   structures available.
  146. - Jim Sterrett, Bob Germer, Jim Allonby, Brian Hampson, and Brenda Moon for
  147.   helping me beta test ALGEN and for many excellent suggestions.
  148. - Everyone who has sent netmail with comments and suggestions.
  149.  
  150. Please direct any bug reports, suggestions, or comments to:
  151.  
  152. Richard Butler
  153. BBS: (504) 652-4916 v32b
  154. Fidonet 1:396/61
  155. ibmNET 40:4372/61
  156. OS2Net 81:10/20
  157.  
  158. ALGEN is free for anyone to use, but if you really feel the need to pay for
  159. it, I will gladly accept donations to be applied to my college tuition and
  160. book fees. Any donations may be mailed to:
  161.  
  162.                 Richard Butler
  163.                 1708 Ridgefield Dr.
  164.                 LaPlace, La 70068
  165.  
  166. -------------------------------------------------------------------------------
  167. Maximus CBCS is copyright 1989 - 1991 by Scott J. Dudley
  168. HLIST is copyright 1991 by Harvey Parisien
  169. FILELIST is copyright 1991 by Erik Vanriper
  170. OS/2 and C SET++ are copyright 1992 - 1993 by IBM Corp.
  171. -------------------------------------------------------------------------------
  172.