File:  [gforth] / gforth / INSTALL
Revision 1.27: download - view: text, annotated - select for diffs
Thu Mar 20 14:39:48 1997 UTC (22 years, 6 months ago) by anton
Branches: MAIN
CVS tags: v0-3-0, HEAD
fixed a few Makefile bugs (make clean)
renamed blocks.fs:flush-file into flush-blocks
fixed bell bug (now flushes the output)
documentation changes

    1: You need gcc version 2.0 or later to compile gforth.
    2: 
    3: First, type
    4: 
    5: ./configure
    6: 
    7: (see Section Configuration Options below for details).
    8: 
    9: After configuration, type
   10: 
   11: make
   12: 
   13: Now you can check whether your shiny new Forth system works. Say
   14: 
   15: make test
   16: 
   17: You can run some benchmarks with
   18: 
   19: make bench
   20: 
   21: and compare them with the results in Benchres and in the manual.
   22: 
   23: If everything is all right, you may want to install gforth. Type
   24: 
   25: make install
   26: 
   27: You have to make an entry in the info directory file manually.
   28: 
   29: For paper documentation, print gforth.ps (a Postscript file (300dpi
   30: fonts, i.e., it works, but does not produce best quality on better
   31: printers)), or say
   32: 
   33: make gforth.dvi
   34: 
   35: and print the resulting file gforth.dvi. You can also get the
   36: documentation in HTML format by typing
   37: 
   38: make html
   39: 
   40: If you prefer plain ASCII documentation, just concatenate the files
   41: gforth.info-* ('cat gforth.info-*' under Unix).
   42: 
   43: 
   44: 		Configuration Options
   45: 
   46: If you use GNU make, you can build in a directory different from the
   47: source directory by changing to the build directory and invoking
   48: configure thus:
   49: 
   50: $srcdir/configure
   51: 
   52: where $srcdir is the source directory. (Note that we tested this only
   53: for installation; i.e., if you want to hack the Gforth sources, you
   54: should probably build in the source directory).
   55: 
   56: configure has the following useful parameters:
   57:   --prefix=PREFIX         install architecture-independent files in PREFIX
   58:                           [default: /usr/local]
   59:   --exec-prefix=PREFIX    install architecture-dependent files in PREFIX
   60:                           [default: same as prefix]
   61:   --enable-force-reg      Use explicit register declarations if they appear in
   62:                           the machine.h file. This can cause a good speedup,
   63:                           but also incorrect code with some gcc versions on
   64:                           some processors (default disabled).
   65:   --enable-direct-threaded      Force direct threading. This may not work on
   66:                                 some machines and may cause slowdown on others.
   67:                                 (default processor-dependent)
   68:   --enable-indirect-threaded    Force indirect threading. This can cause a
   69:                                 slowdown on some machines.
   70:                                 (default processor-dependent)
   71:   --with-debug     specifies option -g to compile with debug info (default)
   72:   --without-debug  omits the -g switch and creates smaller images on
   73:                    machines where strip has problems with gcc style
   74:                    debugging informations.
   75:   --help: tells you about other parameters.
   76: 
   77: The file Benchres shows which combination of the -enable options we
   78: tried gave the best results for various machines.
   79: 
   80: If you don't like the defaults for the installation directories, you
   81: should override them already during configure.  E.g., if you want to
   82: install in the /gnu hierarchy instead of in the default /usr/local
   83: hierarchy, say
   84: 
   85: ./configure --prefix=/gnu
   86: 
   87: Moreover, if your GCC is not called gcc (but, e.g., gcc-2.7.1), you
   88: should say so during configuration. E.g.:
   89: 
   90: env CC=gcc-2.7.1 ./configure
   91: 
   92: You can also pass additional options to gcc in this way, e.g., if you
   93: want to generate an a.out executable under Linux with gcc-2.7.0:
   94: 
   95: env "CC=gcc -b i486-linuxaout -V 2.7.0" ./configure
   96: 
   97: You can change the sizes of the various areas used in the default
   98: image `gforth.fi' by passing the appropriate Gforth command line
   99: options in the FORTHSIZES environment variable:
  100: 
  101: env "FORTHSIZES=--dictionary-size=256k --data-stack-size=16k --fp-stack-size=15872b --return-stack-size=15k --locals-stack-size=14848b" ./configure
  102: 
  103: The line above reaffirms the default sizes. Note that the locals
  104: stack area is also used as input buffer stack.
  105: 
  106: If C's "long long" do not work properly on your machine (i.e., if the
  107: tests involving double-cell numbers fail), you can build Gforth such
  108: that it does not use "long long":
  109: 
  110: env ac_cv_sizeof_long_long=0 ./configure
  111: 
  112: 
  113: 			Cross-Configuration
  114: 
  115: A few tests made by the configure script do not work in a
  116: cross-compilation situation. You have to provide the results of these
  117: tests by hand. E.g., if you compile for a 386 architecture processor:
  118: 
  119: env ac_cv_sizeof_char_p=4 ac_cv_sizeof_short=2 ac_cv_sizeof_int=4 ac_cv_sizeof_long=4 ac_cv_sizeof_long_long=8 ac_cv_c_bigendian=no ./configure
  120: 
  121: The ac_cv_sizeof_... variables give the sizes of various C types;
  122: ac_cv_sizeof_char_p is the same as "sizeof(char*)" in C code. The
  123: ac_cv_c_bigendian variable gives the byte order.
  124: 
  125: 
  126: 		Preloading installation-specific code
  127: 
  128: If you want to have some installation-specific files loaded when
  129: Gforth starts (e.g., an assembler for your processor), put commands
  130: for loading them into /usr/local/share/gforth/site-forth/site-init.fs
  131: (if the commands work for all architectures) or
  132: /usr/local/lib/gforth/site-forth/site-init.fs (for
  133: architecture-specific commands);
  134: /usr/local/lib/gforth/site-forth/site-init.fs takes precedence if both
  135: files are present (unless you change the search path). The file names
  136: given above are the defaults; if you have changed the prefix, you have
  137: to replace "/usr/local" in these names with your prefix.
  138: 
  139: By default, the installation procedure creates an empty
  140: /usr/local/share/gforth/site-forth/site-init.fs if there is no such
  141: file.
  142: 
  143: If you change the site-init.fs file, you should run "make install"
  144: again for the changes to take effect (Actually, the part of "make
  145: install" starting with "rm gforth.fi" is sufficient).
  146: 
  147: 
  148: 		Multiple Versions and Deinstallation
  149: 
  150: Several versions of Gforth can be installed and used at the same
  151: time. Version `foo' can be invoked with `gforth-foo'. We recommend to
  152: keep the old version for some time after a new one has been installed.
  153: 
  154: You can deinstall this version of Gforth with 'make uninstall' and
  155: version foo with 'make uninstall VERSION=foo'. 'make uninstall' also
  156: tells you how to uninstall Gforth completely.

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