head	2.4;
access;
symbols
	3_0_1:2.4
	3_0_0:2.4
	3_0-pre6:2.4
	3_0-pre5:2.4
	3_0-pre4:2.4
	beta15:1.16
	beta14:1.16
	beta13:1.16
	beta12:1.16
	beta11:1.15
	beta10:1.14
	3_0-pre3:2.4
	3_0-pre2:2.3
	3_0-pre1:2.2
	beta21:2.1
	beta20:2.1
	beta19:2.1
	beta18:2.1
	beta17:2.1
	beta16:2.0;
locks;
comment	@# @;


2.4
date	96.07.05.20.46.17;	author hzoli;	state Exp;
branches;
next	2.3;

2.3
date	96.07.04.20.42.58;	author hzoli;	state Exp;
branches;
next	2.2;

2.2
date	96.06.27.00.59.20;	author hzoli;	state Exp;
branches;
next	2.1;

2.1
date	96.05.05.16.26.40;	author hzoli;	state Exp;
branches;
next	2.0;

2.0
date	96.05.02.22.57.04;	author hzoli;	state Exp;
branches;
next	1.16;

1.16
date	95.11.19.04.35.53;	author coleman;	state Exp;
branches;
next	1.15;

1.15
date	95.10.06.05.21.18;	author coleman;	state Exp;
branches;
next	1.14;

1.14
date	95.06.24.05.10.35;	author coleman;	state Exp;
branches;
next	1.13;

1.13
date	95.05.26.09.30.26;	author coleman;	state Exp;
branches;
next	1.12;

1.12
date	95.05.18.09.21.18;	author coleman;	state Exp;
branches;
next	1.11;

1.11
date	95.03.14.01.13.46;	author coleman;	state Exp;
branches;
next	1.10;

1.10
date	95.03.13.01.15.11;	author coleman;	state Exp;
branches;
next	1.9;

1.9
date	95.02.23.09.00.19;	author coleman;	state Exp;
branches;
next	1.8;

1.8
date	95.02.11.08.39.49;	author coleman;	state Exp;
branches;
next	1.7;

1.7
date	95.02.04.03.59.40;	author coleman;	state Exp;
branches;
next	1.6;

1.6
date	94.11.10.04.22.30;	author zsh;	state Exp;
branches;
next	1.5;

1.5
date	94.11.10.02.45.00;	author zsh;	state Exp;
branches;
next	1.4;

1.4
date	94.11.08.06.43.54;	author zsh;	state Exp;
branches;
next	1.3;

1.3
date	94.10.16.23.11.18;	author zsh;	state Exp;
branches;
next	1.2;

1.2
date	94.08.30.04.52.27;	author zsh;	state Exp;
branches;
next	1.1;

1.1
date	94.08.24.02.19.52;	author zsh;	state Exp;
branches;
next	;


desc
@INSTALL
@


2.4
log
@--enable-etcdir is back.  The customized locations are put into the manual
@
text
@$Id: INSTALL,v 2.3 1996/07/04 20:42:58 hzoli Exp $

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.

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.

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

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 zsh man page, do the command:
    make install.man

To install the zsh info files, do the command:
    make install.info

Or alternatively, you can install all the above with the command:
    make install

"make install.info" will only move the info files into the info directory.
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

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 explicitely enabled.


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
@


2.3
log
@replace --enable-etcdir with --enable-{zshenv,zshrc,zlogin, zprofile,zlogout}
@
text
@d1 1
a1 1
$Id: INSTALL,v 2.2 1996/06/27 00:59:20 hzoli Exp $
d138 1
d146 2
a147 1
--disable-scriptname option to "configure".
d183 1
@


2.2
log
@--enable-etcdir added
@
text
@d1 1
a1 1
$Id: INSTALL,v 2.1 1996/05/05 16:26:40 hzoli Exp $
d132 15
d181 5
a185 1
     etcdir=directory    # the directory for the global zsh scripts
@


2.1
log
@added --enable-zsh-debug option
@
text
@d1 1
a1 1
$Id: INSTALL,v 2.1 1996/05/05 10:35:05 hzoli Exp $
d129 1
a129 1
you can use the following options.  This also disables optimization.
d132 1
d166 1
@


2.0
log
@New maintainer: Zoltn Hidvgi <hzoli@@cs.elte.hu>
@
text
@d1 1
a1 1
$Id: INSTALL,v 1.16 1995/11/19 04:35:53 coleman Exp $
d98 1
a98 1
    /usr/local/src/zsh-2.7/configure
