Start new section for post-1.0 changes.

[bpt/guile.git] / INSTALL

To build Guile on unix, there are two basic steps:

	1. Configure the package by running the configure script.
	2. Build the package by running make.

Generic instructions for configuring and compiling GNU distributions
are included below.  Here is an illustration of commands that might be
used to build Guile.  The voluminous output of the commands is not shown.

	% tar xvfz guile-snap.tar.gz	# unpack the sources
	% cd guile-snap
	% ./configure
	% make

The `configure' script examines your system, and adapts Guile to
compile and run on it.

The `make' command builds several things:
- An executable file `guile/guile', which is an interactive shell for
  talking with the Guile Scheme interpreter.
- An object library `guile/libguile.a', containing the Guile Scheme
  interpreter, ready to be linked into your programs.
- An object library `gtcltk-lib/libgtcltk.a', containing a simple
  interface between Guile and Tcl/Tk.  This is only built if the
  configure script notices that you have the appropriate version of
  Tcl/Tk installed on your system already.  If it is installed, `make'
  will automatically include Tcl/Tk and the interface in the guile
  shell.  If the interface were documented, we'd include a pointer to
  it here.

To install Guile, type `make install'.  This installs the executable
and libraries mentioned above, as well as Guile's header files and
Scheme libraries.

If you want to run Guile without installing it, set the environment
variable `SCHEME_LOAD_PATH' to a colon-separated list of directories,
including the directory containing this INSTALL file.  For example, if
you unpacked Guile so that the full filename of this file is
`/home/jimb/guile-snap/INSTALL', then you might say

	export SCHEME_LOAD_PATH=/home/jimb/my-scheme:/home/jimb/guile-snap

if you're using Bash or any other Bourne shell variant, or

	setenv SCHEME_LOAD_PATH /home/jimb/my-scheme:/home/jimb/guile-snap

if you're using CSH or one of its variants.


      Generic Instructions for Building Auto-Configured Packages
      ==========================================================


To compile this package:

1.  Configure the package for your system.  In the directory that this
file is in, type `./configure'.  If you're using `csh' on an old
version of System V, you might need to type `sh configure' instead to
prevent `csh' from trying to execute `configure' itself.

The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation, and
creates the Makefile(s) (one in each subdirectory of the source
directory).  In some packages it creates a C header file containing
system-dependent definitions.  It also creates a file `config.status'
that you can run in the future to recreate the current configuration.
Running `configure' takes a minute or two.

To compile the package in a different directory from the one
containing the source code, you must use GNU make.  `cd' to the
directory where you want the object files and executables to go and
run `configure' with the option `--srcdir=DIR', where DIR is the
directory that contains the source code.  Using this option is
actually unnecessary if the source code is in the parent directory of
the one in which you are compiling; `configure' automatically checks
for the source code in `..' if it does not find it in the current
directory.

By default, `make install' will install the package's files in
/usr/local/bin, /usr/local/lib, /usr/local/man, etc.  You can specify
an installation prefix other than /usr/local by giving `configure' the
option `--prefix=PATH'.  Alternately, you can do so by changing the
`prefix' variable in the Makefile that `configure' creates (the
Makefile in the top-level directory, if the package contains
subdirectories).

You can specify separate installation prefixes for machine-specific
files and machine-independent files.  If you give `configure' the
option `--exec_prefix=PATH', the package will use PATH as the prefix
for installing programs and libraries.  Normally, all files are
installed using the same prefix.

`configure' ignores any other arguments that you give it.

If your system requires unusual options for compilation or linking
that `configure' doesn't know about, you can give `configure' initial
values for some variables by setting them in the environment.  In
Bourne-compatible shells, you can do that on the command line like
this:
	CC='gcc -traditional' DEFS=-D_POSIX_SOURCE ./configure

The `make' variables that you might want to override with environment
variables when running `configure' are:

(For these variables, any value given in the environment overrides the
value that `configure' would choose:)
CC		C compiler program.
		Default is `cc', or `gcc' if `gcc' is in your PATH.
INSTALL		Program to use to install files.
		Default is `install' if you have it, `cp' otherwise.
INCLUDEDIR	Directory for `configure' to search for include files.
		Default is /usr/include.

(For these variables, any value given in the environment is added to
the value that `configure' chooses:)
DEFS		Configuration options, in the form '-Dfoo -Dbar ...'
LIBS		Libraries to link with, in the form '-lfoo -lbar ...'

If you need to do unusual things to compile the package, we encourage
you to teach `configure' how to do them and mail the diffs to the
address given in the README so we can include them in the next
release.

2.  Type `make' to compile the package.

3.  Type `make install' to install programs, data files, and
documentation.

4.  You can remove the program binaries and object files from the
source directory by typing `make clean'.  To also remove the
Makefile(s), the header file containing system-dependent definitions
(if the package uses one), and `config.status' (all the files that
`configure' created), type `make distclean'.

The file `configure.in' is used as a template to create `configure' by
a program called `autoconf'.  You will only need it if you want to
regenerate `configure' using a newer version of `autoconf'.