zsh-3.1.6-test-1 zsh-3.1.6-test-1

1 files changed, 57 insertions, 27 deletions

diff --git a/INSTALL b/INSTALL
index 569246e92..b8eaa561c 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,6 +1,15 @@
---------------
-INSTALLING ZSH
---------------
+                        ++++++++++++++
+                        INSTALLING ZSH
+                        ++++++++++++++
+
+This file is divided into two parts:  making and installing the shell, and
+a description of various additional configuration options.  You should
+have a look at the items in the second part before following the
+instructions in the first.
+
+=====================
+MAKING AND INSTALLING
+=====================
 
 Check MACHINES File
 -------------------
@@ -27,15 +36,18 @@ top level Makefile.
 Dynamic loading
 ---------------
 
-Zsh-3.1 has support for dynamically loadable modules.  To enable this run
-configure with the --enable-dynamic option.  Note that dynamic loading
-does not work on all systems.  On these systems this option will have no
-effect, so it is always safe to use --enable-dynamic.  When dynamic
-loading is enabled, major parts of zsh (including the Zsh Line Editor) are
-compiled into modules and not included into the main zsh binary.  Zsh
-autoloads these modules when they are required.  This means that you have
-to execute make install.modules before you try the newly compiled zsh
-executable.
+Zsh-3.1 has support for dynamically loadable modules.  This is now enabled
+by default; to disable it, run configure with the --disable-dynamic option.
+Note that dynamic loading does not work on all systems.  On these systems
+this option will have no effect.  When dynamic loading is enabled, major
+parts of zsh (including the Zsh Line Editor) are compiled into modules and
+not included into the main zsh binary.  Zsh autoloads these modules when
+they are required.  This means that you have to execute make
+install.modules before you try the newly compiled zsh executable, and hence
+also the install paths must be correct.  The installation path for modules
+is EPREFIX/lib/zsh/<zsh-version-number>, where EPREFIX defaults to PREFIX
+unless given explicitly, and PREFIX defaults to /usr/local.  See the end of
+this file for options to configure to change these.
 
 Adding more modules
 -------------------
@@ -156,6 +168,11 @@ source code in the directory that "configure" is in.  For example,
     /usr/local/src/zsh-3.0/configure
     make
 
+
+=====================
+CONFIGURATION OPTIONS
+=====================
+
 Memory Routines
 ---------------
 
@@ -225,31 +242,44 @@ FUNCTIONS_INSTALL, either when running configure (e.g.
 `make install.fns'.  It includes a list of files relative to either the
 Completion or Functions subdirectories.  By default, all the functions for
 the Completion system will be installed (see the zshcompsys manual page),
-i.e.
-  FUNCTIONS_INSTALL='Core/* Base/* Builtins/* User/* Commands/*'
+plus those provide functions for the line editor, i.e.
+  FUNCTIONS_INSTALL='Core/* Base/* Builtins/* User/* Commands/* Zle/*'
 and if the --enable-dynamic option was given, the functions in
 Functions/Zftp, which require the zftp module to be available (see the
 zshzftpsys manual page), will be included as well.  There are also some
 miscellaneous functions with documentation in comments; the complete set
 of functions can be installed with
-  FUNCTIONS_INSTALL='Core/* Base/* Builtins/* User/* Commands/* Misc/* Zftp/*'
-
-You can also set --enable-function-subdirs to allow shell
-functions to be installed into subdirectories of the function directory,
-i.e. `Core/*' files will be installed into `FNDIR/Core', and so on.
-This also initialises $fpath/$FPATH appropriately.
+  FUNCTIONS_INSTALL='Core/* Base/* Builtins/* User/* Commands/* \
+  Misc/* Zftp/* Zle/*'
+Note you should set this by hand to include `Zftp/*' if you have zftp
+compiled into a statically linked shell.
+
+You can also use the configure option --enable-function-subdirs to allow
+shell functions to be installed into subdirectories of the function
+directory, i.e. `Core/*' files will be installed into `FNDIR/Core', and so
+on. This also initialises $fpath/$FPATH appropriately.
+
+On installation, any completion function which already exists but is
+different from the new version will be moved to a corresponding place in
+FNDIR.old; for example, if a different version of User/_rcs exists when
+installing into /usr/local/share/zsh/functions/User, the old one will be
+moved into /usr/local/share/zsh/functions.old/User.  The installer is
+responsible for recovering or deleting old functions which have been moved
+in this way.  On uninstallation, any newly installed functions (including
+those which existed before but were unchanged) will be deleted and the
+files in the FNDIR.old hierarchy moved back into FNDIR.  To preserve the
+entire old hierarchy, you should move or copy it before installation.
 
 Support for large files and integers
 ------------------------------------
 
 Some 32-bit systems allow special compilation modes to get around the 2GB
-file size barrier; the zsh support for this is still experimental, and
-feedback is particularly appreciated.  The option --enable-lfs turns on the
-configure check for support for large files.  Not all systems recognize the
-test used by zsh (via the getconf command), so flags may need to be set by
-hand, but --enable-lfs should be used in any case to compile in the code
-for using 64 bit integers.  On HP-UX 10.20, zsh has been successfully
-compiled with large file support by configuring with
+file size barrier.  The option --enable-lfs turns on the configure check
+for support for large files.  This is now enabled by default; use
+--disable-lfs to turn it off.  Not all systems recognize the test used by
+zsh (via the getconf command), so flags may need to be set by hand.  On
+HP-UX 10.20, zsh has been successfully compiled with large file support by
+configuring with
   CC="cc -Ae" CPPFLAGS="-D_LARGEFILE_SOURCE -D_FILE64" configure \
   --enable-lfs ...
 You can also give a value to --enable-lfs, which will be interpreted as the