d128 4
d159 1
a164 1

@


1.16
log
@Updated everything for GNU autoconf 2.5.  From rc.
@
text
@d1 1
a1 1
$Id: INSTALL,v 1.15 1995/10/06 05:21:18 coleman Exp coleman $
@


1.15
log
@adding more information.  from rc.
@
text
@d1 1
a1 1
$Id: INSTALL,v 1.14 1995/06/24 05:10:35 coleman Exp coleman $
d130 4
a133 2
The "configure" program accepts the following options.  To get the
complete list of configure options, run "./configure --help".
d142 1
a142 1
Directory and file name:
d144 4
a147 1
  --exec-prefix=PREFIX   # install host dependent files in PREFIX [same as prefix]
@


1.14
log
@*** empty log message ***
@
text
@d1 1
a1 1
$Id: INSTALL,v 1.13 1995/05/26 09:30:26 coleman Exp coleman $
d3 2
a4 2
Configuring Zsh
---------------
d7 2
a8 2
for your particular architecture.  Most will not require any special
instructions.
d10 2
d13 1
a13 1
    ./configure                 # check below for possible options
d19 13
a31 5
By default, configure will use the "gcc" compiler if found.  If you
wish to use a different compiler, or need to add unusual options for
compiling or linking that the "configure" script does not know about,
you can give "configure" initial values for variables by setting them in
the environment.  Using a Bourne-compatible shell (such as sh,ksh,zsh),
d38 14
a51 5
Configure will probe your system and create a "config.h" header
file and various Makefiles.  Look over the #define's in config.h.
In particular, you should examine the user configuration section and
the values (determined by configure) of HOSTTYPE, OSTYPE, MACHTYPE, and
VENDOR to make sure they are correct.
@


1.13
log
@*** empty log message ***
@
text
@d1 1
a1 1
$Id: INSTALL,v 1.12 1995/05/18 09:21:18 coleman Exp $
d36 1
a36 1
After configuring, to build zsh, do:
d78 1
a78 1
    cd /usr/local/work
d83 1
a83 1
-------------------------
d85 23
a107 10
which reduce memory usage on some systems. To use these, add the following
options to "configure",

 --enable-zsh-mem           # use zsh's memory allocators
 --enable-zsh-mem-debug     # debug zsh's memory allocators
 --enable-zsh-mem-warning   # turn on warnings of memory allocation errors
 --enable-zsh-secure-free   # turn on memory checking of free()

You should check Etc/MACHINES to find recommendations about using these
on certain architectures.
d135 1
@


1.12
log
@*** empty log message ***
@
text
@d1 1
a1 1
$Id: INSTALL,v 1.11 1995/03/14 01:13:46 coleman Exp coleman $
d3 1
a3 1
CONFIGURING ZSH
d5 3
a7 3
Look in the file ./Etc/MACHINES to see the architectures that zsh
has been tested on, as well as any special instructions for your
particular architecture.  Most architectures will not require any special
d34 1
a34 2

COMPILING ZSH
d39 1
a39 2

INSTALLING ZSH
d60 1
a60 2

BUILDING ZSH ON ADDITIONAL ARCHITECTURES
d68 1
a68 2

USING A DIFFERENT BUILD DIRECTORY
d82 1
a82 2

MEMORY ROUTINES
d93 2
a94 3
You should check ./Etc/MACHINES to find recommendations about using
these on certain architectures.

d96 1
a96 1
OPTIONS FOR CONFIGURE
@


1.11
log
@*** empty log message ***
@
text
@d1 1
a1 3
#
# $Id: INSTALL,v 1.10 1995/03/13 01:15:11 coleman Exp coleman $
#
@


1.10
log
@*** empty log message ***
@
text
@d2 1
a2 1
# $Id$
d7 4
a10 4
Look in the file ./Etc/MACHINES to see the architectures that zsh has
been tested on, as well as any special instructions for your
particular architecture.  Most architectures will not require
any special instructions.
d22 2
a23 2
you can give "configure" initial values for variables by setting them
in the environment.  Using a Bourne-compatible shell (such as sh,ksh,zsh),
d30 2
a31 2
Configure will probe your system and create a "config.h" header file and
various Makefiles.  Look over the #define's in config.h.
d33 2
a34 2
the values (determined by configure) of HOSTTYPE, OSTYPE, MACHTYPE,
and VENDOR to make sure they are correct.
d45 2
a46 2
If no make/compilation errors occur, then to install
the zsh binary, do the command:
d60 3
a62 4
"make install.info" will only move the info files into the
info directory.  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.
d76 7
a82 8
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,
d91 3
a93 3
Included in this release are alternate malloc and associated
functions which reduce memory usage on some systems. To use these,
add the following options to "configure",
d106 2
a107 2
The "configure" program accepts the following options.  To get the complete
list of configure options, run "./configure --help".
@


