Commit | Line | Data |
---|---|---|
04873705 | 1 | !!! This is not a Guile release; it is a source tree retrieved via |
4b824aae | 2 | Git or as a nightly snapshot at some random time after the |
4800a61a | 3 | Guile 1.8 release. If this were a Guile release, you would not see |
04873705 | 4 | this message. !!! [fixme: zonk on release] |
c299f186 | 5 | |
0f24e75b | 6 | This is a 1.9 development version of Guile, Project GNU's extension |
f2a75d81 RB |
7 | language library. Guile is an interpreter for Scheme, packaged as a |
8 | library that you can link into your applications to give them their | |
9 | own scripting language. Guile will eventually support other languages | |
10 | as well, giving users of Guile-based applications a choice of | |
11 | languages. | |
12 | ||
0f24e75b | 13 | Guile versions with an odd middle number, i.e. 1.9.* are unstable |
f2a75d81 RB |
14 | development versions. Even middle numbers indicate stable versions. |
15 | This has been the case since the 1.3.* series. | |
16 | ||
a89cafc0 | 17 | The next stable release will likely be version 2.0.0. |
7fcc90c4 | 18 | |
1e457544 | 19 | Please send bug reports to bug-guile@gnu.org. |
86f40248 | 20 | |
d165aa15 RB |
21 | See the LICENSE file for the specific terms that apply to Guile. |
22 | ||
23 | ||
24 | Additional INSTALL instructions =========================================== | |
25 | ||
26 | Generic instructions for configuring and compiling Guile can be found | |
27 | in the INSTALL file. Guile specific information and configure options | |
28 | can be found below, including instructions for installing SLIB. | |
29 | ||
a89cafc0 NJ |
30 | Guile depends on the following external libraries. |
31 | - libgmp | |
32 | - libiconv | |
33 | - libintl | |
34 | - libltdl | |
35 | - libunistring | |
cab6e6c0 | 36 | - libgc |
127f5c62 | 37 | - libffi |
a89cafc0 NJ |
38 | It will also use the libreadline library if it is available. For each |
39 | of these there is a corresponding --with-XXX-prefix option that you | |
40 | can use when invoking ./configure, if you have these libraries | |
41 | installed in a location other than the standard places (/usr and | |
42 | /usr/local). | |
43 | ||
44 | These options are provided by the Gnulib `havelib' module, and details | |
45 | of how they work are documented in `Searching for Libraries' in the | |
46 | Gnulib manual (http://www.gnu.org/software/gnulib/manual). The extent | |
47 | to which they work on a given OS depends on whether that OS supports | |
48 | encoding full library path names in executables (aka `rpath'). Also | |
49 | note that using these options, and hence hardcoding full library path | |
50 | names (where that is supported), makes it impossible to later move the | |
51 | built executables and libraries to an installation location other than | |
52 | the one that was specified at build time. | |
53 | ||
e744e076 TTN |
54 | Another possible approach is to set CPPFLAGS and LDFLAGS on the |
55 | configure command-line, so that they include -I options for all the | |
a89cafc0 NJ |
56 | non-standard places where you have installed header files and -L |
57 | options for all the non-standard places where you have installed | |
58 | libraries. This will allow configure and make to find those headers | |
e744e076 TTN |
59 | and libraries during the build. E.g.: |
60 | ||
61 | ../configure [...] CPPFLAGS='-I/my/include' LDFLAGS='-L/my/lib' | |
62 | ||
63 | The locations found will not be hardcoded into the build executables and | |
64 | libraries, so with this approach you will probably also need to set | |
65 | LD_LIBRARY_PATH correspondingly, to allow Guile to find the necessary | |
66 | libraries again at runtime. | |
d165aa15 RB |
67 | |
68 | ||
a98dbc87 MV |
69 | Required External Packages ================================================ |
70 | ||
71 | Guile requires the following external packages: | |
72 | ||
73 | - GNU MP, at least version 4.1 | |
74 | ||
75 | GNU MP is used for bignum arithmetic. It is available from | |
cab6e6c0 | 76 | http://gmplib.org/ . |
a98dbc87 | 77 | |
cab6e6c0 | 78 | - libltdl from GNU Libtool, at least version 1.5.6 |
a98dbc87 MV |
79 | |
80 | libltdl is used for loading extensions at run-time. It is | |
cab6e6c0 | 81 | available from http://www.gnu.org/software/libtool/ . |
a98dbc87 | 82 | |
1ee2c72e LC |
83 | - GNU libunistring |
84 | ||
85 | libunistring is used for Unicode string operations, such as the | |
86 | `utf*->string' procedures. It is available from | |
87 | http://www.gnu.org/software/libunistring/ . | |
88 | ||
cab6e6c0 LC |
89 | - libgc, at least version 7.0 |
90 | ||
91 | libgc (aka. the Boehm-Demers-Weiser garbage collector) is the | |
92 | conservative garbage collector used by Guile. It is available | |
93 | from http://www.hpl.hp.com/personal/Hans_Boehm/gc/ . | |
94 | ||
127f5c62 LC |
95 | - libffi |
96 | ||
97 | libffi provides a "foreign function interface", used by the | |
98 | `(system foreign)' module. It is available from | |
99 | http://sourceware.org/libffi/ . | |
100 | ||
ef736635 NJ |
101 | - pkg-config |
102 | ||
103 | Guile's ./configure script uses pkg-config to discover the correct | |
104 | compile and link options for libgc. If you don't have pkg-config | |
105 | installed, or you have a version of libgc that doesn't provide a | |
e744e076 TTN |
106 | .pc file, you can work around this by setting some variables as |
107 | part of the configure command-line: | |
ef736635 NJ |
108 | |
109 | - PKG_CONFIG=true | |
110 | ||
111 | - BDW_GC_CFLAGS=<compile flags for picking up libgc headers> | |
112 | ||
113 | - BDW_GC_LIBS=<linker flags for picking up the libgc library> | |
114 | ||
a98dbc87 | 115 | |
d165aa15 RB |
116 | Special Instructions For Some Systems ===================================== |
117 | ||
118 | We would like Guile to build on all systems using the simple | |
119 | instructions above, but it seems that a few systems still need special | |
120 | treatment. If you can send us fixes for these problems, we'd be | |
121 | grateful. | |
122 | ||
70bb8113 | 123 | <none yet listed> |
d165aa15 RB |
124 | |
125 | Guile specific flags Accepted by Configure ================================= | |
126 | ||
127 | If you run the configure script with no arguments, it should examine | |
128 | your system and set things up appropriately. However, there are a few | |
129 | switches specific to Guile you may find useful in some circumstances. | |
130 | ||
4f416616 | 131 | --without-threads --- Build without thread support |
d165aa15 | 132 | |
70bb8113 | 133 | Build a Guile executable and library that supports multi-threading. |
d165aa15 | 134 | |
70bb8113 MV |
135 | The default is to enable threading support when your operating |
136 | system offsers 'POSIX threads'. When you do not want threading, use | |
137 | `--without-threads'. | |
d165aa15 RB |
138 | |
139 | --enable-deprecated=LEVEL | |
140 | ||
141 | Guile may contain features that are `deprecated'. When a feature is | |
3623a170 MV |
142 | deprecated, it means that it is still there, but that there is a |
143 | better way of achieving the same thing, and we'd rather have you use | |
144 | this better way. This allows us to eventually remove the old | |
145 | implementation and helps to keep Guile reasonably clean of historic | |
146 | baggage. | |
147 | ||
148 | Deprecated features are considered harmful; using them is likely a | |
149 | bug. See below for the related notion of `discouraged' features, | |
70bb8113 | 150 | which are OK but have fallen out of favor. |
d165aa15 RB |
151 | |
152 | See the file NEWS for a list of features that are currently | |
153 | deprecated. Each entry will also tell you what you should replace | |
154 | your code with. | |
155 | ||
156 | To give you some help with this process, and to encourage (OK, | |
157 | nudge) people to switch to the newer methods, Guile can emit | |
158 | warnings or errors when you use a deprecated feature. There is | |
159 | quite a range of possibilities, from being completely silent to | |
160 | giving errors at link time. What exactly happens is determined both | |
161 | by the value of the `--enable-deprecated' configuration option when | |
162 | Guile was built, and by the GUILE_WARN_DEPRECATED environment | |
163 | variable. | |
164 | ||
165 | It works like this: | |
166 | ||
167 | When Guile has been configured with `--enable-deprecated=no' (or, | |
168 | equivalently, with `--disable-deprecated') then all deprecated | |
169 | features are omitted from Guile. You will get "undefined | |
170 | reference", "variable unbound" or similar errors when you try to | |
171 | use them. | |
172 | ||
173 | When `--enable-deprecated=LEVEL' has been specified (for LEVEL not | |
174 | "no"), LEVEL will be used as the default value of the environment | |
175 | variable GUILE_WARN_DEPRECATED. A value of "yes" is changed to | |
176 | "summary" and "shutup" is changed to "no", however. | |
177 | ||
178 | When GUILE_WARN_DEPRECATED has the value "no", nothing special | |
179 | will happen when a deprecated feature is used. | |
180 | ||
181 | When GUILE_WARN_DEPRECATED has the value "summary", and a | |
182 | deprecated feature has been used, Guile will print this message at | |
183 | exit: | |
184 | ||
185 | Some deprecated features have been used. Set the environment | |
186 | variable GUILE_WARN_DEPRECATED to "detailed" and rerun the | |
187 | program to get more information. Set it to "no" to suppress | |
188 | this message. | |
189 | ||
190 | When GUILE_WARN_DEPRECATED has the value "detailed", a detailed | |
191 | warning is emitted immediatly for the first use of a deprecated | |
192 | feature. | |
193 | ||
194 | The default is `--enable-deprecated=yes'. | |
195 | ||
8f305401 MV |
196 | In addition to setting GUILE_WARN_DEPRECATED in the environment, you |
197 | can also use (debug-enable 'warn-deprecated) and (debug-disable | |
198 | 'warn-deprecated) to enable and disable the detailed messaged at run | |
199 | time. | |
200 | ||
3623a170 MV |
201 | --disable-discouraged |
202 | ||
203 | In addition to deprecated features, Guile can also contain things | |
204 | that are merely `discouraged'. It is OK to continue to use these | |
205 | features in old code, but new code should avoid them since there are | |
206 | better alternatives. | |
207 | ||
208 | There is nothing wrong with a discouraged feature per se, but they | |
209 | might have strange names, or be non-standard, for example. Avoiding | |
210 | them will make your code better. | |
211 | ||
d165aa15 RB |
212 | --disable-shared --- Do not build shared libraries. |
213 | --disable-static --- Do not build static libraries. | |
214 | ||
215 | Normally, both static and shared libraries will be built if your | |
216 | system supports them. | |
217 | ||
d165aa15 RB |
218 | --enable-debug-freelist --- Enable freelist debugging. |
219 | ||
70bb8113 MV |
220 | This enables a debugging version of scm_cell and scm_double_cell, |
221 | and also registers an extra primitive, the setter | |
d165aa15 RB |
222 | `gc-set-debug-check-freelist!'. |
223 | ||
224 | Configure with the --enable-debug-freelist option to enable the | |
225 | gc-set-debug-check-freelist! primitive, and then use: | |
226 | ||
227 | (gc-set-debug-check-freelist! #t) # turn on checking of the freelist | |
228 | (gc-set-debug-check-freelist! #f) # turn off checking | |
229 | ||
230 | Checking of the freelist forces a traversal of the freelist and a | |
231 | garbage collection before each allocation of a cell. This can slow | |
232 | down the interpreter dramatically, so the setter should be used to | |
233 | turn on this extra processing only when necessary. | |
234 | ||
d165aa15 RB |
235 | --enable-debug-malloc --- Enable malloc debugging. |
236 | ||
70bb8113 | 237 | Include code for debugging of calls to scm_malloc, scm_realloc, etc. |
d165aa15 | 238 | |
70bb8113 MV |
239 | It records the number of allocated objects of each kind. This is |
240 | useful when searching for memory leaks. | |
d165aa15 RB |
241 | |
242 | A Guile compiled with this option provides the primitive | |
243 | `malloc-stats' which returns an alist with pairs of kind and the | |
244 | number of objects of that kind. | |
245 | ||
d165aa15 | 246 | --enable-guile-debug --- Include internal debugging functions |
d165aa15 RB |
247 | --disable-posix --- omit posix interfaces |
248 | --disable-networking --- omit networking interfaces | |
249 | --disable-regex --- omit regular expression interfaces | |
250 | ||
251 | ||
252 | Cross building Guile ===================================================== | |
253 | ||
254 | As of guile-1.5.x, the build process uses compiled C files for | |
255 | snarfing, and (indirectly, through libtool) for linking, and uses the | |
256 | guile executable for generating documentation. | |
257 | ||
258 | When cross building guile, you first need to configure, build and | |
259 | install guile for your build host. | |
260 | ||
261 | Then, you may configure guile for cross building, eg: | |
262 | ||
263 | ./configure --host=i686-pc-cygwin --disable-shared | |
264 | ||
cd9d439e KR |
265 | A C compiler for the build system is required. The default is |
266 | "PATH=/usr/bin:$PATH cc". If that doesn't suit it can be specified | |
267 | with the CC_FOR_BUILD variable in the usual way, for instance | |
d165aa15 | 268 | |
cd9d439e KR |
269 | ./configure --host=m68k-unknown-linux-gnu CC_FOR_BUILD=/my/local/gcc |
270 | ||
1028fcb2 KR |
271 | Guile for the build system can be specified similarly with the |
272 | GUILE_FOR_BUILD variable, it defaults to just "guile". | |
d165aa15 RB |
273 | |
274 | ||
275 | Using Guile Without Installing It ========================================= | |
276 | ||
0b6d8fdc AW |
277 | The "meta/" subdirectory of the Guile sources contains a script called |
278 | "guile" that can be used to run the Guile that has just been built. Note | |
279 | that this is not the same "guile" as the one that is installed; this | |
280 | "guile" is a wrapper script that sets up the environment appropriately, | |
281 | then invokes the Guile binary. | |
282 | ||
4ea9429e AW |
283 | You may also build external packages against an uninstalled Guile build |
284 | tree. The "uninstalled-env" script in the "meta/" subdirectory will set | |
285 | up an environment with a path including "meta/", a modified dynamic | |
286 | linker path, a modified PKG_CONFIG_PATH, etc. | |
0b6d8fdc AW |
287 | |
288 | For example, you can enter this environment via invoking | |
289 | ||
290 | meta/uninstalled-env bash | |
291 | ||
292 | Within that shell, other packages should be able to build against | |
293 | uninstalled Guile. | |
d165aa15 RB |
294 | |
295 | ||
296 | Installing SLIB =========================================================== | |
297 | ||
298 | In order to use SLIB from Guile you basically only need to put the | |
299 | `slib' directory _in_ one of the directories on Guile's load path. | |
300 | ||
301 | The standard installation is: | |
302 | ||
303 | 1. Obtain slib from http://www-swiss.ai.mit.edu/~jaffer/SLIB.html | |
304 | ||
305 | 2. Put it in Guile's data directory, that is the directory printed when | |
306 | you type | |
307 | ||
308 | guile-config info pkgdatadir | |
309 | ||
310 | at the shell prompt. This is normally `/usr/local/share/guile', so the | |
311 | directory will normally have full path `/usr/local/share/guile/slib'. | |
312 | ||
313 | 3. Start guile as a user with write access to the data directory and type | |
314 | ||
315 | (use-modules (ice-9 slib)) | |
316 | ||
317 | at the Guile prompt. This will generate the slibcat catalog next to | |
318 | the slib directory. | |
319 | ||
320 | SLIB's `require' is provided by the Guile module (ice-9 slib). | |
321 | ||
322 | Example: | |
323 | ||
324 | (use-modules (ice-9 slib)) | |
325 | (require 'primes) | |
326 | (prime? 7) | |
327 | ||
70bb8113 | 328 | |
394a535e MD |
329 | Guile Documentation ================================================== |
330 | ||
ea8ac9ac KR |
331 | If you've never used Scheme before, then the Guile Tutorial |
332 | (guile-tut.info) is a good starting point. The Guile Reference Manual | |
eb12b401 NJ |
333 | (guile.info) is the primary documentation for Guile. A copy of the |
334 | R5RS Scheme specification is included too (r5rs.info). | |
ea8ac9ac KR |
335 | |
336 | Info format versions of this documentation are installed as part of | |
337 | the normal build process. The texinfo sources are under the doc | |
338 | directory, and other formats like Postscript, PDF, DVI or HTML can be | |
339 | generated from them with Tex and Texinfo tools. | |
340 | ||
341 | The doc directory also includes an example-smob subdirectory which has | |
342 | the example code from the "Defining New Types (Smobs)" chapter of the | |
343 | reference manual. | |
394a535e | 344 | |
b5074b23 MD |
345 | The Guile WWW page is at |
346 | ||
347 | http://www.gnu.org/software/guile/guile.html | |
348 | ||
349 | It contains a link to the Guile FAQ. | |
350 | ||
cf78e9e8 JB |
351 | About This Distribution ============================================== |
352 | ||
f89a27fa | 353 | Interesting files include: |
ae8de16e | 354 | |
d165aa15 | 355 | - LICENSE, which contains the exact terms of the Guile license. |
53befeb7 | 356 | - COPYING.LESSER, which contains the terms of the GNU Lesser General Public License. |
d165aa15 RB |
357 | - COPYING, which contains the terms of the GNU General Public License. |
358 | - INSTALL, which contains general instructions for building/installing Guile. | |
f89a27fa | 359 | - NEWS, which describes user-visible changes since the last release of Guile. |
f89a27fa | 360 | |
ae8de16e GH |
361 | Files are usually installed according to the prefix specified to |
362 | configure, /usr/local by default. Building and installing gives you: | |
363 | ||
364 | Executables, in ${prefix}/bin: | |
365 | ||
04873705 TTN |
366 | guile --- a stand-alone interpreter for Guile. With no arguments, this |
367 | is a simple interactive Scheme interpreter. It can also be used | |
368 | as an interpreter for script files; see the NEWS file for details. | |
369 | guile-config --- a Guile script which provides the information necessary | |
370 | to link your programs against the Guile library. | |
371 | guile-snarf --- a script to parse declarations in your C code for | |
372 | Scheme-visible C functions, Scheme objects to be used by C code, | |
373 | etc. | |
ae8de16e GH |
374 | |
375 | Libraries, in ${prefix}/lib. Depending on the platform and options | |
376 | given to configure, you may get shared libraries in addition | |
377 | to or instead of these static libraries: | |
0a7fcdbc | 378 | |
04873705 TTN |
379 | libguile.a --- an object library containing the Guile interpreter, |
380 | You can use Guile in your own programs by linking against this. | |
04873705 | 381 | libguilereadline.a --- an object library containing glue code for the |
70bb8113 MV |
382 | GNU readline library. |
383 | ||
04873705 | 384 | libguile-srfi-*.a --- various SRFI support libraries |
ae8de16e GH |
385 | |
386 | Header files, in ${prefix}/include: | |
387 | ||
04873705 TTN |
388 | libguile.h, guile/gh.h, libguile/*.h --- for libguile. |
389 | guile-readline/readline.h --- for guile-readline. | |
ae8de16e GH |
390 | |
391 | Support files, in ${prefix}/share/guile/<version>: | |
392 | ||
04873705 TTN |
393 | ice-9/* --- run-time support for Guile: the module system, |
394 | read-eval-print loop, some R4RS code and other infrastructure. | |
395 | oop/* --- the Guile Object-Oriented Programming System (GOOPS) | |
396 | scripts/* --- executable modules, i.e., scheme programs that can be both | |
397 | called as an executable from the shell, and loaded and used as a | |
398 | module from scheme code. See scripts/README for more info. | |
399 | srfi/* --- SRFI support modules. See srfi/README for more info. | |
ae8de16e GH |
400 | |
401 | Automake macros, in ${prefix}/share/aclocal: | |
402 | ||
04873705 | 403 | guile.m4 |
ae8de16e GH |
404 | |
405 | Documentation in Info format, in ${prefix}/info: | |
406 | ||
c08a1190 GH |
407 | guile --- Guile reference manual. |
408 | ||
409 | guile-tut --- Guile tutorial. | |
410 | ||
411 | GOOPS --- GOOPS reference manual. | |
412 | ||
413 | r5rs --- Revised(5) Report on the Algorithmic Language Scheme. | |
414 | ||
0196b30a | 415 | |
5c54da76 JB |
416 | The Guile source tree is laid out as follows: |
417 | ||
1325feea | 418 | libguile: |
cf78e9e8 JB |
419 | The Guile Scheme interpreter --- both the object library |
420 | for you to link with your programs, and the executable you can run. | |
1325feea | 421 | ice-9: Guile's module system, initialization code, and other infrastructure. |
17f8d40c JB |
422 | guile-config: |
423 | Source for the guile-config script. | |
621e8324 MV |
424 | guile-readline: |
425 | The glue code for using GNU readline with Guile. This | |
426 | will be build when configure can find a recent enough readline | |
427 | library on your system. | |
ae8de16e | 428 | doc: Documentation (see above). |
4c8980a2 | 429 | |
4b824aae | 430 | Git Repository Access ================================================ |
c11f9405 | 431 | |
4b824aae LC |
432 | Guile's source code is stored in a Git repository at Savannah. Anyone |
433 | can access it using `git-clone' from one of the following URLs: | |
c11f9405 | 434 | |
4b824aae LC |
435 | git://git.sv.gnu.org/guile.git |
436 | http://git.sv.gnu.org/r/guile.git | |
349d9c1f | 437 | |
4b824aae LC |
438 | Developers with a Savannah SSH account can also access it from: |
439 | ||
440 | ssh://git.sv.gnu.org/srv/git/guile.git | |
441 | ||
442 | The repository can also be browsed on-line at the following address: | |
443 | ||
444 | http://git.sv.gnu.org/gitweb/?p=guile.git | |
445 | ||
446 | For more information on Git, please see: | |
447 | ||
448 | http://git.or.cz/ | |
449 | ||
450 | Please send problem reports to <bug-guile@gnu.org>. |