diff options
| author | Peter Stephenson <p.w.stephenson@ntlworld.com> | 2013-12-09 21:23:02 +0000 |
|---|---|---|
| committer | Peter Stephenson <p.w.stephenson@ntlworld.com> | 2013-12-09 21:23:02 +0000 |
| commit | 4864e3529cba959ac95924e52c6c1d5a157c4ae2 (patch) | |
| tree | 6b7bc23e7509142846ac34c87a8c431ef3c3b8ac /INSTALL | |
| parent | 82cf0f59409fe07a5b23157e23dc778e755bad40 (diff) | |
| download | zsh-4864e3529cba959ac95924e52c6c1d5a157c4ae2.tar.gz zsh-4864e3529cba959ac95924e52c6c1d5a157c4ae2.tar.xz zsh-4864e3529cba959ac95924e52c6c1d5a157c4ae2.zip | |
32093: describe the dependency issues fixed by the doc bundle
Diffstat (limited to 'INSTALL')
| -rw-r--r-- | INSTALL | 20 |
1 files changed, 20 insertions, 0 deletions
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 ------------------- |