File:  [gforth] / gforth / INSTALL
Revision 1.15: download - view: text, annotated - select for diffs
Wed Nov 29 20:20:32 1995 UTC (25 years, 11 months ago) by anton
Branches: MAIN
CVS tags: HEAD
replced tester.fs and coretest.fs with the new versions from John Hayes
make mostlyclean virtualclean added
Cache-flushing now works on the Alpha (other minor changes there)
configure now uses gcc by default and passes its GCC variable to the Makefile
introduced sourcefilename and sourceline# (and used them in many places).

    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:
   37: 
   38: env GCC=gcc-2.7.1 ./configure
   39: 
   40: After, configuration, type
   41: 
   42: make
   43: 
   44: Now you can check whether your shiny new Forth system works. Say
   45: 
   46: make test
   47: 
   48: You can run some benchmarks with
   49: 
   50: make bench
   51: 
   52: and compare them with the results in Benchres and in the manual.
   53: 
   54: If everything is all right, you may want to install gforth. Type
   55: 
   56: make install
   57: 
   58: You have to make an entry in the info directory file manually.
   59: 
   60: For paper documentation, print gforth.ps (a Postscript file (300dpi
   61: fonts, i.e., it works, but does not produce best quality on better
   62: printers)), or say
   63: 
   64: make gforth.dvi
   65: 
   66: and print the resulting file gforth.dvi. You can also get the
   67: documentation in HTML format by typing
   68: 
   69: make html
   70: 
   71: 
   72: 		Preloading installation-specific code
   73: 
   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.
   84: 
   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.
   88: 
   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 gforth.fi" is sufficient).
   92: 
   93: 
   94: 		Multiple Versions and Deinstallation
   95: 
   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.
   99: 
  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.
  103: 
  104: 
  105: 			A Possible Problem
  106: 
  107: You need to read this only if you see a message like
  108: 
  109: "gforth: Cannot load nonrelocatable image (compiled for address 0x1234) at address 0x5678
  110: The Gforth installer should look into the INSTALL file"
  111: 
  112: Gforth supports both relocatable and fixed-address images. If you load
  113: normal Forth code and save the image, you get a fixed-address
  114: image. Producing a relocatable image is more difficult.
  115: 
  116: Therefore, Gforth has only a relocatable image of the kernel
  117: (kernal.fi), which is powerful enough to load the rest of
  118: Gforth. However, loading the rest takes a noticable amount of time. To
  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.
  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
  129: 
  130: rm gforth.fi; make gforth.fi; make install
  131: 
  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
  137: 
  138: gforth -i kernal.fi startup.fs
  139: 

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