diff options
Diffstat (limited to 'Build/source/texk/web2c/cwebdir/cweb.1')
-rw-r--r-- | Build/source/texk/web2c/cwebdir/cweb.1 | 138 |
1 files changed, 138 insertions, 0 deletions
diff --git a/Build/source/texk/web2c/cwebdir/cweb.1 b/Build/source/texk/web2c/cwebdir/cweb.1 new file mode 100644 index 00000000000..ad41c427ead --- /dev/null +++ b/Build/source/texk/web2c/cwebdir/cweb.1 @@ -0,0 +1,138 @@ +.TH CWEB 1L 2002-Apr-13 +. +.SH NAME +ctangle, cweave \- translate CWEB to C and/or TeX +. +.SH SYNOPSIS +.na +.B ctangle +[ +.B \-bhp +] [ +.B +s +] webfile[.w] [changefile[.ch]] [outputfile[.c]] +.br +.B cweave +[ +.B \-befhpx +] [ +.B +s +] webfile[.w] [changefile[.ch]] [outputfile[.tex]] +.ad +. +.SH DESCRIPTION +The +.I ctangle +program converts a CWEB +source document into a C\ program that may be compiled in the usual way. +The output file includes #line specifications so that debugging can be +done in terms of the CWEB source file. +.PP +The +.I cweave +program converts the same CWEB 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-index information that it gathers automatically. +.PP +CWEB 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 be familiar with TeX as well as\ C. +.PP +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. +(But .w is recommended, since .web usually implies Pascal.) +If there is a second name, it is a change file (and .ch is added if there is +no extension). +The change file overrides parts of the WEB file, +as described in the documentation. +If there is a third name, it overrides +the default name of the output file, which is ordinarily the same as +the name of the input file (but on the current directory) with the +extension .c or .tex. +.PP +Options in the command line may be either turned off with\ \- +(if they are on by default) or turned on with\ + (if they are off by +default). +In fact, the options are processed from left to right, +so a sequence like -f\ +f corresponds to +f (which is the default). +.PP +The +.B \-b +option suppresses the banner line that normally appears on your terminal +when ctangle or cweave begins. +The +.B \-h +option suppresses the happy message that normally appears if the processing +was successful. +The +.B \-p +option suppresses progress reports (starred module numbers) as the processing +takes place. +If you say -bhp, you get nothing but error messages. +.PP +The +.B +s +option prints statistics about memory usage at the end of a run +(assuming that the programs have been compiled with the -DSTAT switch). +.PP +There are three other options applicable to +.I cweave +only: +.B \-f +means do not force a newline after every statement in the formatted output. +.B \-e +inhibits the enclosure of C\ material formatted by +.I cweave +in brackets +\ePB{...}. +Such brackets are normally inserted so that special hooks +can be used by +.I cweb-latex +and similar programs. +.B \-x +means omit the index and table of contents. +. +.SH FILES +.TP +/usr/local/lib/tex/inputs/cwebmac.tex +TeX macros used by cweave output. +.TP +/usr/local/src/cweb/cwebman.tex +The user manual. +.TP +/usr/local/src/cweb/examples/wc.w +An introductory example. +.TP +/usr/local/src/cweb/examples/wmerge.w +Patch program based on CWEB-style change files. +.TP +/usr/local/lib/cweb +Directory for cweb "include" files. +. +.SH "SEE ALSO" +.TP +.I Literate Programming +by D. E. Knuth +.TP +.I Weaving a Program +by Wayne Sewell +.TP +.I The CWEB System of Structured Documentation +by Donald E. Knuth and Silvio Levy (hardcopy version of cwebman.tex +and the source code listings) +.TP +tex(1), cc(1) +. +.SH AUTHORS +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. +Knuth began using CWEB and made further refinements. +Many other helpers are acknowledged in the CWEB manual. + |