home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
The CDPD Public Domain Collection for CDTV 3
/
CDPDIII.bin
/
pd
/
programming
/
utils
/
cweb
/
amiga
/
cweb.man
< prev
next >
Wrap
Text File
|
1993-01-21
|
5KB
|
133 lines
CWEB(1L) CWEB(1L)
NNAAMMEE
ctangle, cweave - translate CWEB to C and/or TeX
SSYYNNOOPPSSIISS
ccttaannggllee [ --bbhhpp ] [ ++ss ] webfile[.w] [changefile[.ch]]
[outputfile[.c]]
ccwweeaavvee [ --bbffhhiippxx ] [ ++aaggss ] webfile[.w] [changefile[.ch]]
[outputfile[.tex]]
DDEESSCCRRIIPPTTIIOONN
The _c_t_a_n_g_l_e program converts a CWEB source document into a
C program that may be compiled in the usual way. The out-
put file includes #line specifications so that debugging
can be done in terms of the CWEB source file.
The _c_w_e_a_v_e 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.
CWEB allows you to prepare a single document containing
all the information that is needed both to produce a com-
pilable 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.
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 recom-
mended, 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.
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).
The --bb option suppresses the banner line that normally
appears on your terminal when ctangle or cweave begins.
The --hh option suppresses the happy message that normally
appears if the processing was successful. The --pp option
suppresses progress reports (starred module numbers) as
6/15/92 1
CWEB(1L) CWEB(1L)
the processing takes place. If you say -bhp, you get noth-
ing but error messages.
The ++ss option prints statistics about memory usage at the
end of a run (assuming that the programs have been com-
piled with the -DSTAT switch).
There are two other options applicable to _c_w_e_a_v_e only: --ff
means do not force a newline after every statement in the
formatted output. --xx means omit the index and table of
contents.
In addition to these options the Amiga version of _c_w_e_a_v_e
has three more options: ++aa causes Amiga-specific type
identifiers to be recognized as keywords (e.g. UWORD). ++gg
means that the German CWEB macros should be used instead
of the English ones. --ii causes parameter declarations at
function heads not to be indented.
FFIILLEESS
cweb/cwebmac.tex TeX macros used by cweave output.
amiga/cwebmacg.tex: German TeX macros for cweave output.
cweb/cwebman.tex The user manual.
cweb/examples/wc.w An introductory example.
SSEEEE AALLSSOO
_L_i_t_e_r_a_t_e _P_r_o_g_r_a_m_m_i_n_g by D.E. Knuth.
_W_e_a_v_i_n_g _a _P_r_o_g_r_a_m by Wayne Sewell
tex(1), cc(1)
AAUUTTHHOORRSS
Don Knuth wrote WEB for TeX and Pascal. Silvio Levy
designed and developed CWEB by adapting the WEB conven-
tions to C and by recoding everything in CWEB. Knuth
began using CWEB and made further refinements.
6/15/92 2