INSTALL

   1 Guile Installation Guide
   2 Copyright (c) 1996, 1997, 1998, 1999, 2000 Free software Foundation, Inc.
   3
   4    Permission is granted to anyone to make or distribute verbatim copies
   5    of this document as received, in any medium, provided that the
   6    copyright notice and permission notice are preserved,
   7    and that the distributor grants the recipient permission
   8    for further redistribution as permitted by this notice.
   9
  10    Permission is granted to distribute modified versions
  11    of this document, or of portions of it,
  12    under the above conditions, provided also that they
  13    carry prominent notices stating who last changed them,
  14    and that any new or changed statements about the activities
  15    of the Free Software Foundation are approved by the Foundation.
  16
  17
  18 Brief Installation Instructions ===========================================
  19
  20 To build Guile on unix, there are two basic steps:
  21
  22         1. Type "./configure", to configure the package for your system.
  23         2. Type "make", to build the package.
  24
  25 Generic instructions for configuring and compiling GNU distributions
  26 are included below.  (For instructions how to install SLIB, the scheme
  27 procedure library, see below.)
  28
  29
  30 Special Instructions For Some Systems =====================================
  31
  32 We would like Guile to build on all systems using the simple
  33 instructions above, but it seems that a few systems still need special
  34 treatment.  If you can send us fixes for these problems, we'd be
  35 grateful.
  36
  37 SunOS 4.1: Guile's shared library support seems to be confused, but
  38     hey; shared libraries are confusing.  You may need to configure
  39     Guile with a command like:
  40         ./configure --disable-shared
  41     For more information on `--disable-shared', see below, "Flags
  42     Accepted by Configure".
  43
  44 HP/UX: GCC 2.7.2 (and maybe other versions) have trouble creating
  45     shared libraries if they depend on any non-shared libraries.  GCC
  46     seems to have other problems as well.  To work around this, we
  47     suggest you configure Guile to use the system's C compiler:
  48         CC=cc ./configure
  49
  50 NetBSD: Perry Metzger says, "Guile will build under NetBSD only using
  51     gmake -- the native make will not work.  (gmake is in our package
  52     system, so this will not be a problem when we packagize 1.3.)"
  53
  54
  55 Flags Accepted by Configure ===============================================
  56
  57 If you run the configure script with no arguments, it should examine
  58 your system and set things up appropriately.  However, there are a few
  59 switches specific to Guile you may find useful in some circumstances.
  60
  61
  62 --enable-maintainer-mode
  63
  64   If you have automake, autoconf, and libtool installed on your
  65   system, this switch causes configure to generate Makefiles which
  66   know how to automatically regenerate configure scripts, makefiles,
  67   and headers, when they are out of date.  The README file says which
  68   versions of those tools you will need.
  69
  70
  71 --with-threads  ---  Build with thread support
  72
  73   Build a Guile executable and library that supports cooperative
  74   threading.  If you use this switch, Guile will also build and
  75   install the QuickThreads non-preemptive threading library,
  76   libqthreads, which you will need to link into your programs after
  77   libguile.  When you use `guile-config', you will pick up all
  78   neccessary linker flags automatically.
  79
  80   Cooperative threads are not yet thoroughly tested; once they are,
  81   they will be enabled by default.  The interaction with blocking I/O
  82   is pretty ad hoc at the moment.  In our experience, bugs in the
  83   thread support do not affect you if you don't actually use threads.
  84
  85
  86 --with-modules  ---  Specify statically linked `modules'
  87
  88   Guile can dynamically load `plugin modules' during runtime, using
  89   facilities provided by libtool.  Not all platforms support this,
  90   however.  On these platforms, you can statically link the plugin
  91   modules into libguile when Guile itself is build.  XXX - how does
  92   one specify the modules?
  93
  94
  95 --enable-deprecated=LEVEL  ---  Control the inclusion of deprecated features.
  96
  97   You can select between different behaviours via the LEVEL argument:
  98   a value of "no" will omit all deprecated features and you will get
  99   "undefined reference", "variable unbound" or similar errors when you
 100   try to use them.  All other values will include all deprecated
 101   features.  The LEVEL argument is used as the default value for the
 102   environment variable GUILE_WARN_DEPRECATED.  See the README for
 103   documentation about this.
 104
 105
 106 --disable-shared  ---  Do not build shared libraries.
 107 --disable-static  ---  Do not build static libraries.
 108
 109   Normally, both static and shared libraries will be built if your
 110   system supports them.
 111
 112
 113 --enable-debug-freelist  ---  Enable freelist debugging.
 114
 115   This enables a debugging version of SCM_NEWCELL(), and also
 116   registers an extra primitive, the setter
 117   `gc-set-debug-check-freelist!'.
 118
 119   Configure with the --enable-debug-freelist option to enable the
 120   gc-set-debug-check-freelist! primitive, and then use:
 121
 122   (gc-set-debug-check-freelist! #t)  # turn on checking of the freelist
 123   (gc-set-debug-check-freelist! #f)  # turn off checking
 124
 125   Checking of the freelist forces a traversal of the freelist and a
 126   garbage collection before each allocation of a cell.  This can slow
 127   down the interpreter dramatically, so the setter should be used to
 128   turn on this extra processing only when necessary.
 129
 130
 131 --enable-debug-malloc  ---  Enable malloc debugging.
 132
 133   Include code for debugging of calls to scm_must_malloc/realloc/free.
 134
 135   Checks that
 136
 137   1. objects freed by scm_must_free has been mallocated by scm_must_malloc
 138   2. objects reallocated by scm_must_realloc has been allocated by
 139      scm_must_malloc
 140   3. reallocated objects are reallocated with the same what string
 141
 142   But, most importantly, it records the number of allocated objects of
 143   each kind.  This is useful when searching for memory leaks.
 144
 145   A Guile compiled with this option provides the primitive
 146   `malloc-stats' which returns an alist with pairs of kind and the
 147   number of objects of that kind.
 148
 149
 150 --enable-guile-debug  ---  Include internal debugging functions
 151 --disable-arrays      ---  omit array and uniform array support
 152 --disable-posix       ---  omit posix interfaces
 153 --disable-networking  ---  omit networking interfaces
 154 --disable-regex       ---  omit regular expression interfaces
 155
 156
 157 Using Guile Without Installing It =========================================
 158
 159 If you want to run Guile without installing it, set the environment
 160 variable `GUILE_LOAD_PATH' to a colon-separated list of directories,
 161 including the directory containing this INSTALL file.  If you used a
 162 separate build directory, you'll need to include the build directory
 163 in the path as well.
 164
 165 For example, suppose the Guile distribution unpacked into a directory
 166 called `/home/jimb/guile-snap' (so the full name of this INSTALL file
 167 would be `/home/jimb/guile-snap/INSTALL').  Then you might say, if
 168 you're using Bash or any other Bourne shell variant,
 169
 170   export GUILE_LOAD_PATH=/home/jimb/guile-snap
 171
 172 or if you're using CSH or one of its variants:
 173
 174   setenv GUILE_LOAD_PATH /home/jimb/guile-snap
 175
 176
 177 Installing SLIB ===========================================================
 178
 179 In order to use SLIB from Guile you basically only need to put the
 180 `slib' directory _in_ one of the directories on Guile's load path.
 181
 182 The standard installation is:
 183
 184   1. Obtain slib from http://www-swiss.ai.mit.edu/~jaffer/SLIB.html
 185
 186   2. Put it in Guile's data directory, that is the directory printed when
 187      you type
 188
 189        guile-config info pkgdatadir
 190
 191      at the shell prompt.  This is normally `/usr/local/share/guile', so the
 192      directory will normally have full path `/usr/local/share/guile/slib'.
 193
 194   3. Start guile as a user with write access to the data directory and type
 195
 196        (use-modules (ice-9 slib))
 197
 198      at the Guile prompt.  This will generate the slibcat catalog next to
 199      the slib directory.
 200
 201 SLIB's `require' is provided by the Guile module (ice-9 slib).
 202
 203 Example:
 204
 205   (use-modules (ice-9 slib))
 206   (require 'primes)
 207   (prime? 7)
 208
 209
 210 Generic Instructions for Building Auto-Configured Packages ================
 211
 212 To compile this package:
 213
 214 1.  Configure the package for your system.  In the directory that this
 215 file is in, type `./configure'.  If you're using `csh' on an old
 216 version of System V, you might need to type `sh configure' instead to
 217 prevent `csh' from trying to execute `configure' itself.
 218
 219 The `configure' shell script attempts to guess correct values for
 220 various system-dependent variables used during compilation, and
 221 creates the Makefile(s) (one in each subdirectory of the source
 222 directory).  In some packages it creates a C header file containing
 223 system-dependent definitions.  It also creates a file `config.status'
 224 that you can run in the future to recreate the current configuration.
 225 Running `configure' takes a minute or two.
 226
 227 To compile the package in a different directory from the one
 228 containing the source code, you must use GNU make.  `cd' to the
 229 directory where you want the object files and executables to go and
 230 run `configure' with the option `--srcdir=DIR', where DIR is the
 231 directory that contains the source code.  Using this option is
 232 actually unnecessary if the source code is in the parent directory of
 233 the one in which you are compiling; `configure' automatically checks
 234 for the source code in `..' if it does not find it in the current
 235 directory.
 236
 237 By default, `make install' will install the package's files in
 238 /usr/local/bin, /usr/local/lib, /usr/local/man, etc.  You can specify
 239 an installation prefix other than /usr/local by giving `configure' the
 240 option `--prefix=PATH'.  Alternately, you can do so by changing the
 241 `prefix' variable in the Makefile that `configure' creates (the
 242 Makefile in the top-level directory, if the package contains
 243 subdirectories).
 244
 245 You can specify separate installation prefixes for machine-specific
 246 files and machine-independent files.  If you give `configure' the
 247 option `--exec_prefix=PATH', the package will use PATH as the prefix
 248 for installing programs and libraries.  Normally, all files are
 249 installed using the same prefix.
 250
 251 `configure' ignores any other arguments that you give it.
 252
 253 If your system requires unusual options for compilation or linking
 254 that `configure' doesn't know about, you can give `configure' initial
 255 values for some variables by setting them in the environment.  In
 256 Bourne-compatible shells, you can do that on the command line like
 257 this:
 258         CC='gcc -traditional' DEFS=-D_POSIX_SOURCE ./configure
 259
 260 The `make' variables that you might want to override with environment
 261 variables when running `configure' are:
 262
 263 (For these variables, any value given in the environment overrides the
 264 value that `configure' would choose:)
 265 CC              C compiler program.
 266                 Default is `cc', or `gcc' if `gcc' is in your PATH.
 267 INSTALL         Program to use to install files.
 268                 Default is `install' if you have it, `cp' otherwise.
 269 INCLUDEDIR      Directory for `configure' to search for include files.
 270                 Default is /usr/include.
 271
 272 (For these variables, any value given in the environment is added to
 273 the value that `configure' chooses:)
 274 DEFS            Configuration options, in the form '-Dfoo -Dbar ...'
 275 LIBS            Libraries to link with, in the form '-lfoo -lbar ...'
 276
 277 If you need to do unusual things to compile the package, we encourage
 278 you to teach `configure' how to do them and mail the diffs to the
 279 address given in the README so we can include them in the next
 280 release.
 281
 282 2.  Type `make' to compile the package.
 283
 284 3.  Type `make install' to install programs, data files, and
 285 documentation.
 286
 287 4.  You can remove the program binaries and object files from the
 288 source directory by typing `make clean'.  To also remove the
 289 Makefile(s), the header file containing system-dependent definitions
 290 (if the package uses one), and `config.status' (all the files that
 291 `configure' created), type `make distclean'.
 292
 293 The file `configure.in' is used as a template to create `configure' by
 294 a program called `autoconf'.  You will only need it if you want to
 295 regenerate `configure' using a newer version of `autoconf'.
 296