--- gforth/INSTALL 1996/05/03 13:05:04 1.19 +++ gforth/INSTALL 1996/10/28 17:24:30 1.22 @@ -4,6 +4,55 @@ First, type ./configure +(see Section Configuration Options below for details). + +After configuration, type + +make + +Now you can check whether your shiny new Forth system works. Say + +make test + +You can run some benchmarks with + +make bench + +and compare them with the results in Benchres and in the manual. + +If everything is all right, you may want to install gforth. Type + +make install + +You have to make an entry in the info directory file manually. + +For paper documentation, print gforth.ps (a Postscript file (300dpi +fonts, i.e., it works, but does not produce best quality on better +printers)), or say + +make gforth.dvi + +and print the resulting file gforth.dvi. You can also get the +documentation in HTML format by typing + +make html + +If you prefer plain ASCII documentation, just concatenate the files +gforth.info-* ('cat gforth.info-*' under Unix). + + + Configuration Options + +You can build in a directory different from the source directory by +changing to the build directory and invoking configure thus: + +$srcdir/configure + +where $srcdir is the source directory. You need a VPATH-capable 'make' +(e.g., GNU make) for this. (Note that we tested this only +for installation; i.e., if you want to hack the Gforth sources, you +should probably build in the source directory). + configure has the following useful parameters: --prefix=PREFIX install architecture-independent files in PREFIX [default: /usr/local] @@ -20,11 +69,14 @@ configure has the following useful param slowdown on some machines. (default processor-dependent) --with-debug specifies option -g to compile with debug info (default) - --without-debug omits the -g switch and creates smaller images on - machines where strip has problems with gcc style - debugging informations. + --without-debug omits the -g switch and creates smaller images on + machines where strip has problems with gcc style + debugging informations. --help: tells you about other parameters. +The file Benchres shows which combination of the -enable options we +tried gave the best results for various machines. + If you don't like the defaults for the installation directories, you should override them already during configure. E.g., if you want to install in the /gnu hierarchy instead of in the default /usr/local @@ -42,39 +94,14 @@ want to generate an a.out executable und env "CC=gcc -b i486-linuxaout -V 2.7.0" ./configure -After, configuration, type - -make - -Now you can check whether your shiny new Forth system works. Say - -make test +You can change the sizes of the various areas used in the default +image `gforth.fi' by passing the appropriate Gforth command line +options in the FORTHSIZES environment variable: -You can run some benchmarks with - -make bench - -and compare them with the results in Benchres and in the manual. - -If everything is all right, you may want to install gforth. Type +env "FORTHSIZES=--dictionary-size=256k --data-stack-size=16k --fp-stack-size=16k --return-stack-size=16k --locals-stack-size=16k" ./configure -make install - -You have to make an entry in the info directory file manually. - -For paper documentation, print gforth.ps (a Postscript file (300dpi -fonts, i.e., it works, but does not produce best quality on better -printers)), or say - -make gforth.dvi - -and print the resulting file gforth.dvi. You can also get the -documentation in HTML format by typing - -make html - -If you prefer plain ASCII documentation, just concatenate the files -gforth.info-* ('cat gforth.info-*' under Unix). +The line above reaffirms the default sizes. Note that the locals +stack area is also used as input buffer stack. Preloading installation-specific code @@ -124,7 +151,7 @@ normal Forth code and save the image, yo image. Producing a relocatable image is more difficult. Therefore, Gforth has only a relocatable image of the kernel -(kernal.fi), which is powerful enough to load the rest of +(kernel.fi), which is powerful enough to load the rest of Gforth. However, loading the rest takes a noticable amount of time. To avoid this delay (which would occur on every startup), the installation procedure produces an image fixed at an address @@ -145,7 +172,7 @@ images on your OS. In this case, send us searching for a comfortable solution to this problem. In the meantime, start gforth with -gforth -i kernal.fi startup.fs +gforth -i kernel.fi startup.fs 2) "%s: Checksum of image ($13579b) does not match the executable ($2468a) @@ -162,7 +189,7 @@ trying to run an image produced for a di indirect threaded system. Chances are that you unintentionally tried to execute an image from -the wrong directory. As a remedy, you can determine Gforth's search +the wrong directory. As a remedy, you can specify Gforth's search path with the "-p" command line option and with the GFORTHPATH environment variable.