/
README.txt
404 lines (351 loc) · 21.9 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
-*-Text-*-
%%% LEGALESE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% This file is part of CWEBbin (Version 4.11 [2023]).
% (Set TAB to 8 spaces to get the spacing right.)
% 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 was last updated May 15, 2023 by Andreas Scherer.
% The following copyright notices extend to the respective parts of the
% changed or added source code introduced in this patch only, not to the
% original CWEB distribution, which is copyright (C) 1987,1990,1993,1998
% by Silvio Levy and Donald E. Knuth.
%
% Copyright (C) 1991-1993 Hans-Hermann Bode
% Copyright (C) 1992 Klaus Guntermann
% Copyright (C) 1991,1993 Carsten Steger
% Copyright (C) 1993-2000,2005,2011,2018–2023 Andreas Scherer
% 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., concerning the original CWEB
% implementation to tex-k@tug.org or visit the CWEB development project
% https://github.com/ascherer/cweb.
% Please send comments, suggestions, etc., related to changes specific
% for this modified distribution CWEBbin, especially language catalog
% translations to https://ascherer.github.io, or write an issue or pull
% request in https://github.com/ascherer/cwebbin.
%%% WHAT IS THIS STUFF? %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CWEBbin is an extension of Silvio Levy's and Donald Ervin Knuth's CWEB system.
Additional features differing from the original distribution are described
further below. General information is provided in the original README file
shipped with the CWEB distribution.
CWEBbin started from the Amiga port of CWEB 2.8 by Carsten Steger. Then it
was merged with the CWEB-PC 3.0 distribution by Hans-Hermann Bode and Klaus
Guntermann, and the Amiga port of CWEB 3.1 by Tomas Charles Willis. Of
course, it includes all features of the original UNIX implementation and all
enhancements of these Amiga and MS/DOS/Windows ports.
The distribution of CWEBbin consists of the additional files for this patch
only. The complete contents of the original distribution is a prerequisite.
CWEB 4.0 (and higher) can be retrieved from
https://github.com/ascherer/cweb
To apply this patched version of CWEB, extract the patch archive and add the
contents of the original distribution. Care has been taken to avoid
collisions with any files from the original distribution and the Makefiles
provide a target to cleanly remove the patch leaving only the files of the
original distribution (and vice versa).
Intermediate files with extensions .tex and .cxx are reproducable from the
general sources by means of an executable ctangle, cweave, and an ANSI-C/C++
compiler. In addition you need Klaus Guntermann's TIE processor, which is
available at
CTAN: https://ctan.org/pkg/tie
To produce the CWEB source code of the CTWILL program from the original CWEAVE
source, you need Julian Gilbey's CTIE processor, which is available at
CTAN: https://ctan.org/pkg/ctie
C/TIE should be available on all systems with a recent TeX installation.
%%% TABLE OF CONTENTS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
The following files were added to this distribution by various contributors:
GENERAL CONTRIBUTION:
.
├── 0001-Support-extended-syntax-for-numeric-literals.patch for CTWILL
├── 0002-Purge-redundant-TeX-macro.patch for CTWILL
├── 0003-Adapt-to-CWEB-4.5.patch for CTWILL
├── 0004-Add-silent-datecontentspage-macro.patch for CTWILL
├── comm-extensions.ch change file for common.w
├── comm-extensions.hch change file for common.h
├── comm-i18n.ch change file for common.w
├── comm-i18n.hch change file for common.h
├── comm-mini.ch auxiliary file for COMMON
├── comm-newpage.ch change file for common.w
├── common.bux auxiliary file for COMMON
├── common.cxx product of common.w and comm-foo.ch
├── comm-output.ch change file for common.w
├── comm-output.hch change file for common.h
├── comm-patch.ch change file for common.w
├── comm-texlive.ch change file for common.w
├── comm-texlive.hch change file for common.h
├── ctang-i18n.ch change file for ctangle.w
├── ctangle.1 clone of cweb.1
├── ctangle.cxx product of ctangle.w and ctang-foo.ch
├── ctang-newpage.ch change file for ctangle.w
├── ctang-output.ch change file for ctangle.w
├── ctang-patch.ch change file for ctangle.w
├── ctang-texlive.ch change file for ctangle.w
├── ctwill.bux auxiliary file for CTWILL
├── ctwill-man.ch auxiliary file for CTWILL
├── ctwill.md manpage for CTWILL in markdown
├── ctwill-mini.ch auxiliary file for CTWILL
├── ctwill-texlive.ch change file for cweave.w/ctwill.w
├── cweave.1 clone of cweb.1
├── cweav-extensions.ch change file for cweave.w
├── cweav-i18n.ch change file for cweave.w
├── cweav-newpage.ch change file for cweave.w
├── cweav-output.ch change file for cweave.w
├── cweav-patch.ch change file for cweave.w
├── cweav-texlive.ch change file for cweave.w
├── cweav-twill.ch change file for cweave.w
├── cwebbin.spec extended build recipe for debbuild
├── cwebinputs
│ ├── amiga_types.w keywords by Commodore and SAS
│ ├── c++1xlib.w Keywords for modern C++ standards
│ ├── cweb_ecma94.w Transliteration table for Latin-1
│ ├── cweb_hp8.w Transliteration table for HP Roman 8
│ ├── cweb_mac8.w Transliteration table for Mac 8-bit
│ ├── cweb_pc850.w0.w Transliteration table for Codepage 850
├── cwebman-extensions.ch change file for cwebman.tex
├── cwebman-patch.ch change file for cwebman.tex
├── cwebman-texlive.ch change file for cwebman.tex
├── cweb.md base file for CWEB manpage cweb.1
├── examples
│ ├── cct.w program to translate between character tables
│ ├── commonwords.w program to count word frequencies in text files
│ ├── extex-ansi.ch change file for extex.w
│ ├── Makefile.sas [AMIGA] makefile for SAS/C compiler 6.0 and up
│ ├── matrix.w C++ program to invert complex 4x4 matrices
│ ├── primes.ch changes for the first 1000000 prime numbers
│ ├── primes.w program to print the first 1000 prime numbers
│ ├── README.p11 extended description for the added examples
│ ├── sample.w program to produce random numbers
│ ├── treeprint-ansi.ch change file for treeprint.w
│ ├── wc-ansi.ch change file for wc.w
│ ├── wmerg-ansi.ch change file for wmerge.w
│ ├── wmerg-borlandc.ch [BCC] change file for wmerge.w
│ ├── wmerge.dsp [MSVC] Developer Studio Project for WMERGE
│ ├── wmerg-extensions.ch change file for wmerge.w
│ ├── wmerg-memory.ch [AMIGA,BCC] change file for wmerge.w
│ ├── wmerg-output.ch change file for wmerge.w
│ ├── wmerg-patch.ch change file for wmerge.w
│ └── wordtest-ansi.ch change file for wordtest.w
├── LICENSE MIT license
├── Makefile.unix makefile for cc, c89, gcc, ... on several machines
├── po
│ ├── cweb.pot Portable Object Template for i18n
│ ├── cweb-tl.pot Portable Object Template for i18n
│ ├── de
│ │ ├── cweb.po Portable Object for German t10n
│ │ ├── cweb-tl.po Portable Object for German t10n
│ │ └── web2c-help.po Portable Object for German t10n
│ ├── it
│ │ └── cweb.po Portable Object for Italian t10n
│ └── web2c-help.pot Portable Object Template for i18n
├── prod-twill.ch change file for prod.w/CTWILL
├── README.md Github project description
├── README.txt the current file
├── refsort.1 manpage link to ctwill.1
├── refsort.ch Patch for refsort.w
├── system.bux auxiliary file for CTWILL
├── texinputs
│ ├── cweb_ecma94.sty Umlauts and special characters for Latin-1
│ ├── cweb_hp8.sty Umlauts and special characters for HP Roman 8
│ ├── cweb_mac8.sty Umlauts and special characters for Macintosh
│ ├── cweb_pc850.sty Umlauts and special characters for IBM 850
│ ├── dctwimac.tex German captions in addition to ctwimac.tex
│ ├── dcwebmac.tex German captions in addition to cwebmac.tex
│ ├── dcwebstrings.tex Common German captions
│ ├── dproofmac.tex German captions in addition to proofmac.tex
│ ├── fcwebmac.tex French captions in addition to cwebmac.tex
│ ├── icwebmac.tex Italian captions in addition to cwebmac.tex
│ ├── pdfctwimac.tex PDF macros for CTWILL
│ ├── pdfwebtocfront.tex place TOC page at front of PDF output
│ └── Xcwebmac.tex beautifications for cwebmac.tex
├── texlive.w introduction to *-w2c.ch change files
├── twinx.1 manpage link to ctwill.1
├── twinx.ch Patch for twinx.w
├── twinx-startup.tex preamble starter for twinxmac.tex
└── vault
├── arexx [AMIGA]
│ ├── catalogs
│ │ ├── cweb_arexx.cd [AMIGA] catalog description for German defaults
│ │ ├── cweb_arexx.e.ct [AMIGA] catalog translation for English users
│ │ ├── cweb_arexx.f.ct [AMIGA] catalog translation for French users
│ │ ├── cweb_arexx.i.ct [AMIGA] catalog translation for Italian users
│ │ ├── english
│ │ │ └── cweb_arexx.catalog [AMIGA] message catalog for English users
│ │ ├── francais
│ │ │ └── cweb_arexx.catalog [AMIGA] message catalog for French users
│ │ └── italiano
│ │ └── cweb_arexx.catalog [AMIGA] message catalog for Italian users
│ ├── compile.ced [AMIGA] ARexx script to start SAS/C 6.x from CED (V3.5+)
│ └── start_web.ced [AMIGA] ARexx script to start cweave/ctangle from CED
├── catalogs
│ ├── cweb.cd [AMIGA] catalog description for English defaults
│ ├── cweb.d.ct [AMIGA] catalog translation for German users
│ ├── cweb.i.ct [AMIGA] catalog translation for Italian users
│ ├── dcweb.h [AMIGA,BCC] header file with the German strings
│ ├── ecweb.h [AMIGA,BCC] header file with the English default strings
│ └── icweb.h [AMIGA,BCC] header file with the Italian strings
├── comm-arexx.ch [AMIGA] change file for common.w
├── comm-arexx.hch [AMIGA] change file for common.h
├── comm-borlandc.ch [BCC] change file for common.w
├── comm-borlandc.hch [BCC] change file for common.h
├── comm-memory.ch [AMIGA,BCC] change file for common.w
├── comm-memory.hch [AMIGA,BCC] change file for common.h
├── comm-translation.ch [AMIGA,BCC] change file for common.w
├── comm-translation.hch [AMIGA,BCC] change file for common.h
├── ctang-borlandc.ch [BCC] change file for ctangle.w
├── ctangle.dsp [MSVC] Developer Studio Project for CTANGLE
├── ctang-memory.ch [AMIGA,BCC] change file for ctangle.w
├── ctang-translation.ch [AMIGA,BCC] change file for ctangle.w
├── cweav-borlandc.ch [BCC] change file for cweave.w
├── cweave.dsp [MSVC] Developer Studio Project for CWEAVE
├── cweav-memory.ch [AMIGA,BCC] change file for cweave.w
├── cweav-translation.ch [AMIGA,BCC] change file for cweave.w
├── cwebbin.dsw [MSVC] Developer Studio Workspace for all three
├── Makefile.bcc [BCC] makefile for Borland C/C++
└── Makefile.sas [AMIGA] makefile for SAS/C compiler 6.0 and up
%%% HOW TO CREATE THE BINARIES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
[UNIX/Linux, GCC] The current setup of CWEBbin has been created on a Linux PC
running GNU/Linux including the gcc/g++ compiler and the TeXLive system.
Any similar setup should also work. All set?
-- Then proceed as follows:
1. Check the entries in Makefile.unix for local conditions like a
different compiler name or additional compiler options you want to
use. Check also the other lines in Makefile.unix so that all
directory definitions are set properly for your local system
configuration.
2. If you want to create the ctangle and cweave binaries for a
different language than English, set a link from one of the
`[dei]cweb.h' header files to `cweb.h' in the ./catalogs directory.
3. Touch common.cxx and ctangle.cxx to make them up-to-date. Then say
`make -f Makefile.unix boot'; this will create a local ctangle binary
simply by compiling the distributed .cxx files.
4. To make ctangle, cweave, and the wmerge processor say `make -f
Makefile.unix [all]'. 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.)
5. <Obsolete>After all is set, you should become `superuser' and run
`make -f Makefile.unix install'; this will install the binaries, the
TeX macros and CWEB @include files, and some documentation in places
specified in Makefile.unix.</Obsolete>
Please follow the instructions in README.md for 'advanced packaging'.
deb- and rpm-packages not only can be installed, but also cleanly
uninstalled from all system paths.
6. If you want a full documentation of the tangle and weave programs,
type `make -f Makefile.unix docs' or preferably `make -f Makefile.unix
fullmanual'. The documentation created will include all changes
introduced by the .ch files.
7. To delete all intermediate files created in the make processes say
`make -f Makefile.unix clean'.
8. To remove the complete patch from the installed CWEB system, say
`make -f Makefile.unix remove'. You will be left with the original
CWEB system.
9. To remove the complete base system leaving only the patch behind,
you can say `make -f Makefile.unix remove-orig'.
10. The other labels have not been tested seriously. :-)
[AMIGA, SAS/C++ 6] I can no longer support this compiler and computer system
and most likely it's impossible to install CWEBbin with SAS/C++. The
source files common.cxx, common.h, and ctangle.cxx can definitely NOT
be used with SAS/C++ anymore. They were created on a Linux PC leaving
the Amiga stuff out. You will have to use an older ctangle binary to
create the TIE processor and then create the complete set of change
files according to Makefile.sas. Good luck!
[MS/DOS, BORLAND C++ 3.1] I can no longer support this compiler and most
likely it's impossible to install CWEBbin with BC. The source files
common.cxx, common.h, and ctangle.cxx can definitely NOT be used with
BC anymore. They were created on a Linux PC leaving the
`*-borlandc.*' change files out. You will have to use an older
ctangle.exe binary to create the TIE processor and then create the
complete set of change files according to Makefile.bcc. Good luck!
[MS/WINDOWS, MS/VC++ 4.1 and 6.0] I can no longer support this compiler and
most likely it is impossible to install CWEBbin with this version of
the Microsoft compiler. The current version of MS/VC++ is supported
through binary versions of CTANGLE and CWEAVE at
http://www.literateprogramming.com.
%%% LIST OF FEATURES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
After the announcement of CWEB 3.3 [p11a] on news:comp.programming.literate
and news:comp.text.tex there have been questions: ``What's different in your
CWEB system in respect to the original system? Why should programmers use
your's instead of the Levy/Knuth distribution?''
So here are some words about the `special features':
- [GENERAL] The `+l' (or `-l') option with its argument `X' causes CWEAVE
to prepend `X' to `cwebmac.tex' in the first line of the output file.
`X' may be any string of characters (case dependent and possibly empty),
e.g., if you called CWEAVE with the option `+ldansk', the danish macro
file `danskcwebmac.tex' (if there's such a thing) would be included
instead of `cwebmac.tex'. The macro file `Xcwebmac.tex' itself contains
some modifications to the original `cwebmac.tex' file as described in the
documentation. At the time of writing there are macro packages
`dcwebmac.tex' by Andreas Scherer for German users, `icwebmac.tex' by
Giuseppe Ghibò for Italian users, and `fcwebmac.tex' by Denis B. Roegel
for French users. These macro files translate all captions used by the
CWEAVE processor into the respective languages and also include support
for special characters like umlauts (diacritics) and some other
frequently used specials according to ISO Latin-1, IBM PC International
Codepage 850, Macintosh 8-bit font table and HP Roman 8. Similar
packages for other languages can easily be added to this scheme. To date
there are no conflicting languages, so single-character strings are used.
However, there is no support for UTF-8 at this time.
- [GENERAL] There are transliteration tables `cweb_ecma94.w', `cweb_hp8.w',
`cweb_mac8.w', and `cweb_pc850.w' for @inclusion in limbo. These files
\input the associated TeX macro files `cweb_ecma94.sty', `cweb_hp8.sty',
`cweb_mac8.sty', and `cweb_pc850.sty' with i18n support of extended code
tables. These macros can, of course, also be used independently of
the CWEB files and have been set up to work as `packages' for LaTeX
as well. The option `+a' of former versions of the AMIGA installation
is now replaced by the file `amiga_types.w' that can be `@i'ncluded in
the source files where needed.
- [GENERAL] Both CTANGLE and CWEAVE are fully localized for other natural
languages than the English default. See the 'po/' directory for the
files used with the "GNU gettext utilities".
<Obsolete>#include files with the English, German, and Italian strings
are provided in the ./catalogs directory for non-localized operating
systems. On AmigaOS 2.1/3.0 localization is done with the help of
language catalogs and the system `locale.library'. Default is (of
course) English; catalogs descriptions for German and Italian are
provided and other language catalogs can easily be added.</Obsolete>
- [GENERAL] An algorithm for recursive `@i'nclude file search was adapted
from the Web2c implementation of TeX and METAFONT. The weave and tangle
processors as well as wmerge now recognize the environment variable
CWEBINPUTS. When an include file name (argument to the @i command) can
not be found in the current directory or in the absolute path, a
multi-path search is performed. CWEBINPUTS---if not empty---may contain
a list of search path names, delimited by PATH_SEPARATORs, e.g., colons.
The current directory is represented by an empty path entry, but it is
searched first anyway. In the respective makefiles for AMIGA, UNIX and
MS/DOS some decent defaults are set in the compile time constant
CWEBINPUTS, which always is appended to any environment variable, so you
don't have to repeat the defaults.
- [GENERAL] The `-o' option was added in connection with Carsten Steger's
`-i' option. Both affect typographic niceties in the woven output.
- [GENERAL] The output files of CTANGLE and CWEAVE are only written when
there are significant changes to their contents, i.e., when a CWEB source
creates multiple output files, only those modules effected by changes
will be recompiled in the `make' process. This mechanism was taken from
Preston Briggs's NUWEB program, to whom credit is due.
- [GENERAL] Five additional CWEB example programs are included as examples
for the portability between PASCAL-WEB and C-CWEB and for the usage of
the C++ features of version 3.1. The fifth example program is a simple
text converter for files with extended character codes of ISO-Latin-1,
PC-850, MAC 8-bit font, and HP 8-bit font.
- [GENERAL] The latest release of CWEBbin is fully compatible with the
"TeX Live" system. 'cwebbin.spec' and 'Makefile.unix' are prepared to
work with the '--with texlive' option. This appends and merges the
*-texlive.* change files and creates a set of *-w2c.ch change files and
an extended comm-w2c.h @include file. These files are drop-in
replacements for the hand-coded files used in the TL ecosystem.
- [GENERAL] The latest latest release of CWEBbin includes CWEAVE's
'evil twin' CTWILL, together with its utility programs 'refsort' and
'twinx', and the associated TeX macros.
- [GENERAL] CWEB 4.8 introduced full support for
Martin Ruckert's HiTeX and its HINT output format; see
https://hint.userweb.mwn.de/hint/hitex.html for details.
%%% CREDIT WHERE CREDIT IS DUE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
I want to express my deep gratitude to Silvio Levy and Donald Knuth for the
marvelous tool they provided us with. Also I am indepted to my various pre-
and co-workers on whose initial ideas and contributions this package is based.
Happy CWEBbin'!
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%