Annotation of gforth/INSTALL, revision 1.39
1.38 anton 1: Copyright (C) 2003,2007 Free Software Foundation, Inc.
1.33 anton 2: This file is free documentation; the Free Software Foundation gives
3: unlimited permission to copy, distribute and modify it.
4:
1.35 anton 5:
6: Prerequisites
7:
1.37 anton 8: You need gcc version 2.0 or later to compile gforth.
1.35 anton 9:
1.37 anton 10: For the (documented) libcc.fs C interface you need a C compiler at
11: run-time.
12:
13: For the (undocumented ) lib.fs C interface you need to install either
14: the ffcall libraries or the libffi library. Libffi comes with recent
15: gccs, ffcall can be found on
1.35 anton 16:
17: ftp://ftp.santafe.edu/pub/gnu/ffcall-1.8.tar.gz (USA)
18: ftp://ftp.ilog.fr/pub/Users/haible/gnu/ffcall-1.8.tar.gz (Europe)
19:
1.37 anton 20: On many architectures (exceptions: 386, PPC, MIPS, Alpha) you need gdb
21: at run-time in order for the disassembler to work.
22:
1.35 anton 23:
24: Building and Installing
1.1 anton 25:
1.5 anton 26: First, type
1.3 anton 27:
1.8 anton 28: ./configure
1.1 anton 29:
1.21 anton 30: (see Section Configuration Options below for details).
31:
32: After configuration, type
33:
34: make
35:
1.39 ! pazsan 36: This includes a check whether your shiny new Forth system works. If
! 37: you like to invoke the check alone, do
1.21 anton 38:
1.30 anton 39: make check
1.21 anton 40:
41: You can run some benchmarks with
42:
43: make bench
44:
45: and compare them with the results in Benchres and in the manual.
46:
47: If everything is all right, you may want to install gforth. Type
48:
49: make install
50:
51: For paper documentation, print gforth.ps (a Postscript file (300dpi
52: fonts, i.e., it works, but does not produce best quality on better
53: printers)), or say
54:
55: make gforth.dvi
56:
57: and print the resulting file gforth.dvi. You can also get the
58: documentation in HTML format by typing
59:
60: make html
61:
1.28 anton 62: If you prefer plain ASCII documentation, you can
63:
64: make doc/gforth.txt
65:
66: or just concatenate the files gforth.info-* ('cat gforth.info-*' under
67: Unix); the result of the latter option is a little worse.
68:
69: You can find binary distributions, documentation in HTML and plain
70: text format and information on known installation problems at
71: http://www.complang.tuwien.ac.at/forth/gforth/.
1.21 anton 72:
73:
74: Configuration Options
75:
1.23 anton 76: If you use GNU make, you can build in a directory different from the
77: source directory by changing to the build directory and invoking
78: configure thus:
1.21 anton 79:
80: $srcdir/configure
81:
1.23 anton 82: where $srcdir is the source directory. (Note that we tested this only
1.21 anton 83: for installation; i.e., if you want to hack the Gforth sources, you
84: should probably build in the source directory).
85:
1.4 pazsan 86: configure has the following useful parameters:
1.9 anton 87: --prefix=PREFIX install architecture-independent files in PREFIX
88: [default: /usr/local]
89: --exec-prefix=PREFIX install architecture-dependent files in PREFIX
90: [default: same as prefix]
1.8 anton 91: --enable-force-reg Use explicit register declarations if they appear in
92: the machine.h file. This can cause a good speedup,
93: but also incorrect code with some gcc versions on
94: some processors (default disabled).
95: --help: tells you about other parameters.
1.1 anton 96:
1.21 anton 97: The file Benchres shows which combination of the -enable options we
98: tried gave the best results for various machines.
99:
1.9 anton 100: If you don't like the defaults for the installation directories, you
101: should override them already during configure. E.g., if you want to
102: install in the /gnu hierarchy instead of in the default /usr/local
1.15 anton 103: hierarchy, say
1.5 anton 104:
1.9 anton 105: ./configure --prefix=/gnu
1.2 anton 106:
1.17 anton 107: Moreover, if your GCC is not called gcc (but, e.g., gcc-2.7.1), you
108: should say so during configuration. E.g.:
1.16 pazsan 109:
1.35 anton 110: ./configure CC=gcc-2.7.1
1.16 pazsan 111:
1.17 anton 112: You can also pass additional options to gcc in this way, e.g., if you
113: want to generate an a.out executable under Linux with gcc-2.7.0:
1.15 anton 114:
1.35 anton 115: ./configure CC="gcc -b i486-linuxaout -V 2.7.0"
1.15 anton 116:
1.22 anton 117: You can change the sizes of the various areas used in the default
118: image `gforth.fi' by passing the appropriate Gforth command line
119: options in the FORTHSIZES environment variable:
120:
1.35 anton 121: ./configure "FORTHSIZES=--dictionary-size=256k --data-stack-size=16k --fp-stack-size=15872b --return-stack-size=15k --locals-stack-size=14848b"
1.22 anton 122:
123: The line above reaffirms the default sizes. Note that the locals
124: stack area is also used as input buffer stack.
1.17 anton 125:
1.24 anton 126: If C's "long long" do not work properly on your machine (i.e., if the
127: tests involving double-cell numbers fail), you can build Gforth such
128: that it does not use "long long":
129:
1.35 anton 130: ./configure ac_cv_sizeof_long_long=0
1.24 anton 131:
132:
1.31 anton 133: Cross-Installation
1.24 anton 134:
1.31 anton 135: You need a cross-compilation toolchain for your target including gcc
136: (2.0 or later).
137:
138: The first step in cross-installation is the cross-configuration. A
139: few tests made by the configure script do not work in a
1.24 anton 140: cross-compilation situation. You have to provide the results of these
1.36 anton 141: tests by hand. E.g., if you compile for an ARM:
1.24 anton 142:
1.36 anton 143: env skipcode=".skip 16" ac_cv_sizeof_char_p=4 ac_cv_sizeof_char=1 \
144: ac_cv_sizeof_short=2 ac_cv_sizeof_int=4 ac_cv_sizeof_long=4 \
145: ac_cv_sizeof_long_long=8 ac_cv_sizeof_intptr_t=4 ac_cv_sizeof_int128_t=0 \
146: ac_cv_c_bigendian=no ./configure CC=arm-elf-gcc --host=arm-linux
1.24 anton 147:
148: The ac_cv_sizeof_... variables give the sizes of various C types;
149: ac_cv_sizeof_char_p is the same as "sizeof(char*)" in C code. The
1.36 anton 150: ac_cv_c_bigendian variable gives the byte order. The skipcode
151: specifies how to skip 16 bytes in the code (use "skipcode=no" to
152: disable skipping and dynamic native code generation).
1.31 anton 153:
154: After the cross-configuration you type
155:
156: make gforths
157:
158: This produces the gforth engines for the target.
159:
160: The next step is to transfer everything to the target; on the target,
161: you do
162:
163: make
164:
165: to complete building gforth. If you do not have a make on the target,
166: run
167:
168: make -n
169:
170: on the host; manually execute on the target the last command output by
171: "make -n" (GFORTHD=...); the other commands output by "make -n" are
172: not necessary unless you have changed the Gforth sources. You can
173: then check and benchmark Gforth with
174:
175: make check
176: make bench
177:
178: or equivalent. Finally, perform
179:
180: make install
181:
182: or the equivalent commands on the target.
1.24 anton 183:
184:
1.17 anton 185: Preloading installation-specific code
186:
187: If you want to have some installation-specific files loaded when
188: Gforth starts (e.g., an assembler for your processor), put commands
1.28 anton 189: for loading them into /usr/local/share/gforth/site-forth/siteinit.fs
1.17 anton 190: (if the commands work for all architectures) or
1.28 anton 191: /usr/local/lib/gforth/site-forth/siteinit.fs (for
1.17 anton 192: architecture-specific commands);
1.28 anton 193: /usr/local/lib/gforth/site-forth/siteinit.fs takes precedence if both
1.17 anton 194: files are present (unless you change the search path). The file names
195: given above are the defaults; if you have changed the prefix, you have
196: to replace "/usr/local" in these names with your prefix.
197:
198: By default, the installation procedure creates an empty
1.28 anton 199: /usr/local/share/gforth/site-forth/siteinit.fs if there is no such
1.17 anton 200: file.
201:
1.28 anton 202: If you change the siteinit.fs file, you should run "make install"
1.17 anton 203: again for the changes to take effect (Actually, the part of "make
204: install" starting with "rm gforth.fi" is sufficient).
205:
206:
1.12 anton 207: Multiple Versions and Deinstallation
208:
209: Several versions of Gforth can be installed and used at the same
210: time. Version `foo' can be invoked with `gforth-foo'. We recommend to
211: keep the old version for some time after a new one has been installed.
1.10 anton 212:
1.12 anton 213: You can deinstall this version of Gforth with 'make uninstall' and
214: version foo with 'make uninstall VERSION=foo'. 'make uninstall' also
215: tells you how to uninstall Gforth completely.
1.29 crook 216:
217:
218: Installing Info Files
219:
220: Info is the GNU project on-line documentation format. You can read
221: info files either from within Emacs (Ctrl-h i) or using the
222: stand-alone Info reader, 'info'.
223:
224: If you use the default install root of '/usr/local' then the info
225: files will be installed in '/usr/local/info'.
226:
227: Many GNU/Linux distributions are set up to put all of their
228: documentation in '/usr/info', in which case you might have to do a
229: couple of things to get your environment set up to accommodate files
230: in both areas:
231:
232: 1. Add an INFOPATH environment variable. The easiest place to do
233: this is '/etc/profile', right next to PATH and MANPATH:
234:
235: INFOPATH=/usr/local/info:/usr/info
236:
237: 2. Create a file called 'dir' in 'usr/local/info'. Use the file
238: '/usr/info/dir' as a template. You can add the line for gforth
239: manually, or use '/sbin/install-info' (man install-info for details).
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>