home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / cpm / cug / softt-1.lbr / CONTENTS.DQC / CONTENTS.DOC
Text File  |  1984-07-05  |  8KB  |  244 lines
  1. .comment table of contents for Software Tools Disks
  2. .comment source:  contents.doc
  3. .comment version: December 4, 1981
  4. .bp 1
  5. .he 'contents.doc''December 4, 1981'
  6. .fo ''-#-''
  7.  
  8. .ul
  9. What are the Software Tools?
  10.  
  11. The programs on these disks are descendents of the RATFOR
  12. programs from the book,
  13. .ul
  14. Software Tools,
  15. by Brian Kernighan and P. J. Plauger, published by
  16. Addison-Wesley in 1976.
  17.  
  18. The publisher also made these programs available on
  19. computer tape.
  20. A group known as the Software Tools Users Group
  21. was formed to distribute, update and maintain the tools.
  22. The latest tape from the Software Tools Users Group
  23. is called the "Basic Tape" and it is from that tape
  24. that most of the files on these disks were taken.
  25.  
  26. All of the programs on these disks are in the public
  27. domain.
  28. None of them are copyrighted.
  29.  
  30. The basic tape contains 16 files which are fully described
  31. by the cookbook on the file named COOKBOOK on this disk.
  32. Read the cookbook after reading this file
  33. to get an overall picture of what
  34. is on these disks and what you may still need to do to.
  35.  
  36. The original 16 files have been split into pieces which
  37. correspond to individual programs or, in the case of the
  38. spelling dictionary, to individual letters.
  39. This makes getting at the program you want
  40. .ul
  41. much
  42. easier.
  43.  
  44. A major constraint in putting the programs on disks was
  45. a lack of CP/M directory space.
  46. Do not assume that just because STAT tells you that space
  47. is available on a disk that you can PIP many
  48. programs to the disk.
  49.  
  50. .ne 4
  51. .ul
  52. Bringing up the tools
  53.  
  54. Please be aware that none of the RATFOR programs on these
  55. disks will work as is.
  56. You have essentially three choices:
  57.  
  58. Path 1:  You can use the tools in RATFOR without making any
  59. changes to them.
  60. This means that you will have to get a working FORTRAN
  61. compiler and adapt the primitives to fit your operating
  62. system.
  63. Boot the RATFOR preprocessor using RATFOR.FTN,
  64. then compile all the RATFOR programs.
  65. This is the "normal" way of making the tools work.
  66. If you choose this way then the primitives in BDS C
  67. will not do you much good except as a guide.
  68.  
  69. Path 2:  You can use the primitives in BDS C without making
  70. any (or any extensive) changes to them.
  71. You will have to transliterate all the tools from RATFOR
  72. to BDS C.
  73. This is no small job.
  74.  
  75. Path 3:  You can change the primitives in BDS C to make them
  76. look like the Unix I/O primitives
  77. (which are quite similar to the BDS C I/O routines.)
  78. Once again you will have to transliterate all the tools
  79. from RATFOR to C.
  80. The primitives in BDS C may form a good starting point
  81. for your efforts.
  82.  
  83. If I were writing the primitives all over again I would
  84. choose path 3 instead of path 2.
  85. The problem with the approach I took is that the primitives
  86. are neither fish nor fowl:
  87. they are compatible neither with the RATFOR primitives
  88. (because it doesn't make sense to burden C programs
  89. with RATFOR calling conventions)
  90. nor with the Unix I/O primitives.
  91.  
  92. Still, the BDS C primitives should make a good starting
  93. point if you want to follow path 3.
  94. The primitives show how easy it really is to do
  95. full I/O redirection.
  96. Also, there are many RATFOR primitives which, to my knowledge,
  97. do not correspond to any of the Unix primitives.
  98. An example are the symbol table primitives.
  99. For these primitives, one is essentially free to choose
  100. whatever form is most elegant and useful.
  101.  
  102. Be sure to read all the .DOC files on
  103. on the disk labeled
  104. "Tools and primitives in BDS C."
  105. These files discuss topics of interest to implementors.
  106.  
  107. Please send any comments, criticisms or improvements
  108. concerning the BDS C primitives to their author (me):
  109.  
  110.     Edward K. Ream
  111.     1850 Summit Avenue
  112.     Madison, WI. 53705
  113.     (608) 231 - 2952
  114.  
  115. .ne 4
  116. .ul
  117. Table of Contents
  118.  
  119. Here is what is on each disk:
  120.  
  121. .ne 4
  122. .ul
  123. Disk 1:  Cookbook, table of contents, .FTN files.
  124.  
  125. You should have read the READ.ME file by now.
  126.  
  127. You are now reading the table of contents.
  128.  
  129. The cookbook is the primary documentation for people
  130. who want to bring up the tools.
  131. It tells in detail what you must do get the tools running
  132. on your system.
  133. The cookbook makes up all of file 1 of the Basic Tape.
  134.  
  135. The .FTN files on this disk are the result of passing
  136. RATFOR programs through the RATFOR preprocessor.
  137. Use the file RATFOR.FTN to boot up the RATFOR preprocessor.
  138. You will need these files if (and only if) you plan
  139. to bring up the tools in RATFOR rather than transliterating
  140. them to C.
  141. The .FTN files make up all of files 2 and 3 on the Basic Tape.
  142.  
  143. .ne 4
  144. .ul
  145. Disk 2:  Tools and primitives in BDS C.
  146.  
  147. Everything on this disk was written by Edward K. Ream.
  148. Do not blame the Software Tools Users Group.
  149. They had nothing to do with it.
  150.  
  151. The BDS C disk contains the software tools primitives
  152. written in BDS C.
  153. It also contains a transliteration of the text formatter
  154. ROFF from RATFOR to BDS C.
  155. Use ROFF to format all .DOC files on these disks.
  156.  
  157. See all the .DOC files on the BDS C disk for much handy
  158. information concerning the primitives.
  159.  
  160. .ne 4
  161. .ul
  162. Disks 3, 4:  Primitives.
  163.  
  164. These two disks contain the RATFOR primitives from file 4
  165. of the Basic Tape. 
  166.  
  167. The documentation for each primitive is now on a separate
  168. file.
  169. An easy way to print them all is to
  170. create a .SO file for ROFF using the files SINGLE1.SUB
  171. and SINGLE2.SUB as patterns.
  172. (The .SUB files were used to copy these disks.)
  173.  
  174. Because of a lack of directory space, it was not possible
  175. to put the RATFOR code for each primitive on a separate file.
  176. Instead, the code is grouped alphabetically.
  177. The code for the primitives are on files PRIM-A through
  178. PRIM-W.
  179.  
  180. The file LIBDEF contains definitions used by all the
  181. RATFOR primitives and tools.
  182.  
  183. The primer for RATFOR and the primer for the editors
  184. appear on .PRM files on this disk.
  185. The primers are from file 14 of the Basic Tape.
  186.  
  187. .ne 4
  188. .ul
  189. Disks 5, 6, 7, 8:  Tools
  190.  
  191. These disks contain the entire contents of files
  192. 5, 6, 7, 8, 9, 10, 11, 12, 13 and 14 from the Basic Tape.
  193.  
  194. The documentation for each tool is on a separate .DOC
  195. file.
  196. Once again, you can use the files SINGLE?.DOC as a help
  197. in creating .SO files for ROFF.
  198.  
  199. The code for each tool is on a separate .RAT file.
  200.  
  201. The documentation and code is arranged alphabetically
  202. by the name of the tool.
  203. Disk 5 contains code and documentation for tools with
  204. names from A though D, and so on.
  205.  
  206. .ne 4
  207. .ul
  208. Disks 9, 10: Spelling dictionary
  209.  
  210. These disks contain the entire contents of file 16
  211. of the Basic Tape, a 40,000 word spelling dictionary.
  212. The dictionary is used by the SPELL tool.
  213. The spelling dictionary has been split into 30 files,
  214. one or two for each letter of the alphabet.
  215.  
  216. The dictionary contains one word per line so it would
  217. be very wasteful to print it using, say, the CP/M TYPE
  218. command,
  219. but it might be amusing to use ROFF.
  220.  
  221. You will notice that the dictionary needs
  222. .ul
  223. a lot
  224. of editing.
  225. It is presented just as it came from the Software
  226. Tools Users Group.
  227.  
  228. .ne 4
  229. .ul
  230. Disks 11, 12:  Extra Tools
  231.  
  232. These disks contain the entire contents of file 15
  233. from the Basic Tape.
  234.  
  235. Once again, the documentation for each tool is on
  236. a separate .DOC file.
  237.  
  238. Most of the code for the extra tools is on separate .RAT files.
  239. However, the files
  240. XXX-TOC, CTO-XXX and SET contain source for more than
  241. one tool.
  242. The files XXX-TOC and CTO-XXX contain conversion routines.
  243. The file SET contains set manipulation tools.
  244.