File:  [gforth] / gforth / README
Revision 1.54: download - view: text, annotated - select for diffs
Mon Aug 25 14:57:22 2003 UTC (20 years, 6 months ago) by anton
Branches: MAIN
CVS tags: HEAD
documentation changes

    1: Gforth is a fast and portable implementation of the ANS Forth
    2: language. It works nicely with the Emacs editor, offers some nice
    3: features such as input completion and history, backtraces, a
    4: decompiler and a powerful locals facility, and it even has a
    5: manual. Gforth combines traditional implementation techniques with
    6: newer techniques for portability and performance performance: its
    7: inner innerpreter is direct threaded with several optimizations, but
    8: you can also use a traditional-style indirect threaded interpreter.
    9: Gforth is distributed under the GNU General Public license (see
   10: COPYING).
   11: 
   12: Gforth runs under Unix, Win95, OS/2, and DOS and should not be hard to
   13: port to other systems supported by GCC. This version has been tested
   14: successfully on the following platforms:
   15: 
   16: alpha-dec-osf4.0d
   17: alphapca56-unknown-linux-gnu
   18: alpha-unknown-linux-gnu
   19: hppa1.1-unknown-linux-gnu
   20: hppa2.0w-hp-hpux11.11
   21: i386-unknown-freebsd5.0
   22: i486-pc-linux-gnulibc1
   23: i686-pc-cygwin
   24: i686-pc-linux-gnu
   25: mips-dec-ultrix4.3
   26: mipsel-pc-linux-gnu
   27: mips-sgi-irix6.5
   28: powerpc-apple-darwin5.4
   29: powerpc-unknown-linux-gnu
   30: sparc-sun-solaris2.7
   31: 
   32: Read INSTALL for installation instructions, or INSTALL.DOS for DOS,
   33: Windows 95, and OS/2, or INSTALL.BINDIST if you have a binary package.
   34: To start the system, just say `gforth' (after installing it).
   35: 
   36: You can find new versions of Gforth at ftp://ftp.gnu.org/gnu/gforth/
   37: and its mirrors or at
   38: 
   39: http://www.complang.tuwien.ac.at/forth/gforth/
   40: or
   41: ftp://ftp.complang.tuwien.ac.at/pub/forth/gforth/
   42: 
   43: The latter site also contains binary distributions of Gforth for some
   44: popular platforms.
   45: 
   46: If you want to work on Gforth, mail me. Tasks to be done can be found
   47: in ToDo; but if you would like to do something not mentioned there,
   48: it's ok, too. In any case, we would like to hear what you are
   49: doing. The most important tasks IMO are the missing ANS Forth words,
   50: the documentation and the foreign language interface for C.
   51: 
   52: On popular request, here are the meanings of unusual file extensions:
   53: 
   54: *.fs	Forth stream source file (include with "include <file>" from within
   55:         gforth, or start with "gforth <file1> <file2> ...")
   56: *.fi	Forth image files (start with "gforth -i <image file>")
   57: *.fb	Forth blocks file (load with "use <block file> 1 load")
   58: *.i	C include files
   59: *.ds	documenation source
   60: *TAGS	etags files
   61: 
   62: A number of Forth source files are included in this package that are
   63: not necessary for building Gforth. Not all of them are mentioned in
   64: the rest of the documentation, so here's a short overview:
   65: 
   66: Add-ons:
   67: code.fs random.fs more.fs ansi.fs colorize.fs
   68: oof.fs oofsampl.fs objects.fs blocked.fb tasker.fs
   69: 
   70: Utilities:
   71: ans-report.fs etags.fs glosgen.fs filedump.fs
   72: 
   73: Games:
   74: tt.fs sokoban.fs
   75: 
   76: Test programs (for testing Forth systems):
   77: test/*.fs
   78: 
   79: Benchmarks:
   80: bubble.fs siev.fs matrix.fs fib.fs
   81: 
   82: ANS Forth implementations of Gforth extensions:
   83: compat/*.fs other.fs
   84: 
   85: For discussions about Gforth, use the Usenet newsgroup
   86: comp.lang.forth.  If you prefer not to post on Usenet, there is also a
   87: mailing list: GForth@ChaosSolutions.org.  To subscribe, send a mail to
   88: gforth-subscribe@chaossolutions.org@ChaosSolutions.org with:
   89: 
   90: subscribe GForth
   91: 
   92: as the first and only line within the message body.  Submit bug
   93: reports through
   94: 
   95: https://savannah.gnu.org/bugs/?func=addbug&group=gforth
   96: 
   97: (whether you post them or not).
   98: 
   99: - anton
  100: anton@mips.complang.tuwien.ac.at
  101: http://www.complang.tuwien.ac.at/anton/home.html
  102: -----
  103: Copyright (C) 1995,1996,1997,1998,2000,2003 Free Software Foundation, Inc.
  104: 
  105: This file is part of Gforth.
  106: 
  107: Gforth is free software; you can redistribute it and/or
  108: modify it under the terms of the GNU General Public License
  109: as published by the Free Software Foundation; either version 2
  110: of the License, or (at your option) any later version.
  111: 
  112: This program is distributed in the hope that it will be useful,
  113: but WITHOUT ANY WARRANTY; without even the implied warranty of
  114: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.#See the
  115: GNU General Public License for more details.
  116: 
  117: You should have received a copy of the GNU General Public License
  118: along with this program; if not, write to the Free Software
  119: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

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