Diff for /gforth/INSTALL between versions 1.8 and 1.21

version 1.8, 1995/04/06 16:56:06 version 1.21, 1996/09/30 13:16:06
Line 4  First, type Line 4  First, type
   
 ./configure  ./configure
   
   (see Section Configuration Options below for details).
   
   After configuration, type
   
   make
   
   Now you can check whether your shiny new Forth system works. Say
   
   make test
   
   You can run some benchmarks with
   
   make bench
   
   and compare them with the results in Benchres and in the manual.
   
   If everything is all right, you may want to install gforth. Type
   
   make install
   
   You have to make an entry in the info directory file manually.
   
   For paper documentation, print gforth.ps (a Postscript file (300dpi
   fonts, i.e., it works, but does not produce best quality on better
   printers)), or say
   
   make gforth.dvi
   
   and print the resulting file gforth.dvi. You can also get the
   documentation in HTML format by typing
   
   make html
   
   If you prefer plain ASCII documentation, just concatenate the files
   gforth.info-* ('cat gforth.info-*' under Unix).
   
   
                   Configuration Options
   
   You can build in a directory different from the source directory by
   changing to the build directory and invoking configure thus:
   
   $srcdir/configure
   
   where $srcdir is the source directory (Note that we tested this only
   for installation; i.e., if you want to hack the Gforth sources, you
   should probably build in the source directory).
   
 configure has the following useful parameters:  configure has the following useful parameters:
     --prefix=PREFIX         install architecture-independent files in PREFIX
                             [default: /usr/local]
     --exec-prefix=PREFIX    install architecture-dependent files in PREFIX
                             [default: same as prefix]
   --enable-force-reg      Use explicit register declarations if they appear in    --enable-force-reg      Use explicit register declarations if they appear in
                           the machine.h file. This can cause a good speedup,                            the machine.h file. This can cause a good speedup,
                           but also incorrect code with some gcc versions on                            but also incorrect code with some gcc versions on
Line 21  configure has the following useful param Line 73  configure has the following useful param
                     debugging informations.                      debugging informations.
   --help: tells you about other parameters.    --help: tells you about other parameters.
   
   The file Benchres shows which combination of the -enable options we
   tried gave the best results for various machines.
   
 Now type  If you don't like the defaults for the installation directories, you
   should override them already during configure.  E.g., if you want to
   install in the /gnu hierarchy instead of in the default /usr/local
   hierarchy, say
   
 make  ./configure --prefix=/gnu
   
 If your make has trouble with the Makefile, "make gforth" might work.  Moreover, if your GCC is not called gcc (but, e.g., gcc-2.7.1), you
   should say so during configuration. E.g.:
   
 If your installed gcc isn't called "gcc" (eg. called "gcc-2.6.1"), type  env CC=gcc-2.7.1 ./configure
   
 make GCC=<whatever you call your gcc>  You can also pass additional options to gcc in this way, e.g., if you
   want to generate an a.out executable under Linux with gcc-2.7.0:
   
 instead.  env "CC=gcc -b i486-linuxaout -V 2.7.0" ./configure
   
 Now you can check whether your shiny new Forth system works. Say  
   
 make test                  Preloading installation-specific code
   
 To make the documentation, type  If you want to have some installation-specific files loaded when
   Gforth starts (e.g., an assembler for your processor), put commands
   for loading them into /usr/local/share/gforth/site-forth/site-init.fs
   (if the commands work for all architectures) or
   /usr/local/lib/gforth/site-forth/site-init.fs (for
   architecture-specific commands);
   /usr/local/lib/gforth/site-forth/site-init.fs takes precedence if both
   files are present (unless you change the search path). The file names
   given above are the defaults; if you have changed the prefix, you have
   to replace "/usr/local" in these names with your prefix.
   
 make -k gforth.info gforth.ps html  By default, the installation procedure creates an empty
   /usr/local/share/gforth/site-forth/site-init.fs if there is no such
   file.
   
 If everything is allright, you may want to install gforth. Type  If you change the site-init.fs file, you should run "make install"
   again for the changes to take effect (Actually, the part of "make
   install" starting with "rm gforth.fi" is sufficient).
   
 make install  
   
 You may want to override the defaults for the directories. E.g., if                  Multiple Versions and Deinstallation
 you want to install in the /gnu hierarchy instead of in the default  
 /usr/local hirarchy, say  Several versions of Gforth can be installed and used at the same
   time. Version `foo' can be invoked with `gforth-foo'. We recommend to
   keep the old version for some time after a new one has been installed.
   
   You can deinstall this version of Gforth with 'make uninstall' and
   version foo with 'make uninstall VERSION=foo'. 'make uninstall' also
   tells you how to uninstall Gforth completely.
   
   
                           A Possible Problem
   
   You need to read this only if you see a message like
   
   ...
   The Gforth installer should look into the INSTALL file
   
   1) "gforth: Cannot load nonrelocatable image (compiled for address $1234) at address $5678
   The Gforth installer should look into the INSTALL file"
   
   Gforth supports both relocatable and fixed-address images. If you load
   normal Forth code and save the image, you get a fixed-address
   image. Producing a relocatable image is more difficult.
   
   Therefore, Gforth has only a relocatable image of the kernel
   (kernel.fi), which is powerful enough to load the rest of
   Gforth. However, loading the rest takes a noticable amount of time. To
   avoid this delay (which would occur on every startup), the
   installation procedure produces an image fixed at an address
   determined at the Gforth run that produced the image. This
   fixed-address image is loaded by default. On most OSs this works,
   because the first chunk of memory is always allocated at the same
   address. If the address changes, you get the message above.
   
   An image address change can be caused by a change of the gforth
   executable, or by a change (upgrade) of the OS; in these cases you
   just have to rebuild and reinstall the fixed address image with
   
   rm gforth.fi; make gforth.fi; make install
   
   If you get such a message with a different address in place of the
   $5678 each time you try to start gforth, you cannot use fixed-address
   images on your OS. In this case, send us a message so that we start
   searching for a comfortable solution to this problem. In the
   meantime, start gforth with
   
   gforth -i kernel.fi startup.fs
   
   
   2) "%s: Checksum of image ($13579b) does not match the executable ($2468a)
   The Gforth installer should look into the INSTALL file"
   
   A fixed-address image is not only fixed with respect to its base
   address, but also with respect to certain addresses in the gforth
   executable and the threading method. These things are encoded in a
   checksum.
   
   If the checksum of the executable and the checksum of the image are
   not equal, you get the message above. This can be caused, e.g., by
   trying to run an image produced for a direct threading system on an
   indirect threaded system.
   
   Chances are that you unintentionally tried to execute an image from
   the wrong directory. As a remedy, you can specify Gforth's search
   path with the "-p" command line option and with the GFORTHPATH
   environment variable.
   
   On the other hand, if you need to solve the problem by creating a new
   fixed-address image, you can use the steps described above.
   
 make install prefix=/gnu  
   
 Alternatively, you can specify the prefixes with configure.  

Removed from v.1.8  
changed lines
  Added in v.1.21


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