Annotation of gforth/INSTALL, revision 1.35

1.33      anton       1: Copyright (C) 2003 Free Software Foundation, Inc.
                      2: This file is free documentation; the Free Software Foundation gives
                      3: unlimited permission to copy, distribute and modify it.
                      4: 
1.35    ! anton       5: 
        !             6:                Prerequisites
        !             7: 
        !             8: You need gcc version 2.0 or later to compile gforth.  Recommended:
        !             9: gcc-2.95.* (other versions produce slower code).
        !            10: 
        !            11: To use the new C interface, you need to install the ffcall libraries
        !            12: before configuring Gforth.  You can find them on
        !            13: 
        !            14:    ftp://ftp.santafe.edu/pub/gnu/ffcall-1.8.tar.gz (USA) 
        !            15:    ftp://ftp.ilog.fr/pub/Users/haible/gnu/ffcall-1.8.tar.gz (Europe) 
        !            16: 
        !            17: 
        !            18:                Building and Installing
1.1       anton      19: 
1.5       anton      20: First, type
1.3       anton      21: 
1.8       anton      22: ./configure
1.1       anton      23: 
1.21      anton      24: (see Section Configuration Options below for details).
                     25: 
                     26: After configuration, type
                     27: 
                     28: make
                     29: 
                     30: Now you can check whether your shiny new Forth system works. Say
                     31: 
1.30      anton      32: make check
1.21      anton      33: 
                     34: You can run some benchmarks with
                     35: 
                     36: make bench
                     37: 
                     38: and compare them with the results in Benchres and in the manual.
                     39: 
                     40: If everything is all right, you may want to install gforth. Type
                     41: 
                     42: make install
                     43: 
                     44: For paper documentation, print gforth.ps (a Postscript file (300dpi
                     45: fonts, i.e., it works, but does not produce best quality on better
                     46: printers)), or say
                     47: 
                     48: make gforth.dvi
                     49: 
                     50: and print the resulting file gforth.dvi. You can also get the
                     51: documentation in HTML format by typing
                     52: 
                     53: make html
                     54: 
1.28      anton      55: If you prefer plain ASCII documentation, you can 
                     56: 
                     57: make doc/gforth.txt
                     58: 
                     59: or just concatenate the files gforth.info-* ('cat gforth.info-*' under
                     60: Unix); the result of the latter option is a little worse.
                     61: 
                     62: You can find binary distributions, documentation in HTML and plain
                     63: text format and information on known installation problems at
                     64: http://www.complang.tuwien.ac.at/forth/gforth/.
1.21      anton      65: 
                     66: 
                     67:                Configuration Options
                     68: 
1.23      anton      69: If you use GNU make, you can build in a directory different from the
                     70: source directory by changing to the build directory and invoking
                     71: configure thus:
1.21      anton      72: 
                     73: $srcdir/configure
                     74: 
1.23      anton      75: where $srcdir is the source directory. (Note that we tested this only
1.21      anton      76: for installation; i.e., if you want to hack the Gforth sources, you
                     77: should probably build in the source directory).
                     78: 
1.4       pazsan     79: configure has the following useful parameters:
1.9       anton      80:   --prefix=PREFIX         install architecture-independent files in PREFIX
                     81:                           [default: /usr/local]
                     82:   --exec-prefix=PREFIX    install architecture-dependent files in PREFIX
                     83:                           [default: same as prefix]
1.8       anton      84:   --enable-force-reg      Use explicit register declarations if they appear in
                     85:                           the machine.h file. This can cause a good speedup,
                     86:                           but also incorrect code with some gcc versions on
                     87:                           some processors (default disabled).
                     88:   --help: tells you about other parameters.
1.1       anton      89: 
1.21      anton      90: The file Benchres shows which combination of the -enable options we
                     91: tried gave the best results for various machines.
                     92: 
1.9       anton      93: If you don't like the defaults for the installation directories, you
                     94: should override them already during configure.  E.g., if you want to
                     95: install in the /gnu hierarchy instead of in the default /usr/local
1.15      anton      96: hierarchy, say
1.5       anton      97: 
1.9       anton      98: ./configure --prefix=/gnu
1.2       anton      99: 
1.17      anton     100: Moreover, if your GCC is not called gcc (but, e.g., gcc-2.7.1), you
                    101: should say so during configuration. E.g.:
1.16      pazsan    102: 
1.35    ! anton     103: ./configure CC=gcc-2.7.1
1.16      pazsan    104: 
1.17      anton     105: You can also pass additional options to gcc in this way, e.g., if you
                    106: want to generate an a.out executable under Linux with gcc-2.7.0:
