source/texk/web2c/cwebdir/README

   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 January 2016 by Don Knuth
   5
   6 % Copyright (C) 1987,1990,1993,2000,2016 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 given a different name and distributed
  15 % under the terms of a permission notice identical to this one.
  16
  17 % Please send comments, suggestions, etc. to tex-k@tug.org, and people
  18 % there will verify and forward bug reports.
  19 %
  20 % DEK takes no responsibility for the changefiles; they should be
  21 % maintained independently. His job is to correct errors in
  22 % ctangle.w, cweave.w, common.w, cwebmac.tex, cwebman.tex,
  23 % and in the files of examples/*.w, nothing more.
  24
  25 This directory contains the following files:
  26
  27 Makefile
  28 README
  29 comm-amiga.ch
  30 comm-bs.ch
  31 comm-mac.ch
  32 comm-man.ch
  33 comm-pc.ch
  34 comm-ql.ch
  35 comm-vms.ch
  36 comm-w32.ch
  37 common.c
  38 common.h
  39 common.w
  40 ctang-bs.ch
  41 ctang-man.ch
  42 ctang-pc.ch
  43 ctang-ql.ch
  44 ctang-vms.ch
  45 ctang-w32.ch
  46 ctangle.c
  47 ctangle.w
  48 cweav-bs.ch
  49 cweav-man.ch
  50 cweav-pc.ch
  51 cweav-ql.ch
  52 cweav-vms.ch
  53 cweave-w32.ch
  54 cweave.w
  55 cweb.1
  56 cweb.el
  57 cwebmac.tex
  58 cwebman.tex
  59 examples/
  60 makefile.bs
  61 prod.w
  62 readme.ql
  63 c++lib.w
  64
  65 The file cwebman.tex is the user manual.
  66 The examples directory contains additional examples of the use of CWEB.
  67 The files common.c and ctangle.c are used for bootstrapping.
  68 The file cweb.1 is a manual page.
  69 The file cweb.el is suggested for GNU-Emacs users.
  70 The file c++lib.w is for C++ users (say `@i c++lib.w' at beginning of program).
  71 The files *-man.ch are used if you want to make the full 239-page CWEB manual.
  72 The files *-bs.ch are used instead of *-pc.ch if you are doing BIG programs.
  73 You can use makefile.bs to make CWEB with *-bs.ch.
  74 The files *-ql.ch are for QDOS/SMSQ systems; see readme.ql for further info.
  75 The files *-w32.ch use __fastcall conventions on win32 systems.
  76 The file comm-mac.ch is for Macintosh conventions.
  77 The other files named *.ch are sample change files for local customization.
  78
  79 IMPORTANT: Please touch *.c before proceeding.
  80 Then edit the opening lines of Makefile so that it has the proper
  81 directory information for your local system.
  82
  83 To make ctangle and cweave say `make all'; this should produce roughly
  84 the following actions (possibly with harmless warning messages from cc):
  85
  86 cc -g -w -c ctangle.c
  87 cc -g -w -DCWEBINPUTS=\"/usr/local/lib/cweb\" -c common.c
  88 cc -g -o ctangle ctangle.o common.o
  89 ./ctangle cweave
  90 cc -g -w -c cweave.c
  91 cc -g -w -o cweave cweave.o common.o
  92
  93 To get some reassurance that things are OK, you can say `make cautiously',
  94 which ensures that CTANGLE will reproduce itself. (Otherwise the source
  95 files common.w and ctangle.w won't actually have been used.)
  96
  97 To install cweave and ctangle say `make install'. You probably need to
  98 be superuser to do this; but it's wise to `make all' first, BEFORE
  99 becoming superuser and saying `make install'.
 100
 101 Note that change files for VMS, AMIGA, MAC, and PCs are provided.  When you
 102 are first bootstrapping to a new system, you may need to edit common.c and
 103 ctangle.c by hand, but the vast majority of the change-file changes are
 104 minor refinements that are not necessary for a rudimentary ctangle.