Annotation of gforth/INSTALL, revision 1.15

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
1.15    ! anton      31: hierarchy, say
1.5       anton      32: 
1.9       anton      33: ./configure --prefix=/gnu
1.2       anton      34: 
1.15    ! anton      35: Moreover, if your GCC is not called gcc (but, e.g., gcc-2.7.1), you
        !            36: should say so during configuration:
        !            37: 
        !            38: env GCC=gcc-2.7.1 ./configure
        !            39: 
1.9       anton      40: After, configuration, type
1.5       anton      42: make
1.6       anton      43: 
1.7       anton      44: Now you can check whether your shiny new Forth system works. Say
                     46: make test
1.12      anton      48: You can run some benchmarks with
1.6       anton      49: 
1.12      anton      50: make bench
                     52: and compare them with the results in Benchres and in the manual.
1.7       anton      53: 
1.13      anton      54: If everything is all right, you may want to install gforth. Type
1.7       anton      55: 
                     56: make install
1.12      anton      58: You have to make an entry in the info directory file manually.
                     60: For paper documentation, print (a Postscript file (300dpi
                     61: fonts, i.e., it works, but does not produce best quality on better
                     62: printers)), or say
                     64: make gforth.dvi
                     66: and print the resulting file gforth.dvi. You can also get the
                     67: documentation in HTML format by typing
                     69: make html
1.13      anton      71: 
                     72:                Preloading installation-specific code
                     74: If you want to have some installation-specific files loaded when
                     75: Gforth starts (e.g., an assembler for your processor), put commands
                     76: for loading them into /usr/local/share/gforth/site-forth/site-init.fs
                     77: (if the commands work for all architectures) or
                     78: /usr/local/lib/gforth/site-forth/site-init.fs (for
                     79: architecture-specific commands);
                     80: /usr/local/lib/gforth/site-forth/site-init.fs takes precedence if both
                     81: files are present (unless you change the search path). The file names
                     82: given above are the defaults; if you have changed the prefix, you have
                     83: to replace "/usr/local" in these names with your prefix.
                     85: By default, the installation procedure creates an empty
                     86: /usr/local/share/gforth/site-forth/site-init.fs if there is no such
                     87: file.
                     89: If you change the site-init.fs file, you should run "make install"
                     90: again for the changes to take effect (Actually, the part of "make
                     91: install" starting with "rm" is sufficient).
1.12      anton      94:                Multiple Versions and Deinstallation
                     96: Several versions of Gforth can be installed and used at the same
                     97: time. Version `foo' can be invoked with `gforth-foo'. We recommend to
                     98: keep the old version for some time after a new one has been installed.
1.10      anton      99: 
1.12      anton     100: You can deinstall this version of Gforth with 'make uninstall' and
                    101: version foo with 'make uninstall VERSION=foo'. 'make uninstall' also
                    102: tells you how to uninstall Gforth completely.
1.13      anton     103: 
1.10      anton     104: 
1.12      anton     105:                        A Possible Problem
1.10      anton     106: 
                    107: You need to read this only if you see a message like
                    109: "gforth: Cannot load nonrelocatable image (compiled for address 0x1234) at address 0x5678
                    110: The Gforth installer should look into the INSTALL file"
1.11      anton     112: Gforth supports both relocatable and fixed-address images. If you load
1.10      anton     113: normal Forth code and save the image, you get a fixed-address
                    114: image. Producing a relocatable image is more difficult.
1.11      anton     116: Therefore, Gforth has only a relocatable image of the kernel
1.10      anton     117: (, which is powerful enough to load the rest of
                    118: Gforth. However, loading the rest takes a noticable amount of time. To
1.11      anton     119: avoid this delay (which would occur on every startup), the
                    120: installation procedure produces an image fixed at an address
                    121: determined at the Gforth run that produced the image. This
                    122: fixed-address image is loaded by default. On most OSs this works,
                    123: because the first chunk of memory is always allocated at the same
                    124: address. If the address changes, you get the message above.
1.10      anton     125: 
                    126: An image address change can be caused by a change of the gforth
                    127: executable, or by a change (upgrade) of the OS; in these cases you
                    128: just have to rebuild and reinstall the fixed address image with
                    130: rm; make; make install
                    132: If you get such a message with a different address in place of the
                    133: 0x5678 each time you try to start gforth, you cannot use fixed-address
                    134: images on your OS. In this case, send us a message so that we start
                    135: searching for a comfortable solution to this problem. In the
                    136: meantime, start gforth with
                    138: gforth -i startup.fs

FreeBSD-CVSweb <>