home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / cweb28.zip / README < prev    next >
Text File  |  1992-10-03  |  3KB  |  81 lines
  1. % This file is part of CWEB.
  2. % The CWEB programs by Silvio Levy are based on programs by D. E. Knuth.
  3. % They are distributed WITHOUT ANY WARRANTY, express or implied.
  4. % This README file last updated October 1992 by Don Knuth
  5.  
  6. % Copyright (C) 1987,1990,1992 Silvio Levy and Donald E. Knuth
  7.  
  8. % Permission is granted to make and distribute verbatim copies of this
  9. % document provided that the copyright notice and this permission notice
  10. % are preserved on all copies.
  11.  
  12. % Permission is granted to copy and distribute modified versions of this
  13. % document under the conditions for verbatim copying, provided that the
  14. % entire resulting derived work is distributed under the terms of a
  15. % permission notice identical to this one.
  16.  
  17. % Please send comments, suggestions, etc. to levy@math.berkeley.edu.
  18.  
  19. This directory contains the following files:
  20.  
  21. Makefile
  22. README
  23. common-man.ch
  24. common-vms.ch
  25. common.c
  26. common.h
  27. common.w
  28. ctangle-man.ch
  29. ctangle-vms.ch
  30. ctangle.c
  31. ctangle.w
  32. cweave-man.ch
  33. cweave-vms.ch
  34. cweave.w
  35. cweb.1
  36. cweb.el
  37. cwebmac.tex
  38. cwebman.tex
  39. examples/
  40. prod.w
  41.  
  42. (If you got cweb by mail, you may have cweave.w.1 and cweave.w.2
  43. instead of cweave.w.  The first thing to say then is
  44.  
  45. cat cweave.w.[12] > cweave.w
  46.  
  47. )
  48.  
  49. The file cwebman.tex is the user manual.
  50. The examples directory contains additional examples of the use of CWEB.
  51. The files common.c and ctangle.c are used for bootstrapping.
  52. The file cweb.1 is a manual page.
  53. The file cweb.el is suggested for GNU-Emacs users.
  54. The files *-vms.ch are sample change files for local customization.
  55. The files *-man.ch are used if you want to make the full 205-page CWEB manual.
  56.  
  57. IMPORTANT: Please touch *.c before proceeding.
  58. Then edit the opening lines of Makefile so that it has the proper
  59. directory information for your local system.
  60.  
  61. To make ctangle and cweave say `make all'; this should produce the
  62. following actions (possibly with harmless warning messages from cc):
  63.  
  64. cc -g -DDEBUG -DSTAT -w -c ctangle.c
  65. cc -g -DDEBUG -DSTAT -w -c common.c
  66. cc -g -DDEBUG -DSTAT -w -o ctangle ctangle.o common.o 
  67. ./ctangle cweave
  68. cc -g -DDEBUG -DSTAT -w -c cweave.c
  69. cc -g -DDEBUG -DSTAT -w -o cweave cweave.o common.o
  70.  
  71. To get some reassurance that things are OK, you can say `make cautiously',
  72. which ensures that CTANGLE will reproduce itself. (Otherwise the source
  73. files common.w and ctangle.w won't actually have been used.)
  74.  
  75. To install cweave and ctangle say `make install'.
  76.  
  77. Note that change files for vms are provided.  When you are first bootstrapping
  78. to a new system, you may need to edit common.c and ctangle.c by hand, but
  79. the vast majority of the change-file changes are minor refinements
  80. that are not necessary for a rudimentary ctangle.
  81.