diff --git a/racket/src/ChezScheme/BUILDING b/racket/src/ChezScheme/BUILDING index 0ae6505ab4..e1491dd470 100644 --- a/racket/src/ChezScheme/BUILDING +++ b/racket/src/ChezScheme/BUILDING @@ -180,13 +180,16 @@ The makefile supports several targets: * `sudo make install` - Installs the biult executables, boot files, example files, and - manual pages. + Installs the built executables, boot files, example files, and + manual pages. If the `--installprefix` used with "configure" is + writable by the current user, then `sudo` is not necessary. * `sudo make uninstall` Uninstalls the executables, boot files, example files, and manual - pages. + pages. As with `make install`, if the `--installprefix` used with + "configure" is writable by the current user, then `sudo` is not + necessary. * `make test` @@ -237,13 +240,40 @@ The makefile supports several targets: represented in "boot", simply add the appropriate subdirectory as empty or use `make .boot` first. + * `make docs` + + Runs the build plus generates HTML and PDF versions of the Chez + Scheme Users Guide and the release notes. Unlike the other build + targets, the documentation is not built in the workarea, but rather + in the "csug" and "release_notes" directories (where "configure" is + run). + + Building the documentation requires a few prerequisites not required + to build the rest of Chez Scheme. The following must be available + in your PATH: + + * A TeX distribution (including latex, pdflatex, dvips, and gs) + + * ppmtogif and pnmcrop (from Netpbm) + + An X11 installation is not required, but ppmtogif does require an + "rgb.txt" file, which it will automatically locate in the common + X11 installation locations. If ppmtogif fails because it cannot + find an "rgb.txt" file, you can use the `RGBDEF` environment + variable to specify the path to a file. If your system has an Emacs + installation, then you can find an "rgb.txt" file in the "etc" + directory of the emacs installation. If your system has a Vim + installation, then it might contain an "rgb.txt" in the directory + identified by the `VIMRUNTIME` environment variable. + * `make clean` Removes binaries from the workarea. * `make distclean` - Removes "nanopass", "Makefile", and all workareas. + Removes "nanopass", "Makefile", built documentation, and all + workareas. WINDOWS VIA COMMAND PROMPT