File:  [gforth] / gforth / INSTALL
Revision 1.19: download - view: text, annotated - select for diffs
Fri May 3 13:05:04 1996 UTC (23 years, 3 months ago) by anton
Branches: MAIN
CVS tags: HEAD
added postponetest.fs
added perform (primitive)
minor changes

    1: You need gcc version 2.0 or later to compile gforth.
    2: 
    3: First, type
    4: 
    5: ./configure
    6: 
    7: configure has the following useful parameters:
    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]
   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.
   27: 
   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: hierarchy, say
   32: 
   33: ./configure --prefix=/gnu
   34: 
   35: Moreover, if your GCC is not called gcc (but, e.g., gcc-2.7.1), you
   36: should say so during configuration. E.g.:
   37: 
   38: env CC=gcc-2.7.1 ./configure
   39: 
   40: You can also pass additional options to gcc in this way, e.g., if you
   41: want to generate an a.out executable under Linux with gcc-2.7.0:
   42: 
   43: env "CC=gcc -b i486-linuxaout -V 2.7.0" ./configure
   44: 
   45: After, configuration, type
   46: 
   47: make
   48: 
   49: Now you can check whether your shiny new Forth system works. Say
   50: 
   51: make test
   52: 
   53: You can run some benchmarks with
   54: 
   55: make bench
   56: 
   57: and compare them with the results in Benchres and in the manual.
   58: 
   59: If everything is all right, you may want to install gforth. Type
   60: 
   61: make install
   62: 
   63: You have to make an entry in the info directory file manually.
   64: 
   65: For paper documentation, print gforth.ps (a Postscript file (300dpi
   66: fonts, i.e., it works, but does not produce best quality on better
   67: printers)), or say
   68: 
   69: make gforth.dvi
   70: 
   71: and print the resulting file gforth.dvi. You can also get the
   72: documentation in HTML format by typing
   73: 
   74: make html
   75: 
   76: If you prefer plain ASCII documentation, just concatenate the files
   77: gforth.info-* ('cat gforth.info-*' under Unix).
   78: 
   79: 		Preloading installation-specific code
   80: 
   81: If you want to have some installation-specific files loaded when
   82: Gforth starts (e.g., an assembler for your processor), put commands
   83: for loading them into /usr/local/share/gforth/site-forth/site-init.fs
   84: (if the commands work for all architectures) or
   85: /usr/local/lib/gforth/site-forth/site-init.fs (for
   86: architecture-specific commands);
   87: /usr/local/lib/gforth/site-forth/site-init.fs takes precedence if both
   88: files are present (unless you change the search path). The file names
   89: given above are the defaults; if you have changed the prefix, you have
   90: to replace "/usr/local" in these names with your prefix.
   91: 
   92: By default, the installation procedure creates an empty
   93: /usr/local/share/gforth/site-forth/site-init.fs if there is no such
   94: file.
   95: 
   96: If you change the site-init.fs file, you should run "make install"
   97: again for the changes to take effect (Actually, the part of "make
   98: install" starting with "rm gforth.fi" is sufficient).
   99: 
  100: 
  101: 		Multiple Versions and Deinstallation
  102: 
  103: Several versions of Gforth can be installed and used at the same
  104: time. Version `foo' can be invoked with `gforth-foo'. We recommend to
  105: keep the old version for some time after a new one has been installed.
  106: 
  107: You can deinstall this version of Gforth with 'make uninstall' and
  108: version foo with 'make uninstall VERSION=foo'. 'make uninstall' also
  109: tells you how to uninstall Gforth completely.
  110: 
  111: 
  112: 			A Possible Problem
  113: 
  114: You need to read this only if you see a message like
  115: 
  116: ...
  117: The Gforth installer should look into the INSTALL file
  118: 
  119: 1) "gforth: Cannot load nonrelocatable image (compiled for address $1234) at address $5678
  120: The Gforth installer should look into the INSTALL file"
  121: 
  122: Gforth supports both relocatable and fixed-address images. If you load
  123: normal Forth code and save the image, you get a fixed-address
  124: image. Producing a relocatable image is more difficult.
  125: 
  126: Therefore, Gforth has only a relocatable image of the kernel
  127: (kernal.fi), which is powerful enough to load the rest of
  128: Gforth. However, loading the rest takes a noticable amount of time. To
  129: avoid this delay (which would occur on every startup), the
  130: installation procedure produces an image fixed at an address
  131: determined at the Gforth run that produced the image. This
  132: fixed-address image is loaded by default. On most OSs this works,
  133: because the first chunk of memory is always allocated at the same
  134: address. If the address changes, you get the message above.
  135: 
  136: An image address change can be caused by a change of the gforth
  137: executable, or by a change (upgrade) of the OS; in these cases you
  138: just have to rebuild and reinstall the fixed address image with
  139: 
  140: rm gforth.fi; make gforth.fi; make install
  141: 
  142: If you get such a message with a different address in place of the
  143: $5678 each time you try to start gforth, you cannot use fixed-address
  144: images on your OS. In this case, send us a message so that we start
  145: searching for a comfortable solution to this problem. In the
  146: meantime, start gforth with
  147: 
  148: gforth -i kernal.fi startup.fs
  149: 
  150: 
  151: 2) "%s: Checksum of image ($13579b) does not match the executable ($2468a)
  152: The Gforth installer should look into the INSTALL file"
  153: 
  154: A fixed-address image is not only fixed with respect to its base
  155: address, but also with respect to certain addresses in the gforth
  156: executable and the threading method. These things are encoded in a
  157: checksum.
  158: 
  159: If the checksum of the executable and the checksum of the image are
  160: not equal, you get the message above. This can be caused, e.g., by
  161: trying to run an image produced for a direct threading system on an
  162: indirect threaded system.
  163: 
  164: Chances are that you unintentionally tried to execute an image from
  165: the wrong directory. As a remedy, you can determine Gforth's search
  166: path with the "-p" command line option and with the GFORTHPATH
  167: environment variable.
  168: 
  169: On the other hand, if you need to solve the problem by creating a new
  170: fixed-address image, you can use the steps described above.
  171: 
  172: 

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