.TH WEAVE 1 "2 February 2026 "Web2C 2026"
.\"=====================================================================
.if n .ds TX TeX
.if t .ds TX \fRT\\h'-0.10m'\\v'0.17v'E\\v'-0.17v'\\h'-0.06m'X\fP
.\"=====================================================================
.SH NAME
weave \- translate a literate programming WEB to TeX
.SH SYNOPSIS
\f[B]weave\f[R] [\f[B]-p\f[R]] [\f[B]-x\f[R]]
\f[I]webfile\f[R][\f[B].web\f[R]]
[{\f[I]changefile\f[R][\f[B].ch\f[R]]|\f[B]-\f[R]}
[\f[I]outfile\f[R][\f[B].tex\f[R]]]]
.\"=====================================================================
.SH DESCRIPTION
The
.B weave
program creates a \*(TX file for viewing a literate program written in
WEB. 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
The output \*(TX file name is formed by adding
.B .tex
to the root of the WEB file name or from the third argument. In this
case you can specify '-' as an empty change file. These non-option
command line arguments are handled in the same way as
.BR tangle (1).
.PP
There are several macros that probably should be redefined by the
programmer at the beginning of the WEB file. It is a good idea to set
.I \etitle
to the name of the program.
To output only those modules which are changed, one can say
.IR \elet\emaybe=\eiffalse ,
usually as the first change in the change file.
.\"=====================================================================
.SH OPTIONS
See
.BR tex (1)
for details of command-line parsing.
.TP
.B -p
says to \fI\einput pwebmac.tex\fP, a variant on the default
\fIwebmac.tex\fP which is more suited for PDF output.
.TP
.B -x
says to omit the index, module name list, and table of contents pages.
(A
.I CONTENTS.tex
file will still be written when the \*(TX file is processed,
however, unless some macros in
.I webmac.tex
are redefined.)
.PP
The standard
.B -help
and
.B -version
options are also supported.
.\"=====================================================================
.SH ENVIRONMENT
The programs look for the input files using the environment variable
WEBINPUTS. If it is not set, it uses the system default. See the
Kpathsea manual at https://tug.org/kpathsea for the details of the
searching.
.\"=====================================================================
.SH BUGS
The table of contents appears at the end of the output.
.\"=====================================================================
.SH FILES
.TP
.I $TEXMFMAIN/tex/plain/knuth-lib/webmac.tex
\*(TX macros used by
.B weave
output.
.TP
.I $TEXMFMAIN/tex/plain/pwebmac/pwebmac.tex
Alternative
\*(TX macros used for PDF output.
.TP
.I CONTENTS.tex
Temporary file created by \fBweave\fP for the table of contents.
.\"=====================================================================
.SH "SEE ALSO"
.BR tangle (1)
for references, authors, and other information.
.PP
Public discussion list and bug reports: https://lists.tug.org/tex-k