Annotation of gforth/INSTALL, revision 1.13
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.4 pazsan 7: configure has the following useful parameters:
1.9 anton 8: --prefix=PREFIX install architecture-independent files in PREFIX
9: [default: /usr/local]
10: --exec-prefix=PREFIX install architecture-dependent files in PREFIX
11: [default: same as prefix]
1.8 anton 12: --enable-force-reg Use explicit register declarations if they appear in
13: the machine.h file. This can cause a good speedup,
14: but also incorrect code with some gcc versions on
15: some processors (default disabled).
16: --enable-direct-threaded Force direct threading. This may not work on
17: some machines and may cause slowdown on others.
18: (default processor-dependent)
19: --enable-indirect-threaded Force indirect threading. This can cause a
20: slowdown on some machines.
21: (default processor-dependent)
22: --with-debug specifies option -g to compile with debug info (default)
23: --without-debug omits the -g switch and creates smaller images on
24: machines where strip has problems with gcc style
25: debugging informations.
26: --help: tells you about other parameters.
1.1 anton 27:
1.9 anton 28: If you don't like the defaults for the installation directories, you
29: should override them already during configure. E.g., if you want to
30: install in the /gnu hierarchy instead of in the default /usr/local
31: hirarchy, say
1.5 anton 32:
1.9 anton 33: ./configure --prefix=/gnu
1.2 anton 34:
1.9 anton 35: After, configuration, type
36:
1.5 anton 37: make
38:
39: If your make has trouble with the Makefile, "make gforth" might work.
1.2 anton 40:
1.9 anton 41: If your installed gcc isn't called "gcc" (e.g., called "gcc-2.6.1"), type
1.1 anton 42:
1.7 anton 43: make GCC=<whatever you call your gcc>
1.4 pazsan 44:
45: instead.
1.6 anton 46:
1.7 anton 47: Now you can check whether your shiny new Forth system works. Say
48:
49: make test
50:
1.12 anton 51: You can run some benchmarks with
1.6 anton 52:
1.12 anton 53: make bench
54:
55: and compare them with the results in Benchres and in the manual.
1.7 anton 56:
1.13 ! anton 57: If everything is all right, you may want to install gforth. Type
1.7 anton 58:
59: make install
60:
1.12 anton 61: You have to make an entry in the info directory file manually.
62:
63: For paper documentation, print gforth.ps (a Postscript file (300dpi
64: fonts, i.e., it works, but does not produce best quality on better
65: printers)), or say
66:
67: make gforth.dvi
68:
69: and print the resulting file gforth.dvi. You can also get the
70: documentation in HTML format by typing
71:
72: make html
73:
1.13 ! anton 74:
! 75: Preloading installation-specific code
! 76:
! 77: If you want to have some installation-specific files loaded when
! 78: Gforth starts (e.g., an assembler for your processor), put commands
! 79: for loading them into /usr/local/share/gforth/site-forth/site-init.fs
! 80: (if the commands work for all architectures) or
! 81: /usr/local/lib/gforth/site-forth/site-init.fs (for
! 82: architecture-specific commands);
! 83: /usr/local/lib/gforth/site-forth/site-init.fs takes precedence if both
! 84: files are present (unless you change the search path). The file names
! 85: given above are the defaults; if you have changed the prefix, you have
! 86: to replace "/usr/local" in these names with your prefix.
! 87:
! 88: By default, the installation procedure creates an empty
! 89: /usr/local/share/gforth/site-forth/site-init.fs if there is no such
! 90: file.
! 91:
! 92: If you change the site-init.fs file, you should run "make install"
! 93: again for the changes to take effect (Actually, the part of "make
! 94: install" starting with "rm gforth.fi" is sufficient).
! 95:
! 96:
1.12 anton 97: Multiple Versions and Deinstallation
98:
99: Several versions of Gforth can be installed and used at the same
100: time. Version `foo' can be invoked with `gforth-foo'. We recommend to
101: keep the old version for some time after a new one has been installed.
1.10 anton 102:
1.12 anton 103: You can deinstall this version of Gforth with 'make uninstall' and
104: version foo with 'make uninstall VERSION=foo'. 'make uninstall' also
105: tells you how to uninstall Gforth completely.
1.13 ! anton 106:
1.10 anton 107:
1.12 anton 108: A Possible Problem
1.10 anton 109:
110: You need to read this only if you see a message like
111:
112: "gforth: Cannot load nonrelocatable image (compiled for address 0x1234) at address 0x5678
113: The Gforth installer should look into the INSTALL file"
114:
1.11 anton 115: Gforth supports both relocatable and fixed-address images. If you load
1.10 anton 116: normal Forth code and save the image, you get a fixed-address
117: image. Producing a relocatable image is more difficult.
118:
1.11 anton 119: Therefore, Gforth has only a relocatable image of the kernel
1.10 anton 120: (kernal.fi), which is powerful enough to load the rest of
121: Gforth. However, loading the rest takes a noticable amount of time. To
1.11 anton 122: avoid this delay (which would occur on every startup), the
123: installation procedure produces an image fixed at an address
124: determined at the Gforth run that produced the image. This
125: fixed-address image is loaded by default. On most OSs this works,
126: because the first chunk of memory is always allocated at the same
127: address. If the address changes, you get the message above.
1.10 anton 128:
129: An image address change can be caused by a change of the gforth
130: executable, or by a change (upgrade) of the OS; in these cases you
131: just have to rebuild and reinstall the fixed address image with
132:
133: rm gforth.fi; make gforth.fi; make install
134:
135: If you get such a message with a different address in place of the
136: 0x5678 each time you try to start gforth, you cannot use fixed-address
137: images on your OS. In this case, send us a message so that we start
138: searching for a comfortable solution to this problem. In the
139: meantime, start gforth with
140:
141: gforth -i kernal.fi startup.fs
142:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>