about summary refs log tree commit diff
path: root/INSTALL
diff options
context:
space:
mode:
authorTanaka Akira <akr@users.sourceforge.net>1999-06-08 09:25:39 +0000
committerTanaka Akira <akr@users.sourceforge.net>1999-06-08 09:25:39 +0000
commit805381040dd69dd02b78423d2d71913b33f3cc33 (patch)
tree1fa89ee643e8e577a2f79e76e3d6cafc93256ca2 /INSTALL
parentf42e3fa8e6152e145251e8f16f4c61c23dec1f59 (diff)
downloadzsh-805381040dd69dd02b78423d2d71913b33f3cc33.tar.gz
zsh-805381040dd69dd02b78423d2d71913b33f3cc33.tar.xz
zsh-805381040dd69dd02b78423d2d71913b33f3cc33.zip
zsh-3.1.5-pws-21 zsh-3.1.5-pws-21
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL32
1 files changed, 32 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
index e25ba08b2..c793ff827 100644
--- a/INSTALL
+++ b/INSTALL
@@ -115,6 +115,10 @@ To install the dynamically-loadable modules, do the command:
 To install the zsh man page, do the command:
     make install.man
 
+To install all the shell functions which come with the distribution, do the
+command:
+    make install.fns
+
 Or alternatively, you can install all the above with the command:
     make install
 
@@ -202,6 +206,33 @@ Any startup/shutdown script can be disabled by giving the
 --disable-scriptname option to "configure".  The --disable-etcdir option
 disables all startup/shutdown files which are not explicitely enabled.
 
+Shell functions
+---------------
+
+By default, the shell functions which are installed with `make install' or
+`make install.fns' go into the directory ${datadir}/zsh/functions, which
+unless you have specified --datadir is the same as
+${prefix}/share/zsh/functions ($prefix itself defaults to /usr/local, as
+described below).  This directory will also be compiled into the shell as
+the default directory for the variable $fpath/$FPATH. You can override it
+with --enable-fndir=directory; --disable-fndir or --enable-fndir=no will
+turn off both installation of functions and the setting of a default value
+for $fpath/$FPATH.
+
+You can control the functions which get installed by setting
+FUNCTIONS_INSTALL, either when running configure or when running `make
+install' or `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/*'
+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/*'
+
 Support for large files and integers
 ------------------------------------
 
@@ -269,5 +300,6 @@ Features:
      zlogin=pathname     # the full pathname of the global zlogin script
      zprofile=pathname   # the full pathname of the global zprofile script
      zlogout=pathname    # the full pathname of the global zlogout script
+     fns=directory       # the directory where shell functions will go
      dynamic             # allow dynamically loaded binary modules
      lfs                 # allow configure check for large files