Skip to content

Commit

Permalink
Update package documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
ascherer committed Feb 6, 2022
1 parent 10a9b4f commit 7311029
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,26 @@ output; all these macros can only be used with a specific “TeX engine” each.
The present `pwebmac` package integrates these three WEB macro files similar
to `cwebmac.tex` in Silvio Levy's and Don Knuth's
[CWEB](https://ctan.org/pkg/cweb) system, so `pwebmac.tex` can be used with
“plain TeX,” “pdfTeX,” and “XeTeX” alike.
“plain TeX,” “pdfTeX,” and “XeTeX” alike. And it adds full support for Martin
Ruckert's “[HiTeX](https://ctan.org/pkg/hitex)” engine and its `HINT` output
format.

Its initial application is the production of PDF files for all major WEB
programs for “TeX and friends” as distributed in
Its initial application is the production of PDF and HINT files for all major
WEB programs for “TeX and friends” as distributed in
[TeX Live](https://www.tug.org/texlive). For this purpose, the shell script
`makeall` was whipped together; it provides various commandline options and
works around several “quirks” in the WEB sources. The resulting collection
of PDF documents can be browsed in the `knuth-pdf` package.
of PDF documents can be browsed in the `knuth-pdf` package amd the collection
of HINT documents are available in the `knuth-hint` package.

WEB programmers who want to use `pwebmac.tex` instead of the default
`webmac.tex` in their programs have to change the first line in the TeX file
created by `weave`. From there, all depends on the “TeX engine” you use:
“plain TeX” by default creates DVI output, “plain TeX” with the invocation
`tex "\let\pdf+\input…"`, `pdftex`, and `xetex` create PDF output with
clickable links and bookmarks (depending on your PDF viewer).
clickable links and bookmarks (depending on your PDF viewer), and `hitex`
creates HINT output that can be viewed with the `hintview` program.

The `pwebmac` package is free software and may be used without constraints.

This is version “4.6.4” of the `pwebmac` package — 2021-11-06, Andreas Scherer.
This is version “4.7” of the `pwebmac` package — 2022-02-05, Andreas Scherer.

0 comments on commit 7311029

Please sign in to comment.