File:  [gforth] / gforth / Attic / gforth.1
Revision 1.7: download - view: text, annotated - select for diffs
Wed Mar 19 18:27:14 1997 UTC (25 years, 3 months ago) by anton
Branches: MAIN
CVS tags: v0-3-0, HEAD
fixed some documentation bugs
updated dates on copyright messages
updated NEWS
some fixes in Makefile.in

    1: .de TQ
    2: .br
    3: .ns
    4: .IP "\fB\\$1\fI\\$2" 9
    5: ..
    6: .TH GForth 1 "October 29, 1995" \" -*- nroff -*-
    7: .SH NAME
    8: gforth, gforth-ditc, gforth-makeimage \- a fast and portable Forth system
    9: .SH SYNOPSIS
   10: 
   11: \fCgforth\fR [initialization options] [image-specific options]
   12: 
   13: \fCgforth-ditc\fR [initialization options] [image-specific options]
   14: 
   15: \fCgforth-makeimage\fR \fIfilename\fR [initialization options] [image-specific options]
   16: .SH DESCRIPTION
   17: 
   18: \fBGForth\fR is a fast and portable implementation of the Forth
   19: programming language. For details read the manual.
   20: .SH ENVIRONMENT VARIABLES
   21: 
   22: \fCGFORTHPATH\fR contains the search path for source and image files.
   23: 
   24: \fCGFORTHD\fR gives the gforth executable to be used in creating the
   25: image (default: \fCgforth-ditc\fR).
   26: 
   27: .SH EXAMPLES
   28: 
   29: \fCgforth\fR
   30: 
   31: starts the system and goes into interactive mode.
   32: 
   33: \fCgforth file1 file2 \-e bye\fR
   34: 
   35: loads and interprets the files \fCfile1\fR and \fCfile2\fR, then
   36: exits.
   37: 
   38: \fCgforth-makeimage asm.fi \-m 1M asm.fs\fR
   39: 
   40: creates an image \fCasm.fi\fR that has a default dictionary size of
   41: 1MB and has the file \fCasm.fs\fR loaded.
   42: 
   43: \fCgforth-ditc\fR
   44: 
   45: starts a doubly indirect threaded version of Gforth and goes into
   46: interactive mode.
   47: 
   48: .SH OPTIONS
   49: 
   50: .BI "\-\-image\-file " "file"
   51: .TQ "\-i " "file"
   52: Loads the Forth image
   53: .I file
   54: instead of the default \fCgforth.fi\fR.
   55: .TP
   56: .BI "\-\-path " "path"
   57: .TQ "\-p " "path"
   58: Uses
   59: .I path
   60: for searching the image file and Forth source code
   61: files instead of the default in the environment variable
   62: \fCGFORTHPATH\fR
   63: or the path specified at installation time (typically
   64: \fC/usr/local/lib/gforth:.\fR. A path is given as a 
   65: .BR : -separated
   66: list.
   67: .TP
   68: .BI "\-\-dictionary\-size " "size"
   69: .TQ "\-m " "size"
   70: Allocate
   71: .I size
   72: space for the Forth dictionary space instead of
   73: using the default specified in the image (typically 256K). The
   74: .I size
   75: specification consists of an integer and a unit (e.g., \fC4M\fR).
   76: The unit can be one of \fCb\fR (bytes),
   77: \fCe\fR (element size, in this case Cells),
   78: \fCk\fR (kilobytes), and
   79: \fCM\fR (Megabytes). If no unit is specified,
   80: \fCe\fR is used.
   81: .TP
   82: .BI "\-\-data\-stack\-size " "size"
   83: .TQ "\-d " "size"
   84: Allocate
   85: .I size
   86: space for the data stack instead of using the
   87: default specified in the image (typically 16K).
   88: .TP
   89: .BI "\-\-return\-stack\-size " "size"
   90: .TQ "\-r " "size"
   91: Allocate
   92: .I size
   93: space for the return stack instead of using the
   94: default specified in the image (typically 16K).
   95: .TP
   96: .BI "\-\-fp\-stack\-size " "size"
   97: .TQ "\-f " "size"
   98: Allocate
   99: .I size
  100: space for the floating point stack instead of
  101: using the default specified in the image (typically 16K). In this case
  102: the unit specifier
  103: \fCe\fR
  104: refers to floating point numbers.
  105: .TP
  106: .BI "\-\-locals\-stack\-size " "size"
  107: .TQ "\-l " "size"
  108: Allocate
  109: .I size
  110: space for the locals stack instead of using the
  111: default specified in the image (typically 16K).
  112: 
  113: .TP
  114: .BI "\-\-evaluate " "forth"
  115: .TQ "\-e " "forth"
  116: Evaluates the
  117: .I forth
  118: code. This option takes only one argument; if you want to evaluate
  119: more Forth words, you have to quote them or use several \fC-e\fRs.  To
  120: exit after processing the command line (instead of entering
  121: interactive mode) append \fC-e bye\fR to the command line. This is an
  122: image-specific option of the default image.
  123: .SH FILES
  124: .nf
  125: .ta \w'\fCkernal.fi\fP 	'u
  126: \&\fCgforth.fi\fP	default Forth image
  127: \&\fCkernel.fi\fP	kernel image
  128: \&\fC*.fi\fP	Forth loadable image
  129: \&\fC*.fs\fP	Forth source (sequential)
  130: \&\fC*.fb\fP	Forth source (block)
  131: \&\fC*.fd\fP	generated with \fCmakedoc.fs\fP
  132: \&\fC*.i\fP	C include files
  133: \&\fC*.ds\fP	documentation source
  134: \&\fC*TAGS\fP	etags files
  135: .fi
  136: .SH SEE ALSO
  137: The GForth manual is available in hypertext (Info, HTML) and printable
  138: (TeX, PS) forms.
  139: 
  140: The ANSI document X3.215-1994 (i.e., the ANS Forth standard).
  141: 
  142: More information on Gforth (e.g., pointers to new versions, to the
  143: manual on the WWW and to papers about Gforth) is available through
  144: \fChttp://www.complang.tuwien.ac.at/projects/forth.html\fR.
  145: .SH AUTHORS
  146: \fBGforth\fR was written by Anton Ertl, Bernd Paysan, Jens Wilke and
  147: others.

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