INSTALL

   1 Brief Installation Instructions ===========================================
   2
   3 To build Guile on unix, there are two basic steps:
   4
   5         1. Type "./configure", to configure the package for your system.
   6         2. Type "make", to build the package.
   7
   8 Generic instructions for configuring and compiling GNU distributions
   9 are included below.  For Guile, you might type the commands below.
  10 Their voluminous output is not shown.
  11
  12         $ tar xvfz guile-970416.tar.gz          # unpack the sources
  13         $ cd guile-970416
  14         $ ./configure                           # adapt Guile to your system
  15         $ make                                  # compile Guile
  16         $ make install                          # install in the usual places
  17
  18 (Note: under SunOS 4.1, you may need to say ./configure --disable-shared;
  19 Guile's shared library support for that systems seems to be confused.)
  20
  21 What You Get ==============================================================
  22
  23 The `configure' script examines your system, and adapts Guile to
  24 compile and run on it.
  25
  26 The `make' command builds several things:
  27 - An executable file `guile/guile', which is an interactive shell for
  28   talking with the Guile Scheme interpreter.
  29 - An object library `libguile/.libs/libguile.a', containing the Guile Scheme
  30   interpreter, ready to be linked into your programs.
  31
  32 To install Guile, type `make install'.  This installs the executable
  33 and libraries mentioned above, as well as Guile's header files and
  34 Scheme libraries.
  35
  36 Make also builds shared libraries, on systems that support them.
  37 Because of the nature of shared libraries, before linking against
  38 them, you should probably install them; `make install' takes care of
  39 this.
  40
  41
  42 Flags Accepted by Configure ===============================================
  43
  44 If you run the configure script with no arguments, it should examine
  45 your system and set things up appropriately.  However, there are a few
  46 switches specific to Guile you may find useful in some circumstances.
  47
  48 --enable-maintainer-mode --- If you have automake, autoconf, and
  49 libtool installed on your system, this switch causes configure to
  50 generate Makefiles which know how to automatically regenerate
  51 configure scripts, makefiles, and headers, when they are out of date.
  52 The README file says which versions of those tools you will need.
  53
  54 --with-threads --- Build a Guile executable and library that supports
  55 cooperative threading.  If you use this switch, Guile will also build
  56 and install the QuickThreads non-preemptive threading library,
  57 libqt.a, which you will need to link into your programs after
  58 libguile.a.  That is, you should pass the switches -lguile -qt to your
  59 linker.  Coop threads are not yet thoroughly tested; once they are,
  60 they will be enabled by default.
  61
  62 --enable-dynamic-linking --- Build a Guile executable and library
  63 providing Scheme functions which can load a shared library and
  64 initialize it, perhaps thereby adding new functions to Guile.  This
  65 feature is not yet thoroughly tested; once it is, it will be enabled
  66 by default.  This option has no effect on systems that do not support
  67 shared libraries.
  68
  69 --disable-shared --- Do not build shared libraries.  Normally, Guile
  70 will build shared libraries if your system supports them.  Guile
  71 always builds static libraries.
  72
  73
  74 Using Guile Without Installing It =========================================
  75
  76 If you want to run Guile without installing it, set the environment
  77 variable `SCHEME_LOAD_PATH' to a colon-separated list of directories,
  78 including the directory containing this INSTALL file.  For example, if
  79 you unpacked Guile so that the full filename of this file is
  80 `/home/jimb/guile-snap/INSTALL', then you might say
  81
  82         export SCHEME_LOAD_PATH=/home/jimb/my-scheme:/home/jimb/guile-snap
  83
  84 if you're using Bash or any other Bourne shell variant, or
  85
  86         setenv SCHEME_LOAD_PATH /home/jimb/my-scheme:/home/jimb/guile-snap
  87
  88 if you're using CSH or one of its variants.
  89
  90
  91 Generic Instructions for Building Auto-Configured Packages ================
  92
  93 To compile this package:
  94
  95 1.  Configure the package for your system.  In the directory that this
  96 file is in, type `./configure'.  If you're using `csh' on an old
  97 version of System V, you might need to type `sh configure' instead to
  98 prevent `csh' from trying to execute `configure' itself.
  99
 100 The `configure' shell script attempts to guess correct values for
 101 various system-dependent variables used during compilation, and
 102 creates the Makefile(s) (one in each subdirectory of the source
 103 directory).  In some packages it creates a C header file containing
 104 system-dependent definitions.  It also creates a file `config.status'
 105 that you can run in the future to recreate the current configuration.
 106 Running `configure' takes a minute or two.
 107
 108 To compile the package in a different directory from the one
 109 containing the source code, you must use GNU make.  `cd' to the
 110 directory where you want the object files and executables to go and
 111 run `configure' with the option `--srcdir=DIR', where DIR is the
 112 directory that contains the source code.  Using this option is
 113 actually unnecessary if the source code is in the parent directory of
 114 the one in which you are compiling; `configure' automatically checks
 115 for the source code in `..' if it does not find it in the current
 116 directory.
 117
 118 By default, `make install' will install the package's files in
 119 /usr/local/bin, /usr/local/lib, /usr/local/man, etc.  You can specify
 120 an installation prefix other than /usr/local by giving `configure' the
 121 option `--prefix=PATH'.  Alternately, you can do so by changing the
 122 `prefix' variable in the Makefile that `configure' creates (the
 123 Makefile in the top-level directory, if the package contains
 124 subdirectories).
 125
 126 You can specify separate installation prefixes for machine-specific
 127 files and machine-independent files.  If you give `configure' the
 128 option `--exec_prefix=PATH', the package will use PATH as the prefix
 129 for installing programs and libraries.  Normally, all files are
 130 installed using the same prefix.
 131
 132 `configure' ignores any other arguments that you give it.
 133
 134 If your system requires unusual options for compilation or linking
 135 that `configure' doesn't know about, you can give `configure' initial
 136 values for some variables by setting them in the environment.  In
 137 Bourne-compatible shells, you can do that on the command line like
 138 this:
 139         CC='gcc -traditional' DEFS=-D_POSIX_SOURCE ./configure
 140
 141 The `make' variables that you might want to override with environment
 142 variables when running `configure' are:
 143
 144 (For these variables, any value given in the environment overrides the
 145 value that `configure' would choose:)
 146 CC              C compiler program.
 147                 Default is `cc', or `gcc' if `gcc' is in your PATH.
 148 INSTALL         Program to use to install files.
 149                 Default is `install' if you have it, `cp' otherwise.
 150 INCLUDEDIR      Directory for `configure' to search for include files.
 151                 Default is /usr/include.
 152
 153 (For these variables, any value given in the environment is added to
 154 the value that `configure' chooses:)
 155 DEFS            Configuration options, in the form '-Dfoo -Dbar ...'
 156 LIBS            Libraries to link with, in the form '-lfoo -lbar ...'
 157
 158 If you need to do unusual things to compile the package, we encourage
 159 you to teach `configure' how to do them and mail the diffs to the
 160 address given in the README so we can include them in the next
 161 release.
 162
 163 2.  Type `make' to compile the package.
 164
 165 3.  Type `make install' to install programs, data files, and
 166 documentation.
 167
 168 4.  You can remove the program binaries and object files from the
 169 source directory by typing `make clean'.  To also remove the
 170 Makefile(s), the header file containing system-dependent definitions
 171 (if the package uses one), and `config.status' (all the files that
 172 `configure' created), type `make distclean'.
 173
 174 The file `configure.in' is used as a template to create `configure' by
 175 a program called `autoconf'.  You will only need it if you want to
 176 regenerate `configure' using a newer version of `autoconf'.