Annotation of gforth/INSTALL, revision 1.14

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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>