% This file is part of CWEB.
% The CWEB programs by Silvio Levy are based on programs by D. E. Knuth.
% They are distributed WITHOUT ANY WARRANTY, express or implied.
% This README file last updated May 2000 by Don Knuth

% Copyright (C) 1987,1990,1993,2000 Silvio Levy and Donald E. Knuth

% Permission is granted to make and distribute verbatim copies of this
% document provided that the copyright notice and this permission notice
% are preserved on all copies.

% Permission is granted to copy and distribute modified versions of this
% document under the conditions for verbatim copying, provided that the
% entire resulting derived work is given a different name and distributed
% under the terms of a permission notice identical to this one.

% Please send comments, suggestions, etc. to levy@math.berkeley.edu.

This directory contains the following files:

Makefile
README
comm-amiga.ch
comm-bs.ch
comm-mac.ch
comm-man.ch
comm-pc.ch
comm-ql.ch
comm-vms.ch
comm-w32.ch
common.c
common.h
common.w
ctang-bs.ch
ctang-man.ch
ctang-pc.ch
ctang-ql.ch
ctang-vms.ch
ctang-w32.ch
ctangle.c
ctangle.w
cweav-bs.ch
cweav-man.ch
cweav-pc.ch
cweav-ql.ch
cweav-vms.ch
cweave-w32.ch
cweave.w
cweb.1
cweb.el
cwebmac.tex
cwebman.tex
examples/
makefile.bs
prod.w
readme.ql
c++lib.w

The file cwebman.tex is the user manual.
The examples directory contains additional examples of the use of CWEB.
The files common.c and ctangle.c are used for bootstrapping.
The file cweb.1 is a manual page.
The file cweb.el is suggested for GNU-Emacs users.
The file c++lib.w is for C++ users (say `@i c++lib.w' at beginning of program).
The files *-man.ch are used if you want to make the full 239-page CWEB manual.
The files *-bs.ch are used instead of *-pc.ch if you are doing BIG programs.
You can use makefile.bs to make CWEB with *-bs.ch.
The files *-ql.ch are for QDOS/SMSQ systems; see readme.ql for further info.
The files *-w32.ch use __fastcall conventions on win32 systems.
The file comm-mac.ch is for Macintosh conventions.
The other files named *.ch are sample change files for local customization.

IMPORTANT: Please touch *.c before proceeding.
Then edit the opening lines of Makefile so that it has the proper
directory information for your local system.

To make ctangle and cweave say `make all'; this should produce roughly
the following actions (possibly with harmless warning messages from cc):

cc -g -w -c ctangle.c
cc -g -w -DCWEBINPUTS=\"/usr/local/lib/cweb\" -c common.c
cc -g -o ctangle ctangle.o common.o
./ctangle cweave
cc -g -w -c cweave.c
cc -g -w -o cweave cweave.o common.o

To get some reassurance that things are OK, you can say `make cautiously',
which ensures that CTANGLE will reproduce itself. (Otherwise the source
files common.w and ctangle.w won't actually have been used.)

To install cweave and ctangle say `make install'. You probably need to
be superuser to do this; but it's wise to `make all' first, BEFORE
becoming superuser and saying `make install'.

Note that change files for VMS, AMIGA, MAC, and PCs are provided.  When you
are first bootstrapping to a new system, you may need to edit common.c and
ctangle.c by hand, but the vast majority of the change-file changes are
minor refinements that are not necessary for a rudimentary ctangle.

This is the readme file for CWEB for QDOS/SMSQ systems

(These instructions are for systems with Toolkit II,
 please report any problems to me, the address is at the
 end of the file)

If you want to compile CWEB for your QL system, you must first
convert the ASCII code to the QL's character set.  Therefore you
can use the little BASIC program appended at the end of the file.

For a first version you have to alter the supplied ctangle_c file.
Set your DATA_USE to the directory you have the CWEB sources in, and
the PROG_USE to C68's directory.
compile it with:
ex cc;'common_c ctangle_c -bufp500K -octangle'

then ctangle the source files with:
ex datad$&'ctangle';'common_w comm-ql_ch'
ex datad$&'ctangle';'ctangle_w ctang-ql_ch'
ex datad$&'ctangle';'cweave_w cweav-ql_ch'

Compile the following way (C68v4.14 +):

ex cc;'-c common_c'
ex cc;'-c ctangle_c'
ex cc;'-c cweave_c'
ex ld;'-bufp500K common_o ctangle_o -octangle'
ex ld;'-bufp500K common_o cweave_o -ocweave'

After that copy the ctangle and cweave executables into your
programs directory (if you want them there).

The DATA default may be used as usual.  E.g. if you have
a file win2_data_test_w and the DATA default set to
win2_data_ you may call ctangle with
     ex ctangle;'test'
assuming that ctangle is in your PROG default.

Please report any problems with the QL version to:
Robert Klein
Bluecherstrasse 24
D-56349 Kaub
Germany


**************** ASCII Conversion program ***************
With this program you can convert DOS and Unix 7-Bit ASCII
files to the QL's character set.  You'll need Toolkit II.
The program will take all the files in the source directory
and put them converted into the destination&source directory,
e.g. you have as drive1$='win2_', drive2$='win3_',
path1$='cweb_' and path2$='ql_'.  Then the routine will take
all files in win2_cweb_ (wthout subdirectories!) convert them
and write them to 'win3_ql_cweb_'.  It's only a lousy hack,
but it'll do it's job.

1000 DEFine PROCedure dos2ql (drive1$,path1$,drive2$,path2$)
1002 LOCal zx$,zx%,ishl,ashl
1005 DELETE drive2$&path2$&'dirlist'
1010 OPEN_NEW#5,drive2$&path2$&'dirlist'
1020 DIR#5,drive1$&path1$
1030 CLOSE#5
1040 OPEN_IN#5,drive2$&path2$&'dirlist'
1050 INPUT#5,zx$:INPUT#5,zx$:REMark devicename and sectors
1060 REPeat ashl
1070   IF EOF(#5)THEN EXIT ashl
1080   INPUT#5,zx$
1085   IF '->' INSTR zx$ THEN NEXT ashl
1090   OPEN_IN#3,drive1$&zx$
1100   OPEN_NEW#4,drive2$&path2$&zx$
1110   REPeat ishl
1120     IF EOF(#3)THEN EXIT ishl
1130     BGET#3,zx%
1140     SELect ON zx%
1150       = 13:REMark do nothing (DOS LineFeed)
1155       = 26:REMark do nothing (DOS EOF sign)
1160       = 96: BPUT#4,159:REMark Unix/DOS beginning quote sign
1170       = REMAINDER : BPUT#4,zx%
1180     END SELect
1190   END REPeat ishl
1195   CLOSE#3:CLOSE#4
1200 END REPeat ashl
1205 CLOSE#5
1210 END DEFine dos2ql