2. Type "make", to build the package.
Generic instructions for configuring and compiling GNU distributions
-are included below.
+are included below. (For instructions how to install SLIB, the scheme
+procedure library, see below.)
Special Instructions For Some Systems =====================================
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.)"
-What You Get ==============================================================
-
-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 `libguile/.libs/libguile.a', containing the Guile Scheme
- interpreter, ready to be linked into your programs.
-
-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.
-
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 -lqt to your
-linker.
+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.
---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 enabled by default; you only need to use this option (as
-`--enable-dynamic-linking=no') if you want to build a Guile which does
-not support dynamic linking.
-
-This option has no effect on systems that do not support shared
-libraries.
+--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 =========================================
setenv GUILE_LOAD_PATH /home/jimb/guile-snap
-Building a Statically Linked Guile ========================================
+Installing SLIB ===========================================================
+
+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.
+
+The standard installation is:
+
+ 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
+
+ guile-config info pkgdatadir
+
+ at the shell prompt. This is normally `/usr/local/share/guile', so the
+ directory will normally have full path `/usr/local/share/guile/slib'.
+
+ 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).
-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.
+Example:
-To do this, set the LDFLAGS environment variable to `-static' before
-you configure, or before you run the `make' command to build the
-executable.
+ (use-modules (ice-9 slib))
+ (require 'primes)
+ (prime? 7)
Generic Instructions for Building Auto-Configured Packages ================