Return to gforth.1 CVS log

Up to [gforth] / gforth / doc

Added documentation for structures and object.fs
Changed representation of structures from "size align" to "align size",
   and renamed 1 cells: to cell% etc.
added %size and %alignment
fixed search bug
added command-line option --die-on-signal

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