File:  [gforth] / gforth / doc / gforth.1
Revision 1.3: download - view: text, annotated - select for diffs
Thu Dec 24 11:08:40 1998 UTC (23 years, 7 months ago) by anton
Branches: MAIN
CVS tags: v0-4-0, HEAD
doc/gforth.txt is not included in the dist
adjusted man page

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

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