summaryrefslogtreecommitdiff
path: root/Master/texmf/doc/man/man1/cweb.1
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf/doc/man/man1/cweb.1')
-rw-r--r--Master/texmf/doc/man/man1/cweb.187
1 files changed, 53 insertions, 34 deletions
diff --git a/Master/texmf/doc/man/man1/cweb.1 b/Master/texmf/doc/man/man1/cweb.1
index 477e74bca4f..1698bf11eef 100644
--- a/Master/texmf/doc/man/man1/cweb.1
+++ b/Master/texmf/doc/man/man1/cweb.1
@@ -1,35 +1,35 @@
-.TH CWEB 1 "19 December 2004" "Web2C 2009"
-.
+.TH CWEB 1 "7 April 2010" "Web2C 2010/pretest"
+.\"=====================================================================
.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]]
+.RB [ \-bhp ]
+.RB [ +s ]
+.IR webfile [ \fB.w\fP ]
+.RI [ changefile [ \fB.ch\fP ]
+.RI [ outputfile [ \fB.c\fP ]]]
.br
.B cweave
-[
-.B \-befhpx
-] [
-.B +s
-] webfile[.w] [changefile[.ch]] [outputfile[.tex]]
+.RB [ \-befhpx ]
+.RB [ +s ]
+.IR webfile [ \fB.w\fP ]
+.RI [ changefile [ \fB.ch\fP ]
+.RI [ outputfile [ \fB.tex\fP ]]]
.ad
-.
+.\"=====================================================================
.SH DESCRIPTION
The
-.I ctangle
+.B 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
+.B 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
@@ -43,18 +43,28 @@ 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 first is taken as the CWEB file (and
+.B .w
+is added if there is no extension).
+If that file cannot be opened, the extension
+.B .web
+is tried instead. (But
+.B .w
+is recommended, since
+.B .web
+usually implies Pascal.)
+If there is a second name, it is a change file (and
+.B .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.
+extension
+.B .c
+or
+.BR .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
@@ -74,7 +84,9 @@ 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.
+If you say
+.BR \-bhp ,
+you get nothing but error messages.
.PP
The
.B +s
@@ -82,7 +94,7 @@ 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
+.B cweave
only:
.B \-f
means do not force a newline after every statement in the formatted output.
@@ -90,14 +102,20 @@ means do not force a newline after every statement in the formatted output.
inhibits the enclosure of C\ material formatted by
.I cweave
in brackets
-\ePB{...}.
+\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 ENVIRONMENT
+The environment variable CWEBINPUTS is used to search for the input files,
+or the system default if CWEBINPUTS is not set. See
+.BR tex (1)
+for the details of the searching.
+.\"=====================================================================
.SH FILES
The location of the files mentioned below varies from system to
system. Use the
@@ -109,21 +127,22 @@ TeX macros used by cweave output.
.TP
.I cwebman.tex
The user manual.
-.
+.\"=====================================================================
.SH "SEE ALSO"
.TP
.I Literate Programming
-by D. E. Knuth
+by D. E. Knuth.
.TP
.I Weaving a Program
-by Wayne Sewell
+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)
-.
+and the source code listings).
+.PP
+.BR tex (1),
+.BR cc (1).
+.\"=====================================================================
.SH AUTHORS
Don Knuth wrote WEB for TeX and Pascal.
Silvio Levy designed and developed CWEB