Diff for /gforth/INSTALL between versions 1.26 and 1.30

version 1.26, 1997/02/01 14:59:27 version 1.30, 2000/09/27 18:31:47
Line 12  make Line 12  make
   
 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 check
   
 You can run some benchmarks with  You can run some benchmarks with
   
Line 24  If everything is all right, you may want Line 24  If everything is all right, you may want
   
 make install  make install
   
 You have to make an entry in the info directory file manually.  You have to make an entry in the info directory file manually (see
   Installing Info Files, below).
   
 For paper documentation, print gforth.ps (a Postscript file (300dpi  For paper documentation, print gforth.ps (a Postscript file (300dpi
 fonts, i.e., it works, but does not produce best quality on better  fonts, i.e., it works, but does not produce best quality on better
Line 37  documentation in HTML format by typing Line 38  documentation in HTML format by typing
   
 make html  make html
   
 If you prefer plain ASCII documentation, just concatenate the files  If you prefer plain ASCII documentation, you can 
 gforth.info-* ('cat gforth.info-*' under Unix).  
   make doc/gforth.txt
   
   or just concatenate the files gforth.info-* ('cat gforth.info-*' under
   Unix); the result of the latter option is a little worse.
   
   You can find binary distributions, documentation in HTML and plain
   text format and information on known installation problems at
   http://www.complang.tuwien.ac.at/forth/gforth/.
   
   
                 Configuration Options                  Configuration Options
Line 127  ac_cv_c_bigendian variable gives the byt Line 136  ac_cv_c_bigendian variable gives the byt
   
 If you want to have some installation-specific files loaded when  If you want to have some installation-specific files loaded when
 Gforth starts (e.g., an assembler for your processor), put commands  Gforth starts (e.g., an assembler for your processor), put commands
 for loading them into /usr/local/share/gforth/site-forth/site-init.fs  for loading them into /usr/local/share/gforth/site-forth/siteinit.fs
 (if the commands work for all architectures) or  (if the commands work for all architectures) or
 /usr/local/lib/gforth/site-forth/site-init.fs (for  /usr/local/lib/gforth/site-forth/siteinit.fs (for
 architecture-specific commands);  architecture-specific commands);
 /usr/local/lib/gforth/site-forth/site-init.fs takes precedence if both  /usr/local/lib/gforth/site-forth/siteinit.fs takes precedence if both
 files are present (unless you change the search path). The file names  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  given above are the defaults; if you have changed the prefix, you have
 to replace "/usr/local" in these names with your prefix.  to replace "/usr/local" in these names with your prefix.
   
 By default, the installation procedure creates an empty  By default, the installation procedure creates an empty
 /usr/local/share/gforth/site-forth/site-init.fs if there is no such  /usr/local/share/gforth/site-forth/siteinit.fs if there is no such
 file.  file.
   
 If you change the site-init.fs file, you should run "make install"  If you change the siteinit.fs file, you should run "make install"
 again for the changes to take effect (Actually, the part of "make  again for the changes to take effect (Actually, the part of "make
 install" starting with "rm gforth.fi" is sufficient).  install" starting with "rm gforth.fi" is sufficient).
   
Line 156  version foo with 'make uninstall VERSION Line 165  version foo with 'make uninstall VERSION
 tells you how to uninstall Gforth completely.  tells you how to uninstall Gforth completely.
   
   
                         A Possible Problem                  Installing Info Files
   
   Info is the GNU project on-line documentation format. You can read
   info files either from within Emacs (Ctrl-h i) or using the
   stand-alone Info reader, 'info'.
   
 You need to read this only if you see a message like  If you use the default install root of '/usr/local' then the info
   files will be installed in '/usr/local/info'.
   
 ...  Many GNU/Linux distributions are set up to put all of their
 The Gforth installer should look into the INSTALL file  documentation in '/usr/info', in which case you might have to do a
   couple of things to get your environment set up to accommodate files
   in both areas:
   
 1) "gforth: Cannot load nonrelocatable image (compiled for address $1234) at address $5678  1. Add an INFOPATH environment variable. The easiest place to do
 The Gforth installer should look into the INSTALL file"  this is '/etc/profile', right next to PATH and MANPATH:
   
 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  
   
 If the addresses changes by only a small amount (e.g. by one or two  
 pages), you can fix it by defining FUZZ (in config.h) to a number at  
 least two times the changes you observe (0x4000 is a good idea, this  
 is four 4k pages) and recompile. We do this for the DJGPP port for  
 DOS, because the start address there changes by one or two pages, and  
 it helps us to keep the DOS people happy without investing too much  
 work in a braindead environment.  
   
   
 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  INFOPATH=/usr/local/info:/usr/info
 fixed-address image, you can use the steps described above.  
   
   2. Create a file called 'dir' in 'usr/local/info'. Use the file
   '/usr/info/dir' as a template. You can add the line for gforth
   manually, or use '/sbin/install-info' (man install-info for details).
   

Removed from v.1.26  
changed lines
  Added in v.1.30


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