From 4864e3529cba959ac95924e52c6c1d5a157c4ae2 Mon Sep 17 00:00:00 2001 From: Peter Stephenson Date: Mon, 9 Dec 2013 21:23:02 +0000 Subject: 32093: describe the dependency issues fixed by the doc bundle --- INSTALL | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'INSTALL') diff --git a/INSTALL b/INSTALL index f4b09e06a..00791cd86 100644 --- a/INSTALL +++ b/INSTALL @@ -13,6 +13,26 @@ instructions in the first. MAKING AND INSTALLING ===================== +Dependencies +------------ + +The main shell can be compiled with tools available on a typical +Unix-like system including development packages. However, the +documentation requires various additional tools that are not so standard: + +- YODL, for turning the documentation source files (.yo) into manual +pages and TeXinfo source for producing PDF and .info formats; + +- Perl and interactive manual tools, for turning the zshbuiltins(1) +manual into help files that can be displayed by the run-help function. +For example, the colcrt or col tool, not typically required for +installing software, must be available. + +To avoid needing these, the source distribution is supplemented by a +documentation distribution that may be downloaded from the same place as +the source. This provides fully generated documentation with references +to files in the default locations. + Check MACHINES File ------------------- -- cgit 1.4.1