home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd2.bin / bbs / readme < prev    next >
Text File  |  1994-11-28  |  9KB  |  214 lines
  1.  
  2.                   BBS/FTP README
  3.  
  4.                  (Updated 9/9/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 the "files.bbs" files.
  21.  
  22.    o    What are all these *.pi (product info) files and why they are
  23.     important.
  24.  
  25. Previous CD-ROM releases included support for a fairly complicated but very
  26. powerful method of using symbolic links to organize access to the archives.
  27. However, I received much negative feedback about this method, and so have
  28. decided to go to a simple directory structure for now, until the symbolic
  29. link method is made easier to use, and more BBS programs support symbolic
  30. links.
  31.  
  32. Now instead of a multiple level directory structure, there are just a
  33. handful of directories with files in each subdirectory and default
  34. "files.bbs" files in each.  In addition, the name of the archive now
  35. contains the version number of the contents.
  36.  
  37. ------------
  38. LHA ARCHIVES
  39. ------------
  40.  
  41. Almost all the archives on this CD-ROM are in "lha format".  The shareware
  42. version of lha is included in the Useful/Sys/C directory of this CD-ROM, so
  43. all you have to do to unpack any archive is use a command of the form:
  44.  
  45.     lha -mraxe x archive.lha
  46.  
  47. Please consider registering with the lha author, Stefan Boberg, for the
  48. latest version of lha, so he can continue to support this fine program.
  49.  
  50. ------------------
  51. PRODUCT INFO FILES
  52. ------------------
  53.  
  54. If you have already peeked in some of the directories of this CD-ROM, you
  55. probably noticed that for every archive there is a corresponding file of the
  56. same name with ".pi" appended to the name.  These are "product info" files,
  57. and contain important information about the contents of the archive that
  58. they correspond to.  The current specification for the structure and
  59. contents of these files can be found in the "Product-Infos" file in the
  60. "Information" directory on this CD-ROM, and should continue to be posted
  61. periodically in the usenet news group "comp.sys.amiga.announce" as it
  62. evolves.
  63.  
  64. The product info files are a way to organize lots of information about a
  65. program in an extensible text format that is relatively simple for programs
  66. to parse.  It looks something like:
  67.  
  68.     .name
  69.     myprog
  70.     .fullname
  71.     My smart little program
  72.     .version
  73.     1.4
  74.     .short
  75.     Computes winning horse, 100% accurate.
  76.     .author
  77.     Me
  78.     .address
  79.     123 Somestreet
  80.     Anywhere, USA
  81.  
  82. Aside from the information about where to find an archive (implied by the
  83. location of the corresponding product info file), two other very important
  84. pieces of information that are included in these product info files are the
  85. version number (if known) and a 40 character or less short description of
  86. what is contained in each archive.
  87.  
  88. When used in a BBS or FTP environment the pieces of information that are
  89. usually desirable to have include:
  90.  
  91.    o    Name of the archive.
  92.    o    Location of the archive (where BBS software can find archive)
  93.    o    Version number of the material in the archive.
  94.    o    Size of the archive.
  95.    o    Date of release of the material in the archive.
  96.  
  97. A common way of making this information available to the BBS sysop, and
  98. ultimately the BBS software, is to build a "files.bbs" file in each
  99. directory where the files are found, or possibly in a separate directory,
  100. depending upon the BBS software.  These files are typically fixed field
  101. width files with one line per archive, and look something like:
  102.  
  103.    foo1.4.lha        103200 04-Jan-94 Do the dishes, watch TV
  104.    bar34.lha         33567 11-Mar-94 Take out the trash, eat dinner
  105.  
  106. One major problem is that no two BBS systems seem to agree on the exact
  107. format of this file, and from what information I've been able to obtain,
  108. generally have rigid requirements for exactly where each field must be, how
  109. big it must be, and what it's format must be.
  110.  
  111. Rather than attempt to include direct support for many different BBS
  112. systems, in a variety of different formats, I've elected to provide a set
  113. of default "files.bbs" files, and some simple tools that BBS operators can
  114. use to build their own information files in whatever format the BBS
  115. requires if these files.bbs files are not adequate.  This is where the
  116. product info files come in.
  117.  
  118. The directory "Tools/PItools" contains several small tools for manipulating
  119. product info files.  The most important of these is "pitool", which can walk
  120. the entire directory tree of the CD-ROM and perform a number of different
  121. operations on the product info files that it finds.  One thing it can do is
  122. to print a one line entry to it's standard output stream for each product
  123. info file that it processes, and format this field according to a specifier
  124. string that looks a lot like a typical C "printf" style string.
  125.  
  126. The following example prints the file's "basename" in a left justified 24
  127. character wide field, followed by a space, followed by the contents of the
  128. ".short" field in a left justified 40 character wide field, and finally, a
  129. newline character:
  130.  
  131.     pitool -b -F "%-24B %-40S\n" -f - /FrozenFish-Apr94/BBS/ALib/d9xx/d950
  132.  
  133.     BBDoors.lha              rexxDoors for BBBBS, V6.5               
  134.     BusyPointers.lha         'NickPrefs' busy pointers collection.   
  135.     ClockTool.lha            Manipulate battery and/or system clocks 
  136.     Enforcer.lha             Tool to monitor illegal memory access.  
  137.     PayAdvice.lha            Pay analysis program.                   
  138.     Sushi.lha                Intercept Enforcer raw serial output.   
  139.     bbsQUICK.lha             bbsQUICK offline module for BBBBS, V6.4 
  140.     Disk950.lha              Library admin files for disk 950.       
  141.  
  142. This example prints the file "basename" in a right justified 24 character
  143. wide field, followed by a space, followed by the complete pathname to that
  144. file in a field of unlimited length, and then a newline character:
  145.  
  146.     pitool -b -F "%24B %P\n" -f - /cdrom/BBS/ALib/d9xx/d950
  147.  
  148.                  BBDoors.lha cdrom:BBS/ALib/d9xx/d950/BBDoors.lha
  149.             BusyPointers.lha cdrom:BBS/ALib/d9xx/d950/BusyPointers.lha
  150.                ClockTool.lha cdrom:BBS/ALib/d9xx/d950/ClockTool.lha
  151.                 Enforcer.lha cdrom:BBS/ALib/d9xx/d950/Enforcer.lha
  152.                PayAdvice.lha cdrom:BBS/ALib/d9xx/d950/PayAdvice.lha
  153.                    Sushi.lha cdrom:BBS/ALib/d9xx/d950/Sushi.lha
  154.                 bbsQUICK.lha cdrom:BBS/ALib/d9xx/d950/bbsQUICK.lha
  155.                  Disk950.lha cdrom:BBS/ALib/d9xx/d950/Disk950.lha
  156.  
  157. This example prints the file "basename" in a left justfied 20 character
  158. wide field, followed by a space, the version number in a right justified 6
  159. character wide field, followed by another space, the size of the archive in
  160. Kb in a 3 character wide right justified field, followed immediately by the
  161. literal string "Kb => ", followed by the directory in which the file is
  162. stored in a field of unlimited length, followed by a newline:
  163.  
  164.     pitool -b -F "%-20B %6V %3KKb => %D\n" -f - /cdrom/BBS/ALib/d9xx/d950
  165.  
  166.     BBDoors.lha             6.5 187Kb => cdrom:BBS/ALib/d9xx/d950/
  167.     BusyPointers.lha        ?.?  11Kb => cdrom:BBS/ALib/d9xx/d950/
  168.     ClockTool.lha           1.0  26Kb => cdrom:BBS/ALib/d9xx/d950/
  169.     Enforcer.lha          37.55  66Kb => cdrom:BBS/ALib/d9xx/d950/
  170.     PayAdvice.lha          3.00  52Kb => cdrom:BBS/ALib/d9xx/d950/
  171.     Sushi.lha             37.10  14Kb => cdrom:BBS/ALib/d9xx/d950/
  172.     bbsQUICK.lha            6.4  26Kb => cdrom:BBS/ALib/d9xx/d950/
  173.     Disk950.lha             ?.?  23Kb => cdrom:BBS/ALib/d9xx/d950/
  174.  
  175. The source to this utility is provided in case any further customizations
  176. are needed, however it is currently only compiled and tested with the GNU
  177. compiler.  The GNU compiler is included in ready to run form under the GNU
  178. directory, and in archived form under the BBS/GNU directory.
  179.  
  180. ----------------------------
  181. GZIP COMPRESSED TAR ARCHIVES
  182. ----------------------------
  183.  
  184. A few archives here are in what is known as "compressed tar archive" format.
  185. These are archives that are made with "tar" and then compressed with the
  186. "gzip" compressor.  Generally they are the original unchanged archives for
  187. GNU distributions, exactly as released by the Free Software Foundation.  To
  188. unpack them, you can do:
  189.  
  190.     gzip -d foo.tar.gz
  191.     tar -xvf foo.tar
  192.  
  193. or if you have a shell that supports pipes, you can avoid making the
  194. uncompressed tar archive (which might be quite large), and simply do:
  195.  
  196.     gzip -d <foo.tar.gz | tar -xvf -
  197.  
  198. Both gzip and tar are included in the "GNU/bin" directory on this CD-ROM.
  199.  
  200. --------------
  201. IXEMUL.LIBRARY
  202. --------------
  203.  
  204. All of the utilities described here are compiled with GNU gcc, and require
  205. the ixemul.library to be found in the LIBS: directory.  If you run the
  206. suggested startup scripts "Useful-Startup" and "GNU-Startup", the utilities
  207. and libraries will be added to your C: and LIBS: assigns for you, so you
  208. don't have to actually copy anything off the CD-ROM to run the tools.
  209.  
  210. Be sure to set your stack size to a fairly large value, say 50,000 or more,
  211. before running any of the tools.
  212.  
  213. -Fred ><>
  214.