home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 4 / FreshFish_May-June1994.bin / bbs / readme < prev    next >
Text File  |  1994-05-14  |  22KB  |  468 lines
  1.  
  2.                   BBS/FTP README
  3.  
  4.                  (Updated 5/14/94)
  5.  
  6. --------
  7. OVERVIEW
  8. --------
  9.  
  10. This is the root of a directory tree containing lha archives of material
  11. included elsewhere on this CD-ROM, or from previous CD-ROM's.
  12.  
  13. See the other informational files on this CD-ROM for details about what is
  14. contained in these archives.  This file deals purely with details about how
  15. this CD-ROM might be used in a BBS or FTP environment.  Some of the details
  16. discussed here include:
  17.  
  18.    o    How do I unpack all these *.lha archives.
  19.  
  20.    o    What are all these *.pi (product info) files and why they are
  21.     important.
  22.  
  23.    o    How you can arrange to access the contents of the CD-ROM from
  24.     several different "views" using symbolic links, and what support
  25.     is provided to make this relatively easy to set up.
  26.  
  27.    o    The default alternative "view".
  28.  
  29. ------------
  30. LHA ARCHIVES
  31. ------------
  32.  
  33. Almost all the archives on this CD-ROM are in "lha format".  The shareware
  34. version of lha is included in the Useful/Sys/C directory of this CD-ROM, so
  35. all you have to do to unpack any archive is use a command of the form:
  36.  
  37.     lha -mraxe x archive.lha
  38.  
  39. Please consider registering with the lha author, Stefan Boberg, for the
  40. latest version of lha, so he can continue to support this fine program.
  41.  
  42. ------------------
  43. PRODUCT INFO FILES
  44. ------------------
  45.  
  46. If you have already peeked in some of the directories of this CD-ROM, you
  47. probably noticed that for every archive there is a corresponding file of the
  48. same name with ".pi" appended to the name.  These are "product info" files,
  49. and contain important information about the contents of the archive that
  50. they correspond to.  The current specification for the structure and
  51. contents of these files can be found in the "Product-Infos" file in the
  52. "Information" directory on this CD-ROM, and should continue to be posted
  53. periodically in the usenet news group "comp.sys.amiga.announce" as it
  54. evolves.
  55.  
  56. The product info files are a way to organize lots of information about a
  57. program in an extensible text format that is relatively simple for programs
  58. to parse.  It looks something like:
  59.  
  60.     .name
  61.     myprog
  62.     .fullname
  63.     My smart little program
  64.     .version
  65.     1.4
  66.     .short
  67.     Computes winning horse, 100% accurate.
  68.     .author
  69.     Me
  70.     .address
  71.     123 Somestreet
  72.     Anywhere, USA
  73.  
  74. Aside from the information about where to find an archive (implied by the
  75. location of the corresponding product info file), two other very important
  76. pieces of information that are included in these product info files are the
  77. version number (if known) and a 40 character or less short description of
  78. what is contained in each archive.
  79.  
  80. When used in a BBS or FTP environment the pieces of information that are
  81. usually desirable to have include:
  82.  
  83.    o    Name of the archive.
  84.    o    Location of the archive (where BBS software can find archive)
  85.    o    Version number of the material in the archive.
  86.    o    Size of the archive.
  87.    o    Date of release of the material in the archive.
  88.  
  89. A common way of making this information available to the BBS sysop, and
  90. ultimately the BBS software, is to build a "files.bbs" file in each
  91. directory where the files are found, or possibly in a separate directory,
  92. depending upon the BBS software.  These files are typically fixed field
  93. width files with one line per archive, and look something like:
  94.  
  95.    foo1.4.lha        103200 04-Jan-94 Do the dishes, watch TV
  96.    bar34.lha         33567 11-Mar-94 Take out the trash, eat dinner
  97.  
  98. One major problem is that no two BBS systems seem to agree on the exact
  99. format of this file, and from what information I've been able to obtain,
  100. generally have rigid requirements for exactly where each field must be, how
  101. big it must be, and what it's format must be.
  102.  
  103. Rather than attempt to include direct support for one or more different BBS
  104. systems, in a variety of different formats, I've elected to provide some
  105. simple tools that BBS operators can use to build their own information files
  106. in whatever format the BBS requires.  This is where the product info files
  107. come in.
  108.  
  109. The directory "Tools/PItools" contains several small tools for manipulating
  110. product info files.  The most important of these is "pitool", which can walk
  111. the entire directory tree of the CD-ROM and perform a number of different
  112. operations on the product info files that it finds.  One thing it can do is
  113. to print a one line entry to it's standard output stream for each product
  114. info file that it processes, and format this field according to a specifier
  115. string that looks a lot like a typical C "printf" style string.
  116.  
  117. The following example prints the file's "basename" in a left justified 24
  118. character wide field, followed by a space, followed by the contents of the
  119. ".short" field in a left justified 40 character wide field, and finally, a
  120. newline character:
  121.  
  122.     pitool -b -F "%-24B %-40S\n" -f - /FrozenFish-Apr94/BBS/ALib/d9xx/d950
  123.  
  124.     BBDoors.lha              rexxDoors for BBBBS, V6.5               
  125.     BusyPointers.lha         'NickPrefs' busy pointers collection.   
  126.     ClockTool.lha            Manipulate battery and/or system clocks 
  127.     Enforcer.lha             Tool to monitor illegal memory access.  
  128.     PayAdvice.lha            Pay analysis program.                   
  129.     Sushi.lha                Intercept Enforcer raw serial output.   
  130.     bbsQUICK.lha             bbsQUICK offline module for BBBBS, V6.4 
  131.     Disk950.lha              Library admin files for disk 950.       
  132.  
  133. This example prints the file "basename" in a right justified 24 character
  134. wide field, followed by a space, followed by the complete pathname to that
  135. file in a field of unlimited length, and then a newline character:
  136.  
  137.     pitool -b -F "%24B %P\n" -f - /cdrom/BBS/ALib/d9xx/d950
  138.  
  139.                  BBDoors.lha cdrom:BBS/ALib/d9xx/d950/BBDoors.lha
  140.             BusyPointers.lha cdrom:BBS/ALib/d9xx/d950/BusyPointers.lha
  141.                ClockTool.lha cdrom:BBS/ALib/d9xx/d950/ClockTool.lha
  142.                 Enforcer.lha cdrom:BBS/ALib/d9xx/d950/Enforcer.lha
  143.                PayAdvice.lha cdrom:BBS/ALib/d9xx/d950/PayAdvice.lha
  144.                    Sushi.lha cdrom:BBS/ALib/d9xx/d950/Sushi.lha
  145.                 bbsQUICK.lha cdrom:BBS/ALib/d9xx/d950/bbsQUICK.lha
  146.                  Disk950.lha cdrom:BBS/ALib/d9xx/d950/Disk950.lha
  147.  
  148. This example prints the file "basename" in a left justfied 20 character
  149. wide field, followed by a space, the version number in a right justified 6
  150. character wide field, followed by another space, the size of the archive in
  151. Kb in a 3 character wide right justified field, followed immediately by the
  152. literal string "Kb => ", followed by the directory in which the file is
  153. stored in a field of unlimited length, followed by a newline:
  154.  
  155.     pitool -b -F "%-20B %6V %3KKb => %D\n" -f - /cdrom/BBS/ALib/d9xx/d950
  156.  
  157.     BBDoors.lha             6.5 187Kb => cdrom:BBS/ALib/d9xx/d950/
  158.     BusyPointers.lha        ?.?  11Kb => cdrom:BBS/ALib/d9xx/d950/
  159.     ClockTool.lha           1.0  26Kb => cdrom:BBS/ALib/d9xx/d950/
  160.     Enforcer.lha          37.55  66Kb => cdrom:BBS/ALib/d9xx/d950/
  161.     PayAdvice.lha          3.00  52Kb => cdrom:BBS/ALib/d9xx/d950/
  162.     Sushi.lha             37.10  14Kb => cdrom:BBS/ALib/d9xx/d950/
  163.     bbsQUICK.lha            6.4  26Kb => cdrom:BBS/ALib/d9xx/d950/
  164.     Disk950.lha             ?.?  23Kb => cdrom:BBS/ALib/d9xx/d950/
  165.  
  166. The source to this utility is provided in case any further customizations
  167. are needed, however it is currently only compiled and tested with the GNU
  168. compiler.  The GNU compiler is included in ready to run form under the GNU
  169. directory, and in archived form under the BBS/GNU directory.
  170.  
  171. --------------------
  172. USING SYMBOLIC LINKS
  173. --------------------
  174.  
  175. I have included some tools and scripts that will allow the contents of the
  176. CD-ROM to be presented with any arbitrary organization, by using the
  177. "symbolic link" feature built into Kickstart 2.04 or later.  The same
  178. techniques will also work for people that want to access this CD-ROM on Unix
  179. systems that support symbolic links.
  180.  
  181.                  == DISCLAIMER ==
  182.  
  183.     Symbolic links are a new feature in AmigaDOS, and have probably
  184.     not had a lot of testing, as is evident from the fact that most of
  185.     the currently available standard Commodore utilities don't fully
  186.     support them.  If you munge your