+Guile Installation Guide
+Copyright (c) 1996, 1997, 1998, 1999, 2000 Free software Foundation, Inc.
+
+ Permission is granted to anyone to make or distribute verbatim copies
+ of this document as received, in any medium, provided that the
+ copyright notice and permission notice are preserved,
+ and that the distributor grants the recipient permission
+ for further redistribution as permitted by this notice.
+
+ Permission is granted to distribute modified versions
+ of this document, or of portions of it,
+ under the above conditions, provided also that they
+ carry prominent notices stating who last changed them,
+ and that any new or changed statements about the activities
+ of the Free Software Foundation are approved by the Foundation.
+
+
Brief Installation Instructions ===========================================
To build Guile on unix, there are two basic steps:
2. Type "make", to build the package.
Generic instructions for configuring and compiling GNU distributions
-are included below. For Guile, you might type the commands below.
-Their voluminous output is not shown.
+are included below. (For instructions how to install SLIB, the scheme
+procedure library, see below.)
- $ tar xvfz guile-970416.tar.gz # unpack the sources
- $ cd guile-970416
- $ ./configure # adapt Guile to your system
- $ make # compile Guile
- $ make install # install in the usual places
-(Note: under SunOS 4.1, you may need to say ./configure --disable-shared;
-Guile's shared library support for that system seems to be confused.)
+Special Instructions For Some Systems =====================================
-What You Get ==============================================================
+We would like Guile to build on all systems using the simple
+instructions above, but it seems that a few systems still need special
+treatment. If you can send us fixes for these problems, we'd be
+grateful.
-The `configure' script examines your system, and adapts Guile to
-compile and run on it.
+SunOS 4.1: Guile's shared library support seems to be confused, but
+ hey; shared libraries are confusing. You may need to configure
+ Guile with a command like:
+ ./configure --disable-shared
+ For more information on `--disable-shared', see below, "Flags
+ Accepted by Configure".
-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 `libguile/.libs/libguile.a', containing the Guile Scheme
- interpreter, ready to be linked into your programs.
+HP/UX: GCC 2.7.2 (and maybe other versions) have trouble creating
+ shared libraries if they depend on any non-shared libraries. GCC
+ seems to have other problems as well. To work around this, we
+ suggest you configure Guile to use the system's C compiler:
+ CC=cc ./configure
-To install Guile, type `make install'. This installs the executable
-and libraries mentioned above, as well as Guile's header files and
-Scheme libraries.
-
-Make also builds shared libraries, on systems that support them.
-Because of the nature of shared libraries, before linking against
-them, you should probably install them; `make install' takes care of
-this.
+NetBSD: Perry Metzger says, "Guile will build under NetBSD only using
+ gmake -- the native make will not work. (gmake is in our package
+ system, so this will not be a problem when we packagize 1.3.)"
Flags Accepted by Configure ===============================================
--with-threads --- Build a Guile executable and library that supports
cooperative threading. If you use this switch, Guile will also build
and install the QuickThreads non-preemptive threading library,
-libqt.a, which you will need to link into your programs after
-libguile.a. That is, you should pass the switches -lguile -qt to your
-linker.
-
-Coop threads are not yet thoroughly tested; once they are, they will
-be enabled by default. The interaction with blocking I/O is pretty ad
-hoc at the moment. In our experience, bugs in the thread support do
-not affect you if you don't actually use threads.
-
---enable-dynamic-linking --- Build a Guile executable and library
-providing Scheme functions which can load a shared library and
-initialize it, perhaps thereby adding new functions to Guile. This
-feature is not yet thoroughly tested; once it is, it will be enabled
-by default. This option has no effect on systems that do not support
-shared libraries.
+libqthreads, which you will need to link into your programs after
+libguile. When you use `guile-config', you will pick up all
+neccessary linker flags automatically.
+
+Cooperative threads are not yet thoroughly tested; once they are, they
+will be enabled by default. The interaction with blocking I/O is
+pretty ad hoc at the moment. In our experience, bugs in the thread
+support do not affect you if you don't actually use threads.
+
+--with-modules --- Guile can dynamically load `plugin modules' during
+runtime, using facilities provided by libtool. Not all platforms
+support this, however. On these platforms, you can statically link
+the plugin modules into libguile when Guile itself is build. XXX -
+how does one specify the modules?
--disable-shared --- Do not build shared libraries. Normally, Guile
will build shared libraries if your system supports them. Guile
always builds static libraries.
+--enable-debug-freelist --- Enable freelist debugging.
+
+This enables a debugging version of SCM_NEWCELL(), and also registers
+an extra primitive, the setter `gc-set-debug-check-freelist!'.
+
+Configure with the --enable-debug-freelist option to enable
+the gc-set-debug-check-freelist! primitive, and then use:
+
+(gc-set-debug-check-freelist! #t) # turn on checking of the freelist
+(gc-set-debug-check-freelist! #f) # turn off checking
+
+Checking of the freelist forces a traversal of the freelist and
+a garbage collection before each allocation of a cell. This can
+slow down the interpreter dramatically, so the setter should be used to
+turn on this extra processing only when necessary.
+
+--enable-debug-malloc --- Enable malloc debugging.
+
+Include code for debugging of calls to scm_must_malloc/realloc/free.
+
+Checks that
+
+1. objects freed by scm_must_free has been mallocated by scm_must_malloc
+2. objects reallocated by scm_must_realloc has been allocated by
+ scm_must_malloc
+3. reallocated objects are reallocated with the same what string
+
+But, most importantly, it records the number of allocated objects of
+each kind. This is useful when searching for memory leaks.
+
+A Guile compiled with this option provides the primitive
+`malloc-stats' which returns an alist with pairs of kind and the
+number of objects of that kind.
+
+--enable-guile-debug --- Include internal debugging functions
+--disable-arrays --- omit array and uniform array support
+--disable-posix --- omit posix interfaces
+--disable-networking --- omit networking interfaces
+--disable-regex --- omit regular expression interfaces
+
Using Guile Without Installing It =========================================
If you want to run Guile without installing it, set the environment
-variable `SCHEME_LOAD_PATH' to a colon-separated list of directories,
+variable `GUILE_LOAD_PATH' to a colon-separated list of directories,
including the directory containing this INSTALL file. If you used a
separate build directory, you'll need to include the build directory
in the path as well.
For example, suppose the Guile distribution unpacked into a directory
-called `/home/jimb/guile-snap' (so the full name of this file would be
-`/home/jimb/guile-snap/INSTALL'). Then you might say:
+called `/home/jimb/guile-snap' (so the full name of this INSTALL file
+would be `/home/jimb/guile-snap/INSTALL'). Then you might say, if
+you're using Bash or any other Bourne shell variant,
+
+ export GUILE_LOAD_PATH=/home/jimb/guile-snap
+
+or if you're using CSH or one of its variants:
- export SCHEME_LOAD_PATH=/home/jimb/guile-snap
+ setenv GUILE_LOAD_PATH /home/jimb/guile-snap
-if you're using Bash or any other Bourne shell variant, or
- setenv SCHEME_LOAD_PATH /home/jimb/guile-snap
+Installing SLIB ===========================================================
-if you're using CSH or one of its variants.
+In order to use SLIB from Guile you basically only need to put the
+`slib' directory _in_ one of the directories on Guile's load path.
-If you built Guile in a separate directory from the source tree, then
-you'll need to include your build directory in the SCHEME_LOAD_PATH as
-well. For example, if you built in a subdirectory of the source tree
-called `pentium', you might say:
+The standard installation is:
- export SCHEME_LOAD_PATH=/home/jimb/guile-snap:/home/jimb/guile-snap/pentium
+ 1. Obtain slib from http://www-swiss.ai.mit.edu/~jaffer/SLIB.html
+ 2. Put it in Guile's data directory, that is the directory printed when
+ you type
-Building a Statically Linked Guile ========================================
+ guile-config info pkgdatadir
-Sometimes it's useful to build a statically-linked version of the
-Guile executable. It's helpful in debugging, and for producing
-stand-alone executables for distribution to machines you don't
-control.
+ at the shell prompt. This is normally `/usr/local/share/guile', so the
+ directory will normally have full path `/usr/local/share/guile/slib'.
-To do this, set the LDFLAGS environment variable to `-static' before
-you configure, or before you run the `make' command to build the
-executable.
+ 3. Start guile as a user with write access to the data directory and type
+
+ (use-modules (ice-9 slib))
+
+ at the Guile prompt. This will generate the slibcat catalog next to
+ the slib directory.
+
+SLIB's `require' is provided by the Guile module (ice-9 slib).
+
+Example:
+
+ (use-modules (ice-9 slib))
+ (require 'primes)
+ (prime? 7)
Generic Instructions for Building Auto-Configured Packages ================
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'.
+
HCoop / bpt / guile.git / blobdiff