@@ -1,69 +1,73 @@
-.TH WEB 1L 7/12/90
+.TH CWEBX 1 7/12/90
-ctangle, cweave \- translate CWEB to C (or C++) and/or TeX
+ctanglex, cweavex \- translate CWEB(x) to C (or C++) and/or TeX
-] cwebfile[.w] [(changefile[.ch]|+|-) [outputfile[.c]]]
+] \fIcwebfile\fR[.w] [(\fIchangefile\fR[.ch]|+|-) [\fIoutputfile\fR[.c]]]
-] cwebfile[.w] [(changefile[.ch]|+|-) [outputfile[.tex]]]
+] \fIcwebfile\fR[.w] [(\fIchangefile\fR[.ch]|+|-) [\fIoutputfile\fR[.tex]]]
-program converts a CWEB
+program converts a CWEB(x)
source document into a C program that may be compiled in the usual way.
-The output file includes #line specifications so that error reporting and
-debugging can be done in terms of the CWEB source file.
+The output file includes \fI#line\fR specifications so that error
+reporting and debugging can be done in terms of the CWEB(x) source file.
-program converts the same CWEB file into a TeX file that may be
+program converts the same CWEB(x) file into a TeX file that may be
formatted and printed in the usual way.
It takes appropriate care of typographic details like page layout
and the use of indentation, italics, boldface, etc., and it supplies
extensive cross-reference information that it gathers automatically.
-CWEB allows you to prepare a single
+CWEBx allows you to prepare a single
document containing all the information that is needed both to produce
a compilable C program and to produce a well-formatted document
describing the program in as much detail as the writer may desire. The
-user of CWEB ought to have some familiarity with TeX as well as knowledge
+user of CWEBx ought to have some familiarity with TeX as well as knowledge
The command line should have one, two, or three names on it. The first is
-taken as the CWEB file (and `.w' is added if there is no extension). If that
-file cannot be opened, the extension `.web' is tried instead. If there is a
-second name, it is a change file (and `.ch' is added if there is no
-extension), otherwise the name of the CWEB file with its extension replaced
-by `.ch' is tried as change file name; if there no such file, no change file
-is used. Instead of a change file one may specify `-' or `+'; `-' means do
-not use a change file, and `+' means use a change file only if a file of the
+taken as the CWEB(x) file (and `\fI.w\fR' is added if there is no
+extension). If that file cannot be opened, the extension `\fI.web\fR'
+is tried instead. If there is a second name, it is a change file (and
+`\fI.ch\fR' is added if there is no extension), otherwise the name of
+the CWEB(x) file with its extension replaced by `\fI.ch\fR' is tried as
+change file name; if there no such file, no change file
+is used. Instead of a change file one may specify `\fB-\fR' or
+`\fB+\fR'; `\fB-\fR' means do not use a change file, and `\fB+\fR'
+means use a change file only if a file of the
default name exists (just as if only one name was given). The change file
-overrides parts of the CWEB file, as described in the documentation. A third
-name, if present, specifies the output file name explicitly. The default
-output file name is that of the CWEB file with extension `.c' (for
-) or `.tex' (for
+overrides parts of the CWEB(x) file, as described in the
+documentation. A third name, if present, specifies the output file
+name explicitly. The default output file name is that of the CWEB(x)
+file with extension `\fI.c\fR' (for
+) or `\fI.tex\fR' (for
); the default extension is also applied if a third
name is given without extension.
-Options in the command line may be either turned on with `+'
-and off with `-'; several characters may follow in the same argument, which
+Options in the command line may be either turned on with `\fB+\fR' and
+off with `\fB-\fR'; several characters may follow in the same argument, which
indicate several options that are turned on respectively off simultaneously.
In fact, the options are processed from left to right,
-so a sequence like `-b +b' is equivalent to `+b' (which is the default).
+so a sequence like `\fB-b +b\fR' is equivalent to `\fB+b\fR' (which is
@@ -72,7 +76,8 @@
option shows a happy message if the processing was successful. The
option shows progress reports (starred module numbers) as the processing
-takes place. If you say `-bhp', you get no terminal output but error messages.
+takes place. If you say `\fB-bhp\fR', you get no terminal output but
@@ -80,7 +85,8 @@
option prints statistics about memory usage at the end of a run
-(assuming that the programs have been compiled with the -DSTAT switch).
+(assuming that the programs have been compiled with the \fI-DSTAT\fR
+switch, as they are by default on Debian systems).
By setting the option
one can select the C++ language instead of C.
@@ -88,19 +94,19 @@
is applicable to
only; when selected, the C output is made more readable for humans by omitting
directives and preserving layout and comments.
There are several other options applicable to
only. The option
means omit the index and table of contents. By setting the option
to report problems encountered in parsing the program fragments. With
the the index and module names will be written to separate files. With
@@ -144,17 +150,30 @@
-/usr/local/lib/tex/macros/cwebxmac.tex TeX macros used by cweave output.
+TeX macros used by cweavex output.
-/usr/local/lib/tex/macros/cwebcmac.tex TeX macros used in compatibility
+TeX macros used in compatibility mode.
-/usr/local/doc/cweb/manual.tex The user manual.
+TeX macros which can be input after \fIcwebxmac\fR to produce
+hyperlinks in the output.
+The user manual source.
+The user manual in DVI format.
.SH "SEE ALSO"
.I Literate Programming
by D. E. Knuth. (CSLI, Stanford, 1992)
-tex(1), cc(1), web(1)
+.BR tex (1),
+.BR cc (1),
+.BR cweb (1)
+.BR web (1).
Don Knuth wrote WEB for TeX and Pascal. Silvio Levy designed and developed
CWEB by adapting the WEB conventions to C and by recoding everything in CWEB.