- view: text
- select for diffs
Wed Jan 22 18:05:19 2003 UTC
(18 years, 10 months ago) by anton
CVS tags: HEAD
Declared some environment variables in configure.in
cleaned up PEEPHOLE configuration options (no longer used in C code)
related documentation changes in INSTALL
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 check
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: --help: tells you about other parameters.
76: The file Benchres shows which combination of the -enable options we
77: tried gave the best results for various machines.
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
82: hierarchy, say
84: ./configure --prefix=/gnu
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.:
89: env CC=gcc-2.7.1 ./configure
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:
94: env "CC=gcc -b i486-linuxaout -V 2.7.0" ./configure
96: You can change the sizes of the various areas used in the default
97: image `gforth.fi' by passing the appropriate Gforth command line
98: options in the FORTHSIZES environment variable:
100: env "FORTHSIZES=--dictionary-size=256k --data-stack-size=16k --fp-stack-size=15872b --return-stack-size=15k --locals-stack-size=14848b" ./configure
102: The line above reaffirms the default sizes. Note that the locals
103: stack area is also used as input buffer stack.
105: If C's "long long" do not work properly on your machine (i.e., if the
106: tests involving double-cell numbers fail), you can build Gforth such
107: that it does not use "long long":
109: env ac_cv_sizeof_long_long=0 ./configure
114: You need a cross-compilation toolchain for your target including gcc
115: (2.0 or later).
117: The first step in cross-installation is the cross-configuration. A
118: few tests made by the configure script do not work in a
119: cross-compilation situation. You have to provide the results of these
120: tests by hand. E.g., if you compile for a 386 architecture processor:
122: 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
124: The ac_cv_sizeof_... variables give the sizes of various C types;
125: ac_cv_sizeof_char_p is the same as "sizeof(char*)" in C code. The
126: ac_cv_c_bigendian variable gives the byte order.
128: After the cross-configuration you type
130: make gforths
132: This produces the gforth engines for the target.
134: The next step is to transfer everything to the target; on the target,
135: you do
139: to complete building gforth. If you do not have a make on the target,
142: make -n
144: on the host; manually execute on the target the last command output by
145: "make -n" (GFORTHD=...); the other commands output by "make -n" are
146: not necessary unless you have changed the Gforth sources. You can
147: then check and benchmark Gforth with
149: make check
150: make bench
152: or equivalent. Finally, perform
154: make install
156: or the equivalent commands on the target.
159: Preloading installation-specific code
161: If you want to have some installation-specific files loaded when
162: Gforth starts (e.g., an assembler for your processor), put commands
163: for loading them into /usr/local/share/gforth/site-forth/siteinit.fs
164: (if the commands work for all architectures) or
165: /usr/local/lib/gforth/site-forth/siteinit.fs (for
166: architecture-specific commands);
167: /usr/local/lib/gforth/site-forth/siteinit.fs takes precedence if both
168: files are present (unless you change the search path). The file names
169: given above are the defaults; if you have changed the prefix, you have
170: to replace "/usr/local" in these names with your prefix.
172: By default, the installation procedure creates an empty
173: /usr/local/share/gforth/site-forth/siteinit.fs if there is no such
176: If you change the siteinit.fs file, you should run "make install"
177: again for the changes to take effect (Actually, the part of "make
178: install" starting with "rm gforth.fi" is sufficient).
181: Multiple Versions and Deinstallation
183: Several versions of Gforth can be installed and used at the same
184: time. Version `foo' can be invoked with `gforth-foo'. We recommend to
185: keep the old version for some time after a new one has been installed.
187: You can deinstall this version of Gforth with 'make uninstall' and
188: version foo with 'make uninstall VERSION=foo'. 'make uninstall' also
189: tells you how to uninstall Gforth completely.
192: Installing Info Files
194: Info is the GNU project on-line documentation format. You can read
195: info files either from within Emacs (Ctrl-h i) or using the
196: stand-alone Info reader, 'info'.
198: If you use the default install root of '/usr/local' then the info
199: files will be installed in '/usr/local/info'.
201: Many GNU/Linux distributions are set up to put all of their
202: documentation in '/usr/info', in which case you might have to do a
203: couple of things to get your environment set up to accommodate files
204: in both areas:
206: 1. Add an INFOPATH environment variable. The easiest place to do
207: this is '/etc/profile', right next to PATH and MANPATH:
211: 2. Create a file called 'dir' in 'usr/local/info'. Use the file
212: '/usr/info/dir' as a template. You can add the line for gforth
213: manually, or use '/sbin/install-info' (man install-info for details).