1.15      anton     107: 
1.35    ! anton     108: ./configure CC="gcc -b i486-linuxaout -V 2.7.0"
1.15      anton     109: 
1.22      anton     110: You can change the sizes of the various areas used in the default
                    111: image `gforth.fi' by passing the appropriate Gforth command line
                    112: options in the FORTHSIZES environment variable:
                    113: 
1.35    ! anton     114: ./configure "FORTHSIZES=--dictionary-size=256k --data-stack-size=16k --fp-stack-size=15872b --return-stack-size=15k --locals-stack-size=14848b"
1.22      anton     115: 
                    116: The line above reaffirms the default sizes. Note that the locals
                    117: stack area is also used as input buffer stack.
1.17      anton     118: 
1.24      anton     119: If C's "long long" do not work properly on your machine (i.e., if the
                    120: tests involving double-cell numbers fail), you can build Gforth such
                    121: that it does not use "long long":
                    122: 
1.35    ! anton     123: ./configure ac_cv_sizeof_long_long=0
1.24      anton     124: 
                    125: 
1.31      anton     126:                        Cross-Installation
1.24      anton     127: 
1.31      anton     128: You need a cross-compilation toolchain for your target including gcc
                    129: (2.0 or later).
                    130: 
                    131: The first step in cross-installation is the cross-configuration.  A
                    132: few tests made by the configure script do not work in a
1.24      anton     133: cross-compilation situation. You have to provide the results of these
                    134: tests by hand. E.g., if you compile for a 386 architecture processor:
                    135: 
1.32      anton     136: env ac_cv_sizeof_char_p=4 ac_cv_sizeof_char=1 ac_cv_sizeof_short=2 ac_cv_sizeof_int=4 ac_cv_sizeof_long=4 ac_cv_sizeof_long_long=8 ac_cv_sizeof_intptr_t=4 ac_cv_sizeof_int128_t=0 ac_cv_c_bigendian=no ./configure
1.24      anton     137: 
                    138: The ac_cv_sizeof_... variables give the sizes of various C types;
                    139: ac_cv_sizeof_char_p is the same as "sizeof(char*)" in C code. The
                    140: ac_cv_c_bigendian variable gives the byte order.
1.31      anton     141: 
                    142: After the cross-configuration you type
                    143: 
                    144: make gforths
                    145: 
                    146: This produces the gforth engines for the target.
                    147: 
                    148: The next step is to transfer everything to the target; on the target,
                    149: you do
                    150: 
                    151: make
                    152: 
                    153: to complete building gforth.  If you do not have a make on the target,
                    154: run
                    155: 
                    156: make -n
                    157: 
                    158: on the host; manually execute on the target the last command output by
                    159: "make -n" (GFORTHD=...); the other commands output by "make -n" are
                    160: not necessary unless you have changed the Gforth sources.  You can
                    161: then check and benchmark Gforth with
                    162: 
                    163: make check
                    164: make bench
                    165: 
                    166: or equivalent.  Finally, perform
                    167: 
                    168: make install
                    169: 
                    170: or the equivalent commands on the target.
1.24      anton     171: 
                    172: 
1.17      anton     173:                Preloading installation-specific code
                    174: 
                    175: If you want to have some installation-specific files loaded when
                    176: Gforth starts (e.g., an assembler for your processor), put commands
1.28      anton     177: for loading them into /usr/local/share/gforth/site-forth/siteinit.fs
1.17      anton     178: (if the commands work for all architectures) or
1.28      anton     179: /usr/local/lib/gforth/site-forth/siteinit.fs (for
1.17      anton     180: architecture-specific commands);
1.28      anton     181: /usr/local/lib/gforth/site-forth/siteinit.fs takes precedence if both
1.17      anton     182: files are present (unless you change the search path). The file names
                    183: given above are the defaults; if you have changed the prefix, you have
                    184: to replace "/usr/local" in these names with your prefix.
                    185: 
                    186: By default, the installation procedure creates an empty
1.28      anton     187: /usr/local/share/gforth/site-forth/siteinit.fs if there is no such
1.17      anton     188: file.
                    189: 
1.28      anton     190: If you change the siteinit.fs file, you should run "make install"
1.17      anton     191: again for the changes to take effect (Actually, the part of "make
                    192: install" starting with "rm gforth.fi" is sufficient).
                    193: 
                    194: 
1.12      anton     195:                Multiple Versions and Deinstallation
                    196: 
                    197: Several versions of Gforth can be installed and used at the same
                    198: time. Version `foo' can be invoked with `gforth-foo'. We recommend to
                    199: keep the old version for some time after a new one has been installed.
1.10      anton     200: 
1.12      anton     201: You can deinstall this version of Gforth with 'make uninstall' and
                    202: version foo with 'make uninstall VERSION=foo'. 'make uninstall' also
                    203: tells you how to uninstall Gforth completely.
1.29      crook     204: 
                    205: 
                    206:                Installing Info Files
                    207: 
                    208: Info is the GNU project on-line documentation format. You can read
                    209: info files either from within Emacs (Ctrl-h i) or using the
                    210: stand-alone Info reader, 'info'.
                    211: 
                    212: If you use the default install root of '/usr/local' then the info
                    213: files will be installed in '/usr/local/info'.
                    214: 
                    215: Many GNU/Linux distributions are set up to put all of their
                    216: documentation in '/usr/info', in which case you might have to do a
                    217: couple of things to get your environment set up to accommodate files
                    218: in both areas:
                    219: 
                    220: 1. Add an INFOPATH environment variable. The easiest place to do
                    221: this is '/etc/profile', right next to PATH and MANPATH:
                    222: 
                    223: INFOPATH=/usr/local/info:/usr/info
                    224: 
                    225: 2. Create a file called 'dir' in 'usr/local/info'. Use the file
                    226: '/usr/info/dir' as a template. You can add the line for gforth
                    227: manually, or use '/sbin/install-info' (man install-info for details).

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