1.9
log
@*** empty log message ***
@
text
@d1 3
a3 4

# $Revision: 1.9 $
# $Date: 1995/02/20 04:14:19 $

d95 1
a95 1
add the following options to "sh configure",
@


1.8
log
@*** empty log message ***
@
text
@d2 2
a3 2
# $Revision: 1.7 $
# $Date: 1995/02/04 03:59:40 $
d5 3
a7 2
INSTALLING ZSH
--------------
d14 1
d16 11
a26 1
./configure                 # check below for possible options
d28 2
a29 2
Configure accepts several options (explained below).  Also,
"./configure --help" will display available configure options.
d37 3
d41 1
a42 1
make
d44 10
a53 4
If no make/compilation errors occur, then:

make install.bin            # this will install the zsh binary.
                            # previous version will be renamed zsh.old
d55 2
a56 2
make install.man            # this will install the zsh man page.
make install.info           # this will install the zsh info files.
d58 2
a59 3
or you can just do:

make install                # this will install all of the above.
d66 24
a89 2
To build zsh on additional architectures, you can do a "make distclean"
and run "./configure" again.
@


1.7
log
@*** empty log message ***
@
text
@d2 2
a3 2
## $Revision$
## $Date$
@


1.6
log
@*** empty log message ***
@
text
@d1 3
a3 1
## $Id$ ##
@


1.5
log
@made changes for autconf 2.0/2.1
@
text
@d1 1
@


1.4
log
@*** empty log message ***
@
text
@d4 5
d11 4
a14 1
sh configure                # check below for possible options
d16 1
a16 1
This will probe your system and create a "config.h" header file and
d22 1
a22 1
Then to build zsh, do:
d26 1
a26 1
If no errors occur, then:
a42 4
Look in the file ./Etc/MACHINES to see the architectures that zsh has
been tested on, as well as any special instructions for your
particular architecture.

d44 1
a44 1
and run "sh configure" again.
d64 2
a65 1
The "configure" program accepts the following options:
d67 15
a81 9
 --help                # print help message
 --verbose             # print the results of checks
 --version             # print version of autoconf that create configure
 --prefix=PREFIX       # install host independent files in PREFIX [/usr/local]
 --exec-prefix=PREFIX  # install host dependent files in PREFIX [/usr/local]
 --srcdir=DIR          # find the sources in DIR [./src]
 --quiet, --silent     # do not print `checking for ...' messages
 --enable-FEATURE      # enable use of this feature
 --disable-FEATURE     # disable use of this feature
d84 4
a87 5
     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()

@


1.3
log
@beta1
@
text
@d35 1
a35 1
Look in the file ./etc/MACHINES to see the architectures that zsh has
d45 2
a46 2
Included in this release are alternative malloc and associated
functions which reduce memory usage on some systems. To use this,
d54 1
a54 1
You should check ./etc/MACHINES to find recommendations about using
d72 1
a72 1
     The FEATURES supported currently are:
@


1.2
log
@*** empty log message ***
@
text
@d6 1
a6 1
./configure                  # check below for possible options
d9 4
a12 4
various Makefiles.  Look over the user configuration section of
config.h.  At the very least, you will want to change the value of
'#define HOSTTYPE' to correspond to your system.  A generic value
such as "sun4", or "hpux" is ok.
d40 1
a40 1
and run "./configure" again.
d47 1
a47 1
add the following options to ./configure:
d52 1
a52 1
 --enable-secure-free       # turn on memory checking of free()
@


1.1
log
@Initial revision
@
text
@a1 10
AUTOCONF WORK STILL IN PROGRESS
-------------------------------
The new install procedures for zsh are still being
work on.  Check the file NOT-DONE for things that
might need to be done manually.  Eventually all these
problems will disappear.  The rest of this file will then
become the only document necessary to install zsh.



d8 5
a12 2
This will probe your system and create a config.h header file and
Makefiles.  You might want to check these files.
@
