Diff for /gforth/INSTALL between versions 1.13 and 1.22

version 1.13, 1995/11/24 18:05:31 version 1.22, 1996/10/28 17:24:30
Line 4  First, type Line 4  First, type
   
 ./configure  ./configure
   
 configure has the following useful parameters:  (see Section Configuration Options below for details).
   --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  
                           the machine.h file. This can cause a good speedup,  
                           but also incorrect code with some gcc versions on  
                           some processors (default disabled).  
   --enable-direct-threaded      Force direct threading. This may not work on  
                                 some machines and may cause slowdown on others.  
                                 (default processor-dependent)  
   --enable-indirect-threaded    Force indirect threading. This can cause a  
                                 slowdown on some machines.  
                                 (default processor-dependent)  
   --with-debug     specifies option -g to compile with debug info (default)  
    --without-debug  omits the -g switch and creates smaller images on  
                     machines where strip has problems with gcc style  
                     debugging informations.  
   --help: tells you about other parameters.  
   
 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  
 hirarchy, say  
   
 ./configure --prefix=/gnu  
   
 After, configuration, type  After configuration, type
   
 make  make
   
 If your make has trouble with the Makefile, "make gforth" might work.  
   
 If your installed gcc isn't called "gcc" (e.g., called "gcc-2.6.1"), type  
   
 make GCC=<whatever you call your gcc>  
   
 instead.  
   
 Now you can check whether your shiny new Forth system works. Say  Now you can check whether your shiny new Forth system works. Say
   
 make test  make test
Line 71  documentation in HTML format by typing Line 37  documentation in HTML format by typing
   
 make html  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. You need a VPATH-capable 'make'
   (e.g., GNU make) for this. (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:
     --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
                             the machine.h file. This can cause a good speedup,
                             but also incorrect code with some gcc versions on
                             some processors (default disabled).
     --enable-direct-threaded      Force direct threading. This may not work on
                                   some machines and may cause slowdown on others.
                                   (default processor-dependent)
     --enable-indirect-threaded    Force indirect threading. This can cause a
                                   slowdown on some machines.
                                   (default processor-dependent)
     --with-debug     specifies option -g to compile with debug info (default)
     --without-debug  omits the -g switch and creates smaller images on
                      machines where strip has problems with gcc style
                      debugging informations.
     --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.
   
   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
   
   ./configure --prefix=/gnu
   
   Moreover, if your GCC is not called gcc (but, e.g., gcc-2.7.1), you
   should say so during configuration. E.g.:
   
   env CC=gcc-2.7.1 ./configure
   
   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:
   
   env "CC=gcc -b i486-linuxaout -V 2.7.0" ./configure
   
   You can change the sizes of the various areas used in the default
   image `gforth.fi' by passing the appropriate Gforth command line
   options in the FORTHSIZES environment variable:
   
   env "FORTHSIZES=--dictionary-size=256k --data-stack-size=16k --fp-stack-size=16k --return-stack-size=16k --locals-stack-size=16k" ./configure
   
   The line above reaffirms the default sizes. Note that the locals
   stack area is also used as input buffer stack.
   
                 Preloading installation-specific code                  Preloading installation-specific code
   
Line 109  tells you how to uninstall Gforth comple Line 140  tells you how to uninstall Gforth comple
   
 You need to read this only if you see a message like  You need to read this only if you see a message like
   
 "gforth: Cannot load nonrelocatable image (compiled for address 0x1234) at address 0x5678  ...
   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"  The Gforth installer should look into the INSTALL file"
   
 Gforth supports both relocatable and fixed-address images. If you load  Gforth supports both relocatable and fixed-address images. If you load
Line 117  normal Forth code and save the image, yo Line 151  normal Forth code and save the image, yo
 image. Producing a relocatable image is more difficult.  image. Producing a relocatable image is more difficult.
   
 Therefore, Gforth has only a relocatable image of the kernel  Therefore, Gforth has only a relocatable image of the kernel
 (kernal.fi), which is powerful enough to load the rest of  (kernel.fi), which is powerful enough to load the rest of
 Gforth. However, loading the rest takes a noticable amount of time. To  Gforth. However, loading the rest takes a noticable amount of time. To
 avoid this delay (which would occur on every startup), the  avoid this delay (which would occur on every startup), the
 installation procedure produces an image fixed at an address  installation procedure produces an image fixed at an address
Line 133  just have to rebuild and reinstall the f Line 167  just have to rebuild and reinstall the f
 rm gforth.fi; make gforth.fi; make install  rm gforth.fi; make gforth.fi; make install
   
 If you get such a message with a different address in place of the  If you get such a message with a different address in place of the
 0x5678 each time you try to start gforth, you cannot use fixed-address  $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  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  searching for a comfortable solution to this problem. In the
 meantime, start gforth with  meantime, start gforth with
   
 gforth -i kernal.fi startup.fs  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.
   
   

Removed from v.1.13  
changed lines
  Added in v.1.22


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