next up previous contents
Next: Generating HTML Up: Introduction Previous: The Minor Commands

Running Nuweb

Nuweb is invoked using the following command:

nuweb flags file-name...
One or more files may be processed at a time. If a file name has no extension, .w will be appended. LaTeX suitable for translation into HTML by LaTeX2HTML will be produced from files whose name ends with .hw, otherwise, ordinary LaTeX will be produced. While a file name may specify a file in another directory, the resulting documentation file will always be created in the current directory. For example,
nuweb /foo/bar/quux
will take as input the file /foo/bar/quux.w and will create the file quux.tex in the current directory.

By default, nuweb performs both tangling and weaving at the same time. Normally, this is not a bottleneck in the compilation process; however, it's possible to achieve slightly faster throughput by avoiding one or another of the default functions using command-line flags. There are currently three possible flags:

-t
Suppress generation of the documentation file.
-o
Suppress generation of the output files.
-c
Avoid testing output files for change before updating them.

Thus, the command
nuweb -to /foo/bar/quux
would simply scan the input and produce no output at all.

There are two additional command-line flags:

-v
For ``verbose,'' causes nuweb to write information about its progress to stderr.
-n
Forces scraps to be numbered sequentially from 1 (instead of using page numbers). This form is perhaps more desirable for small webs.



Marc Mengel
Mon Apr 28 09:56:18 CDT 1997