home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / com / bbs / algen / algen.doc < prev    next >
Encoding:
Text File  |  1992-08-30  |  3.7 KB  |  88 lines
  1.                      ALGEN v1.00 - The Avail List GENerator
  2.                       by Richard Butler - EUROPA Software
  3.                                 Public Domain
  4.  
  5. ALGEN is an Avail List or Allfiles generator for file.bbs systems. ALGEN is
  6. an OS/2 application and will not run under DOS. The source code is provided
  7. so that it can be compiled to run under any OS. ALGEN has only been tested
  8. under OS/2 2.0. ALGEN was compiled using C SET/2.
  9.  
  10. ALGEN CARRIES NO WARRANTIES WHETHER EXPRESSED OR IMPLIED, INCLUDING WITHOUT
  11. LIMITATION, WARRANTIES OF FITNESS AND MERCHANTABILITY WITH RESPECT TO THE
  12. INFORMATION IN THIS DOCUMENT AND INCLUDED SOFTWARE.
  13.  
  14. This software is released to the Public Domain.
  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 created to be an OS/2 clone of Harvey Parisien's HLIST. All credit
  20. for the format of the config file and the output file list go to Harvey. If
  21. you need a DOS based file list generator I would highly recommend HLIST.
  22.  
  23. The format of the config file is as follows:
  24.  
  25. Line 1: Your system name (max 39 characters long)
  26. Line 2: drive:\path\filename.ext of your header file
  27. Line 3: days old to qualify as NEW files (1 TO 99)
  28. Line 4: drive:\path\filename.ext of your output file for your FILE LIST
  29. Line 5: drive:\path\filename.ext of your output file for your NEW FILE LIST
  30. Line 6: STRIPFLAGS or NOSTRIPFLAGS keyword - STRIPFLAGS tells ALGEN not
  31.         to display flags found at the beginning of a file description
  32. Line 7  and so on, contains 1 line per area you have a files.bbs file on and
  33.         want ALGEN to process.  The data is in this format...
  34.  
  35.          drive:\path\ YOUR TITLE TEXT
  36.  
  37.        If you want to use a different file list other than the normal
  38.         files.bbs (ie for cd rom use), just put the complete path and
  39.          filename after your title but separate it with a carat like this...
  40.  
  41.          drive:\path\ YOUR TITLE TEXT^drive:\path\files_bbs_name.ext
  42.  
  43.  (Lines in your config file prefaced by a ; are for comments only)
  44.  
  45. The header file is included at the top of your output FILE LIST. Algen expects
  46. to find a header file. If you do not use one ALGEN will report an error, but
  47. will continue.
  48.  
  49. STRIPFLAGS keyword: The default is NOSTRIPFLAGS. The STRIPFLAGS keyword will
  50. cause ALGEN to not include things like Maximus's /tb in your file list.
  51. It functions the same way that Maximus does, ie. if the first character is
  52. a /, the / and everthing following it, up to and including the first space,
  53. is not displayed in the output.
  54.  
  55. ALGEN treats any line that begins with a - or a space as a comment and copies
  56. it exactly as it appears to the output file list. No word wrapping is done on
  57. comment lines.
  58.  
  59. ALGEN will preserve the case of filenames. ALGEN does not support long file
  60. names at this time since most files.bbs systems do not support long file names.
  61.  
  62. You can tell ALGEN to use an alternate config file by including it on the
  63. command line:
  64.  
  65. ALGEN Other.Cfg
  66.  
  67. All lines in the config file except the system name must begin in column 1.
  68. This includes any comment lines.
  69.  
  70. Future Enhancements:
  71. - Support for Maximus's AREA.DAT
  72. - Use of OS/2 API calls.
  73. - ability to sort your FILES.BBS
  74. - ability to do file maintenance like deleting old NODEDIFFs
  75. - whatever else I or anyone else comes up with
  76.  
  77. Thanks go to:
  78. - Harvey Parisien for his HLIST program upon which ALGEN is based.
  79. - Erik Vanriper for releasing the source for his FILELIST program which
  80.   served as a reference while writing ALGEN.
  81. - Jim Sterrett for helping me beta test ALGEN.
  82.  
  83. Please direct any bug reports, suggestions, or comments to:
  84.  
  85. Richard Butler
  86. BBS: (504) 652-4916 v32b
  87. Fidonet 1:396/61
  88.