Annotation of gforth/INSTALL, revision 1.21
1.7 anton 1: You need gcc version 2.0 or later to compile gforth.
1.1 anton 2:
1.5 anton 3: First, type
1.3 anton 4:
1.8 anton 5: ./configure
1.1 anton 6:
1.21 ! anton 7: (see Section Configuration Options below for details).
! 9: After configuration, type
! 11: make
! 13: Now you can check whether your shiny new Forth system works. Say
! 15: make test
! 17: You can run some benchmarks with
! 19: make bench
! 21: and compare them with the results in Benchres and in the manual.
! 23: If everything is all right, you may want to install gforth. Type
! 25: make install
! 27: You have to make an entry in the info directory file manually.
! 29: For paper documentation, print gforth.ps (a Postscript file (300dpi
! 30: fonts, i.e., it works, but does not produce best quality on better
! 31: printers)), or say
! 33: make gforth.dvi
! 35: and print the resulting file gforth.dvi. You can also get the
! 36: documentation in HTML format by typing
! 38: make html
! 40: If you prefer plain ASCII documentation, just concatenate the files
! 41: gforth.info-* ('cat gforth.info-*' under Unix).
! 44: Configuration Options
! 46: You can build in a directory different from the source directory by
! 47: changing to the build directory and invoking configure thus:
! 49: $srcdir/configure
! 51: where $srcdir is the source directory (Note that we tested this only
! 52: for installation; i.e., if you want to hack the Gforth sources, you
! 53: should probably build in the source directory).
1.4 pazsan 55: configure has the following useful parameters:
1.9 anton 56: --prefix=PREFIX install architecture-independent files in PREFIX
57: [default: /usr/local]
58: --exec-prefix=PREFIX install architecture-dependent files in PREFIX
59: [default: same as prefix]
1.8 anton 60: --enable-force-reg Use explicit register declarations if they appear in
61: the machine.h file. This can cause a good speedup,
62: but also incorrect code with some gcc versions on
63: some processors (default disabled).
64: --enable-direct-threaded Force direct threading. This may not work on
65: some machines and may cause slowdown on others.
66: (default processor-dependent)
67: --enable-indirect-threaded Force indirect threading. This can cause a
68: slowdown on some machines.
69: (default processor-dependent)
70: --with-debug specifies option -g to compile with debug info (default)
71: --without-debug omits the -g switch and creates smaller images on
72: machines where strip has problems with gcc style
73: debugging informations.
74: --help: tells you about other parameters.
1.1 anton 75:
1.21 ! anton 76: The file Benchres shows which combination of the -enable options we
! 77: tried gave the best results for various machines.
1.9 anton 79: If you don't like the defaults for the installation directories, you
80: should override them already during configure. E.g., if you want to
81: install in the /gnu hierarchy instead of in the default /usr/local
1.15 anton 82: hierarchy, say
1.5 anton 83:
1.9 anton 84: ./configure --prefix=/gnu
1.2 anton 85:
1.17 anton 86: Moreover, if your GCC is not called gcc (but, e.g., gcc-2.7.1), you
87: should say so during configuration. E.g.:
1.16 pazsan 88:
1.17 anton 89: env CC=gcc-2.7.1 ./configure
1.16 pazsan 90:
1.17 anton 91: You can also pass additional options to gcc in this way, e.g., if you
92: want to generate an a.out executable under Linux with gcc-2.7.0:
1.15 anton 93:
1.17 anton 94: env "CC=gcc -b i486-linuxaout -V 2.7.0" ./configure
1.15 anton 95:
1.17 anton 96:
97: Preloading installation-specific code
99: If you want to have some installation-specific files loaded when
100: Gforth starts (e.g., an assembler for your processor), put commands
101: for loading them into /usr/local/share/gforth/site-forth/site-init.fs
102: (if the commands work for all architectures) or
103: /usr/local/lib/gforth/site-forth/site-init.fs (for
104: architecture-specific commands);
105: /usr/local/lib/gforth/site-forth/site-init.fs takes precedence if both
106: files are present (unless you change the search path). The file names
107: given above are the defaults; if you have changed the prefix, you have
108: to replace "/usr/local" in these names with your prefix.
110: By default, the installation procedure creates an empty
111: /usr/local/share/gforth/site-forth/site-init.fs if there is no such
114: If you change the site-init.fs file, you should run "make install"
115: again for the changes to take effect (Actually, the part of "make
116: install" starting with "rm gforth.fi" is sufficient).
1.12 anton 119: Multiple Versions and Deinstallation
121: Several versions of Gforth can be installed and used at the same
122: time. Version `foo' can be invoked with `gforth-foo'. We recommend to
123: keep the old version for some time after a new one has been installed.
1.10 anton 124:
1.12 anton 125: You can deinstall this version of Gforth with 'make uninstall' and
126: version foo with 'make uninstall VERSION=foo'. 'make uninstall' also
127: tells you how to uninstall Gforth completely.
1.17 anton 128:
1.10 anton 129:
1.12 anton 130: A Possible Problem
1.10 anton 131:
132: You need to read this only if you see a message like
1.19 anton 134: ...
135: The Gforth installer should look into the INSTALL file
137: 1) "gforth: Cannot load nonrelocatable image (compiled for address $1234) at address $5678
1.10 anton 138: The Gforth installer should look into the INSTALL file"
1.11 anton 140: Gforth supports both relocatable and fixed-address images. If you load
1.10 anton 141: normal Forth code and save the image, you get a fixed-address
142: image. Producing a relocatable image is more difficult.
1.11 anton 144: Therefore, Gforth has only a relocatable image of the kernel
1.20 pazsan 145: (kernel.fi), which is powerful enough to load the rest of
1.10 anton 146: Gforth. However, loading the rest takes a noticable amount of time. To
1.11 anton 147: avoid this delay (which would occur on every startup), the
148: installation procedure produces an image fixed at an address
149: determined at the Gforth run that produced the image. This
150: fixed-address image is loaded by default. On most OSs this works,
151: because the first chunk of memory is always allocated at the same
152: address. If the address changes, you get the message above.
1.10 anton 153:
154: An image address change can be caused by a change of the gforth
155: executable, or by a change (upgrade) of the OS; in these cases you
156: just have to rebuild and reinstall the fixed address image with
158: rm gforth.fi; make gforth.fi; make install
160: If you get such a message with a different address in place of the
1.19 anton 161: $5678 each time you try to start gforth, you cannot use fixed-address
1.10 anton 162: images on your OS. In this case, send us a message so that we start
163: searching for a comfortable solution to this problem. In the
164: meantime, start gforth with
1.20 pazsan 166: gforth -i kernel.fi startup.fs
1.19 anton 167:
169: 2) "%s: Checksum of image ($13579b) does not match the executable ($2468a)
170: The Gforth installer should look into the INSTALL file"
172: A fixed-address image is not only fixed with respect to its base
173: address, but also with respect to certain addresses in the gforth
174: executable and the threading method. These things are encoded in a
177: If the checksum of the executable and the checksum of the image are
178: not equal, you get the message above. This can be caused, e.g., by
179: trying to run an image produced for a direct threading system on an
180: indirect threaded system.
182: Chances are that you unintentionally tried to execute an image from
1.21 ! anton 183: the wrong directory. As a remedy, you can specify Gforth's search
1.19 anton 184: path with the "-p" command line option and with the GFORTHPATH
185: environment variable.
187: On the other hand, if you need to solve the problem by creating a new
188: fixed-address image, you can use the steps described above.
1.10 anton 190: