1: You need gcc version 2.0 or later to compile gforth.
3: First, type
7: (see Section Configuration Options below for details).
9: After configuration, type
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 (see
28: Installing Info Files, below).
30: For paper documentation, print gforth.ps (a Postscript file (300dpi
31: fonts, i.e., it works, but does not produce best quality on better
32: printers)), or say
34: make gforth.dvi
36: and print the resulting file gforth.dvi. You can also get the
37: documentation in HTML format by typing
39: make html
41: If you prefer plain ASCII documentation, you can
43: make doc/gforth.txt
45: or just concatenate the files gforth.info-* ('cat gforth.info-*' under
46: Unix); the result of the latter option is a little worse.
48: You can find binary distributions, documentation in HTML and plain
49: text format and information on known installation problems at
53: Configuration Options
55: If you use GNU make, you can build in a directory different from the
56: source directory by changing to the build directory and invoking
57: configure thus:
61: where $srcdir is the source directory. (Note that we tested this only
62: for installation; i.e., if you want to hack the Gforth sources, you
63: should probably build in the source directory).
65: configure has the following useful parameters:
66: --prefix=PREFIX install architecture-independent files in PREFIX
67: [default: /usr/local]
68: --exec-prefix=PREFIX install architecture-dependent files in PREFIX
69: [default: same as prefix]
70: --enable-force-reg Use explicit register declarations if they appear in
71: the machine.h file. This can cause a good speedup,
72: but also incorrect code with some gcc versions on
73: some processors (default disabled).
74: --enable-direct-threaded Force direct threading. This may not work on
75: some machines and may cause slowdown on others.
76: (default processor-dependent)
77: --enable-indirect-threaded Force indirect threading. This can cause a
78: slowdown on some machines.
79: (default processor-dependent)
80: --with-debug specifies option -g to compile with debug info (default)
81: --without-debug omits the -g switch and creates smaller images on
82: machines where strip has problems with gcc style
83: debugging informations.
84: --help: tells you about other parameters.
86: The file Benchres shows which combination of the -enable options we
87: tried gave the best results for various machines.
89: If you don't like the defaults for the installation directories, you
90: should override them already during configure. E.g., if you want to
91: install in the /gnu hierarchy instead of in the default /usr/local
92: hierarchy, say
94: ./configure --prefix=/gnu
96: Moreover, if your GCC is not called gcc (but, e.g., gcc-2.7.1), you
97: should say so during configuration. E.g.:
99: env CC=gcc-2.7.1 ./configure
101: You can also pass additional options to gcc in this way, e.g., if you
102: want to generate an a.out executable under Linux with gcc-2.7.0:
104: env "CC=gcc -b i486-linuxaout -V 2.7.0" ./configure
106: You can change the sizes of the various areas used in the default
107: image `gforth.fi' by passing the appropriate Gforth command line
108: options in the FORTHSIZES environment variable:
110: env "FORTHSIZES=--dictionary-size=256k --data-stack-size=16k --fp-stack-size=15872b --return-stack-size=15k --locals-stack-size=14848b" ./configure
112: The line above reaffirms the default sizes. Note that the locals
113: stack area is also used as input buffer stack.
115: If C's "long long" do not work properly on your machine (i.e., if the
116: tests involving double-cell numbers fail), you can build Gforth such
117: that it does not use "long long":
119: env ac_cv_sizeof_long_long=0 ./configure
124: A few tests made by the configure script do not work in a
125: cross-compilation situation. You have to provide the results of these
126: tests by hand. E.g., if you compile for a 386 architecture processor:
128: env ac_cv_sizeof_char_p=4 ac_cv_sizeof_short=2 ac_cv_sizeof_int=4 ac_cv_sizeof_long=4 ac_cv_sizeof_long_long=8 ac_cv_c_bigendian=no ./configure
130: The ac_cv_sizeof_... variables give the sizes of various C types;
131: ac_cv_sizeof_char_p is the same as "sizeof(char*)" in C code. The
132: ac_cv_c_bigendian variable gives the byte order.
135: Preloading installation-specific code
137: If you want to have some installation-specific files loaded when
138: Gforth starts (e.g., an assembler for your processor), put commands
139: for loading them into /usr/local/share/gforth/site-forth/siteinit.fs
140: (if the commands work for all architectures) or
141: /usr/local/lib/gforth/site-forth/siteinit.fs (for
142: architecture-specific commands);
143: /usr/local/lib/gforth/site-forth/siteinit.fs takes precedence if both
144: files are present (unless you change the search path). The file names
145: given above are the defaults; if you have changed the prefix, you have
146: to replace "/usr/local" in these names with your prefix.
148: By default, the installation procedure creates an empty
149: /usr/local/share/gforth/site-forth/siteinit.fs if there is no such
152: If you change the siteinit.fs file, you should run "make install"
153: again for the changes to take effect (Actually, the part of "make
154: install" starting with "rm gforth.fi" is sufficient).
157: Multiple Versions and Deinstallation
159: Several versions of Gforth can be installed and used at the same
160: time. Version `foo' can be invoked with `gforth-foo'. We recommend to
161: keep the old version for some time after a new one has been installed.
163: You can deinstall this version of Gforth with 'make uninstall' and
164: version foo with 'make uninstall VERSION=foo'. 'make uninstall' also
165: tells you how to uninstall Gforth completely.
168: Installing Info Files
170: Info is the GNU project on-line documentation format. You can read
171: info files either from within Emacs (Ctrl-h i) or using the
172: stand-alone Info reader, 'info'.
174: If you use the default install root of '/usr/local' then the info
175: files will be installed in '/usr/local/info'.
177: Many GNU/Linux distributions are set up to put all of their
178: documentation in '/usr/info', in which case you might have to do a
179: couple of things to get your environment set up to accommodate files
180: in both areas:
182: 1. Add an INFOPATH environment variable. The easiest place to do
183: this is '/etc/profile', right next to PATH and MANPATH:
187: 2. Create a file called 'dir' in 'usr/local/info'. Use the file
188: '/usr/info/dir' as a template. You can add the line for gforth
189: manually, or use '/sbin/install-info' (man install-info for details).