mirror of
https://github.com/zsh-users/zsh
synced 2024-09-06 00:14:40 +00:00
389 lines
18 KiB
Plaintext
389 lines
18 KiB
Plaintext
++++++++++++++
|
|
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
|
|
-------------------
|
|
|
|
Check the file MACHINES in the subdirectory Etc to see the architectures
|
|
that zsh is known to compile on, as well as any special instructions
|
|
for your particular architecture. Most architectures will not require any
|
|
special instructions.
|
|
|
|
Pre-configuration
|
|
-----------------
|
|
|
|
If you are using a normal source release, skip this section.
|
|
|
|
If the `configure' script does not already exist -- e.g., if you've got
|
|
a snapshot of the bare sources just checked out from a CVS repository
|
|
-- some things need to be built before the configuration can proceed.
|
|
Run the script `./Util/preconfig' to do this.
|
|
|
|
Configuring Zsh
|
|
---------------
|
|
|
|
To configure zsh, from the top level directory, do the command:
|
|
./configure
|
|
|
|
Configure accepts several options (explained below). To display
|
|
currently available options, do the command:
|
|
./configure --help
|
|
|
|
Most of the interesting configuration options can be added after running
|
|
configure by editing the user configuration section of config.h and the
|
|
top level Makefile.
|
|
|
|
Dynamic loading
|
|
---------------
|
|
|
|
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 and removing modules
|
|
---------------------------
|
|
|
|
The zsh distribution contains several modules, in the Src/Builtins,
|
|
Src/Modules and Src/Zle directories. If you have any additional zsh
|
|
modules that you wish to compile for this version of zsh, create another
|
|
subdirectory of the Src directory and put them there. You can create
|
|
as many extra subdirectories as you need, but currently configure will only
|
|
search in immediate subdirectories of Src. The subdirectories must be
|
|
actual directories; symbolic links will not work. You will then need to
|
|
rerun configure; the easiest way is to run `config.status --recheck' from
|
|
the top-level build directory which retains the existing configuration as
|
|
much as possible.
|
|
|
|
The key to the module system is the file config.modules, created in the
|
|
configuration process. Each module has a line in the file. It may be
|
|
edited to change the following values for each module; be careful to retain
|
|
the (strict) format for the file:
|
|
link - `dynamic', if the module is to be dynamically linked -- meaningless
|
|
if this is not available on your system.
|
|
`static' if the module is to be linked directly into the executable.
|
|
`no' if the module is not to be linked at all. In this case it will
|
|
not even be compiled.
|
|
load - `yes' if the module is to be visible to the user. This will make
|
|
builtins, parameters etc. visible to the user without any need
|
|
to use the zmodload builtin.
|
|
`no' if an explicit zmodload command is to be required to load the
|
|
utilities in the module. Note that this applies both to
|
|
statically and dynamically linked modules.
|
|
auto - `yes' if the entry is to be regenerated whenever configure is run.
|
|
`no' if you wish to retain your hand-edited version.
|
|
Do not edit the entry for the pseudo-module zsh/main, which is the main
|
|
shell. After you have edited this file, run `make prep' in the Src
|
|
subdirectory.
|
|
|
|
By default the complete, compctl, zle, computil, complist, sched, parameter,
|
|
zleparameter and rlimits modules are compiled into non-dynamic zsh and no
|
|
modules are compiled into the main binary if dynamic loading is available.
|
|
|
|
Note that the modules depending on zle or complete (e.g.: complist and
|
|
deltochar) cannot be loaded dynamically on systems which do not allow symbols
|
|
in one dynamically loaded library to be visible from another; this is true,
|
|
for example, of version 4 of SunOS. The most convenient workaround is to
|
|
compile zle and complete into the base executable by setting their `link'
|
|
entries in config.modules to `static' as described above.
|
|
|
|
Compiler Options or Using a Different Compiler
|
|
----------------------------------------------
|
|
|
|
By default, configure will use the "gcc" compiler if found. You can use a
|
|
different compiler, or add unusual options for compiling or linking that
|
|
the "configure" script does not know about, by either editing the user
|
|
configuration section of the top level Makefile (after running configure)
|
|
or giving "configure" initial values for these variables by setting them
|
|
in the environment. Using a Bourne-compatible shell (such as sh,ksh,zsh),
|
|
|
|
you can do that on the command line like this:
|
|
CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
|
|
|
|
Or on systems that have the "env" program, you can do it like this:
|
|
env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
|
|
|
|
The flags CFLAGS, CPPFLAGS, LDFLAGS and LIBS can also be set as flags to
|
|
configure, where the name appears in lower case:
|
|
configure --enable-cflags=-O2 --enable-libs=-lposix
|
|
|
|
The advantage of this form is that `config.status --recheck' will remember
|
|
the flags you originally specified. You can still override the flags when
|
|
running `make' (although these will not be passed down via `config.status
|
|
--recheck').
|
|
|
|
Check Generated Files
|
|
---------------------
|
|
|
|
Configure will probe your system and create a "config.h" header file.
|
|
You should check the user configuration section at the beginning of
|
|
this include file. You should also examine the values (determined by
|
|
configure) of HOSTTYPE, OSTYPE, MACHTYPE, and VENDOR to make sure they
|
|
are correct. The value of these #defines's is used only to initialize
|
|
the corresponding default shell parameters. Since these shell parameters
|
|
are only for informational purposes, you can change them to whatever
|
|
you feel is appropriate.
|
|
|
|
Also configure will create a Makefile in the top level directory as well
|
|
as in the various subdirectories. You should check the user configuration
|
|
section of the top level Makefile.
|
|
|
|
Compiling Zsh
|
|
-------------
|
|
|
|
After configuring, to build zsh, do the command:
|
|
make
|
|
|
|
Installing Zsh
|
|
--------------
|
|
|
|
If no make/compilation errors occur, then to install the zsh binary, do
|
|
the command:
|
|
make install.bin
|
|
|
|
Any previous copy of zsh will be renamed "zsh.old"
|
|
|
|
To install the dynamically-loadable modules, do the command:
|
|
make install.modules
|
|
|
|
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
|
|
|
|
To install the zsh info files (this must be done separately), do the
|
|
command:
|
|
make install.info
|
|
|
|
If the programme install-info is available, "make install.info" will
|
|
insert an entry in the file "dir" in the same directory as the info
|
|
files. Otherwise you will have to edit the topmost node of the info
|
|
tree "dir" manually in order to have the zsh info files available to
|
|
your info reader.
|
|
|
|
Building Zsh On Additional Architectures
|
|
----------------------------------------
|
|
|
|
To build zsh on additional architectures, you can do a "make distclean".
|
|
This should restore the zsh source distribution back to its original
|
|
state. You can then configure zsh as above on other architectures in
|
|
which you wish to build zsh. Or alternatively, you can use a different
|
|
build directory for each architecture.
|
|
|
|
Using A Different Build Directory
|
|
---------------------------------
|
|
|
|
You can compile the zsh in a different directory from the one containing
|
|
the source code. Doing so allows you to compile it on more than one
|
|
architecture at the same time. To do this, you must use a version of
|
|
"make" that supports the "VPATH" variable, such as GNU "make". "cd" to
|
|
the directory where you want the object files and executables to go and
|
|
run the "configure" script. "configure" automatically checks for the
|
|
source code in the directory that "configure" is in. For example,
|
|
|
|
cd /usr/local/SunOS/zsh
|
|
/usr/local/src/zsh-3.0/configure
|
|
make
|
|
|
|
|
|
=====================
|
|
CONFIGURATION OPTIONS
|
|
=====================
|
|
|
|
Memory Routines
|
|
---------------
|
|
|
|
Included in this release are alternate malloc and associated functions
|
|
which reduce memory usage on some systems. To use these, add the option
|
|
--enable-zsh-mem
|
|
when invoking "configure".
|
|
|
|
You should check Etc/MACHINES to see if there are specific recommendations
|
|
about using the zsh malloc routines on your particular architecture.
|
|
|
|
Debugging Routines
|
|
------------------
|
|
|
|
You can turn on various debugging options when invoking "configure".
|
|
|
|
To turn on some extra checking in the memory management routines, you
|
|
can use the following options when invoking "configure".
|
|
--enable-zsh-mem-warning # turn on warnings of memory allocation errors
|
|
--enable-zsh-secure-free # turn on memory checking of free()
|
|
|
|
If you are using zsh's memory allocation routines (--enable-zsh-mem), you
|
|
can turn on debugging of this code. This enables the builtin "mem".
|
|
--enable-zsh-mem-debug # debug zsh's memory allocators
|
|
|
|
You can turn on some debugging information of zsh's internal hash tables.
|
|
This enables the builtin "hashinfo".
|
|
--enable-zsh-hash-debug # turn on debugging of internal hash tables
|
|
|
|
To add some sanity checks and generate debugging information for debuggers
|
|
you can use the following option. This also disables optimization.
|
|
--enable-zsh-debug # use it if you want to debug zsh
|
|
|
|
Startup/shutdown files
|
|
----------------------
|
|
|
|
Zsh has several startup/shutdown files which are in /etc by default. This
|
|
can be overriden using one of the options below when invoking "configure".
|
|
|
|
--enable-etcdir=directory # default directory for global zsh scripts
|
|
--enable-zshenv=pathname # the full pathname of the global zshenv script
|
|
--enable-zshrc=pathname # the full pathname of the global zshrc script
|
|
--enable-zlogin=pathname # the full pathname of the global zlogin script
|
|
--enable-zprofile=pathname # the full pathname of the global zprofile script
|
|
--enable-zlogout=pathname # the full pathname of the global zlogout script
|
|
|
|
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 explicitly 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/$ZSH_VERSION/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. Note the presence of
|
|
$ZSH_VERSION (e.g. `3.1.7') to avoid clashes between versions of zsh.
|
|
If you only run one version of zsh at once, installing into a common
|
|
directory such as /usr/local/share/zsh/functions is fine --- note, however,
|
|
that uninstallation is more likely to create problems in this case.
|
|
|
|
The functions to be installed are controlled by config.modules. These
|
|
appear at the end of the line after `functions=': note that the rest of the
|
|
line is taken verbatim as shell command line text, i.e. no quoting is used
|
|
around the value as a whole and unquoted wildcards will be expanded. To
|
|
prevent any functions from being installed, either remove the `functions='
|
|
entry or delete the reset of the line after it.
|
|
|
|
Functions not specific to a particular module are listed on the zsh/main
|
|
line. None of these are crucial to shell operation, so you may choose not
|
|
to install them. For other modules, the functions will be installed if and
|
|
only if the module itself is installed. This will usually be what you
|
|
want; in particular, the zsh/complete and zsh/zftp modules are of much less
|
|
use without the associated functions. The functions listed with zsh/zle
|
|
are optional. however.
|
|
|
|
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.
|
|
|
|
The option --enable-site-fndir controls whether to create and initialise
|
|
$fpath to include a directory for site-specific functions. By default this
|
|
is created in the location ${datadir}/zsh/site-functions, i.e. parallel to
|
|
the version-specific functions directory, and inserted at the start of the
|
|
$fpath array on shell startup. This directory will not be affected by
|
|
`make uninstall' or `make uninstall.fns', although the version-specific
|
|
directory and its contents will be deleted.
|
|
|
|
Support for large files and integers
|
|
------------------------------------
|
|
|
|
Some 32-bit systems allow special compilation modes to get around the 2GB
|
|
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
|
|
name of a 64-bit integer type, for example --enable-lfs="long long"
|
|
(although this type is checked for anyway).
|
|
|
|
Furthermore, use of --enable-lfs will also enable 64-bit arithmetic for
|
|
shell parameters, and anywhere they are used such as in mathematical
|
|
formulae. This depends only on the shell finding a suitable 64-bit integer
|
|
type; it does not require that support for large files is actually
|
|
enabled. Hence you might consider using --enable-lfs on any 32-bit system
|
|
with a suitable compiler such as gcc.
|
|
|
|
Also note that if `configure' finds out that either of the types off_t or
|
|
ino_t are 64-bit quantities, but that long integers are only 32 bits, all
|
|
the above will be enabled automatically. This is necessary to ensure
|
|
correct handling of these types.
|
|
|
|
None of this is relevant for 64-bit systems; zsh should compile and run
|
|
without problems if (sizeof(long) == 8).
|
|
|
|
Options For Configure
|
|
---------------------
|
|
|
|
The `configure' program accepts many options, not all of which are useful
|
|
or relevant to zsh. To get the complete list of configure options, run
|
|
"./configure --help". The following list should contain most of the
|
|
options of interest for configuring zsh.
|
|
|
|
Configuration:
|
|
--cache-file=FILE # cache test results in FILE
|
|
--help # print a help message
|
|
--version # print the version of autoconf that create configure
|
|
--quiet, --silent # do not print `checking...' messages
|
|
--no-create # do not create output files
|
|
|
|
Directories:
|
|
--prefix=PREFIX # install host independent files in PREFIX [/usr/local]
|
|
--exec-prefix=EPREFIX # install host dependent files in EPREFIX [same as prefix]
|
|
--bindir=DIR # install user executables in DIR [EPREFIX/bin]
|
|
--infodir=DIR # install info documentation in DIR [PREFIX/info]
|
|
--mandir=DIR # install man documentation in DIR [PREFIX/man]
|
|
--srcdir=DIR # find the sources in DIR [configure dir or ..]
|
|
|
|
Features:
|
|
--enable-FEATURE # enable use of this feature
|
|
--disable-FEATURE # disable use of this feature
|
|
|
|
The FEATURES currently supported are:
|
|
zsh-debug # use it if you want to debug zsh
|
|
zsh-mem # use zsh's memory allocators
|
|
zsh-mem-debug # debug zsh's memory allocators
|
|
zsh-mem-warning # turn on warnings of memory allocation errors
|
|
zsh-secure-free # turn on memory checking of free()
|
|
zsh-hash-debug # turn on debugging of internal hash tables
|
|
etcdir=directory # default directory for global zsh scripts
|
|
zshenv=pathname # the full pathname of the global zshenv script
|
|
zshrc=pathname # the full pathname of the global zshrc script
|
|
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
|
|
fndir=directory # the directory where shell functions will go
|
|
site-fndir=directory# the directory where site-specific functions can go
|
|
function-subdirs # if functions will be installed into subdirectories
|
|
omit-modules=mod1,..# don't compile nor install the modules named mod1,...
|
|
dynamic # allow dynamically loaded binary modules
|
|
lfs # allow configure check for large files
|
|
locale # allow use of locale library
|