1: Copyright (C) 2003 Free Software Foundation, Inc.
2: This file is free documentation; the Free Software Foundation gives
3: unlimited permission to copy, distribute and modify it.
5: You need gcc version 2.0 or later to compile gforth.
7: First, type
11: (see Section Configuration Options below for details).
13: After configuration, type
17: Now you can check whether your shiny new Forth system works. Say
19: make check
21: You can run some benchmarks with
23: make bench
25: and compare them with the results in Benchres and in the manual.
27: If everything is all right, you may want to install gforth. Type
29: make install
31: You have to make an entry in the info directory file manually (see
32: Installing Info Files, below).
34: For paper documentation, print gforth.ps (a Postscript file (300dpi
35: fonts, i.e., it works, but does not produce best quality on better
36: printers)), or say
38: make gforth.dvi
40: and print the resulting file gforth.dvi. You can also get the
41: documentation in HTML format by typing
43: make html
45: If you prefer plain ASCII documentation, you can
47: make doc/gforth.txt
49: or just concatenate the files gforth.info-* ('cat gforth.info-*' under
50: Unix); the result of the latter option is a little worse.
52: You can find binary distributions, documentation in HTML and plain
53: text format and information on known installation problems at
57: Configuration Options
59: If you use GNU make, you can build in a directory different from the
60: source directory by changing to the build directory and invoking
61: configure thus:
65: where $srcdir is the source directory. (Note that we tested this only
66: for installation; i.e., if you want to hack the Gforth sources, you
67: should probably build in the source directory).
69: configure has the following useful parameters:
70: --prefix=PREFIX install architecture-independent files in PREFIX
71: [default: /usr/local]
72: --exec-prefix=PREFIX install architecture-dependent files in PREFIX
73: [default: same as prefix]
74: --enable-force-reg Use explicit register declarations if they appear in
75: the machine.h file. This can cause a good speedup,
76: but also incorrect code with some gcc versions on
77: some processors (default disabled).
78: --help: tells you about other parameters.
80: The file Benchres shows which combination of the -enable options we
81: tried gave the best results for various machines.
83: If you don't like the defaults for the installation directories, you
84: should override them already during configure. E.g., if you want to
85: install in the /gnu hierarchy instead of in the default /usr/local
86: hierarchy, say
88: ./configure --prefix=/gnu
90: Moreover, if your GCC is not called gcc (but, e.g., gcc-2.7.1), you
91: should say so during configuration. E.g.:
93: env CC=gcc-2.7.1 ./configure
95: You can also pass additional options to gcc in this way, e.g., if you
96: want to generate an a.out executable under Linux with gcc-2.7.0:
98: env "CC=gcc -b i486-linuxaout -V 2.7.0" ./configure
100: You can change the sizes of the various areas used in the default
101: image `gforth.fi' by passing the appropriate Gforth command line
102: options in the FORTHSIZES environment variable:
104: env "FORTHSIZES=--dictionary-size=256k --data-stack-size=16k --fp-stack-size=15872b --return-stack-size=15k --locals-stack-size=14848b" ./configure
106: The line above reaffirms the default sizes. Note that the locals
107: stack area is also used as input buffer stack.
109: If C's "long long" do not work properly on your machine (i.e., if the
110: tests involving double-cell numbers fail), you can build Gforth such
111: that it does not use "long long":
113: env ac_cv_sizeof_long_long=0 ./configure
118: You need a cross-compilation toolchain for your target including gcc
119: (2.0 or later).
121: The first step in cross-installation is the cross-configuration. A
122: few tests made by the configure script do not work in a
123: cross-compilation situation. You have to provide the results of these
124: tests by hand. E.g., if you compile for a 386 architecture processor:
126: env ac_cv_sizeof_char_p=4 ac_cv_sizeof_char=1 ac_cv_sizeof_short=2 ac_cv_sizeof_int=4 ac_cv_sizeof_long=4 ac_cv_sizeof_long_long=8 ac_cv_sizeof_intptr_t=4 ac_cv_sizeof_int128_t=0 ac_cv_c_bigendian=no ./configure
128: The ac_cv_sizeof_... variables give the sizes of various C types;
129: ac_cv_sizeof_char_p is the same as "sizeof(char*)" in C code. The
130: ac_cv_c_bigendian variable gives the byte order.
132: After the cross-configuration you type
134: make gforths
136: This produces the gforth engines for the target.
138: The next step is to transfer everything to the target; on the target,
139: you do
143: to complete building gforth. If you do not have a make on the target,
146: make -n
148: on the host; manually execute on the target the last command output by
149: "make -n" (GFORTHD=...); the other commands output by "make -n" are
150: not necessary unless you have changed the Gforth sources. You can
151: then check and benchmark Gforth with
153: make check
154: make bench
156: or equivalent. Finally, perform
158: make install
160: or the equivalent commands on the target.
163: Preloading installation-specific code
165: If you want to have some installation-specific files loaded when
166: Gforth starts (e.g., an assembler for your processor), put commands
167: for loading them into /usr/local/share/gforth/site-forth/siteinit.fs
168: (if the commands work for all architectures) or
169: /usr/local/lib/gforth/site-forth/siteinit.fs (for
170: architecture-specific commands);
171: /usr/local/lib/gforth/site-forth/siteinit.fs takes precedence if both
172: files are present (unless you change the search path). The file names
173: given above are the defaults; if you have changed the prefix, you have
174: to replace "/usr/local" in these names with your prefix.
176: By default, the installation procedure creates an empty
177: /usr/local/share/gforth/site-forth/siteinit.fs if there is no such
180: If you change the siteinit.fs file, you should run "make install"
181: again for the changes to take effect (Actually, the part of "make
182: install" starting with "rm gforth.fi" is sufficient).
185: Multiple Versions and Deinstallation
187: Several versions of Gforth can be installed and used at the same
188: time. Version `foo' can be invoked with `gforth-foo'. We recommend to
189: keep the old version for some time after a new one has been installed.
191: You can deinstall this version of Gforth with 'make uninstall' and
192: version foo with 'make uninstall VERSION=foo'. 'make uninstall' also
193: tells you how to uninstall Gforth completely.
196: Installing Info Files
198: Info is the GNU project on-line documentation format. You can read
199: info files either from within Emacs (Ctrl-h i) or using the
200: stand-alone Info reader, 'info'.
202: If you use the default install root of '/usr/local' then the info
203: files will be installed in '/usr/local/info'.
205: Many GNU/Linux distributions are set up to put all of their
206: documentation in '/usr/info', in which case you might have to do a
207: couple of things to get your environment set up to accommodate files
208: in both areas:
210: 1. Add an INFOPATH environment variable. The easiest place to do
211: this is '/etc/profile', right next to PATH and MANPATH:
215: 2. Create a file called 'dir' in 'usr/local/info'. Use the file
216: '/usr/info/dir' as a template. You can add the line for gforth
217: manually, or use '/sbin/install-info' (man install-info for details).