Annotation of gforth/INSTALL, revision 1.12

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

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