diff options
| -rw-r--r-- | ChangeLog | 5 | ||||
| -rw-r--r-- | INSTALL | 20 |
2 files changed, 25 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog index 61f242b4a..f6e9868a6 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2013-12-09 Peter Stephenson <p.w.stephenson@ntlworld.com> + + * 32093: INSTALL: describe the dependency issues fixed + by the doc bundle. + 2013-12-09 Peter Stephenson <p.stephenson@samsung.com> * Jun T.: 32056: Completion/Unix/Command/_iconv: Handle 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 ------------------- |