File:  [gforth] / gforth / Attic / gforth.1
Revision 1.6: download - view: text, annotated - select for diffs
Tue Mar 11 16:00:37 1997 UTC (25 years, 7 months ago) by anton
Branches: MAIN
CVS tags: HEAD
added primitive K
the Makefile now works with Digital Unix make
renamed the gforth-makeimage variable GFORTH into GFORTHD
fixed bug in comp-image (can now generate data-relocatable images).
gforth-makeimage uses a new option --no-offset-im to avoid differences
	from the command line
Documentation changes
fixed another bug involving relocatablility of code addresses.
my_alloc now works on machines without MAP_FILE and MAP_PRIVATE

    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 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: .SH OPTIONS
   44: 
   45: .BI "\-\-image\-file " "file"
   46: .TQ "\-i " "file"
   47: Loads the Forth image
   48: .I file
   49: instead of the default \fCgforth.fi\fR.
   50: .TP
   51: .BI "\-\-path " "path"
   52: .TQ "\-p " "path"
   53: Uses
   54: .I path
   55: for searching the image file and Forth source code
   56: files instead of the default in the environment variable
   57: \fCGFORTHPATH\fR
   58: or the path specified at installation time (typically
   59: \fC/usr/local/lib/gforth:.\fR. A path is given as a 
   60: .BR : -separated
   61: list.
   62: .TP
   63: .BI "\-\-dictionary\-size " "size"
   64: .TQ "\-m " "size"
   65: Allocate
   66: .I size
   67: space for the Forth dictionary space instead of
   68: using the default specified in the image (typically 256K). The
   69: .I size
   70: specification consists of an integer and a unit (e.g., \fC4M\fR).
   71: The unit can be one of \fCb\fR (bytes),
   72: \fCe\fR (element size, in this case Cells),
   73: \fCk\fR (kilobytes), and
   74: \fCM\fR (Megabytes). If no unit is specified,
   75: \fCe\fR is used.
   76: .TP
   77: .BI "\-\-data\-stack\-size " "size"
   78: .TQ "\-d " "size"
   79: Allocate
   80: .I size
   81: space for the data stack instead of using the
   82: default specified in the image (typically 16K).
   83: .TP
   84: .BI "\-\-return\-stack\-size " "size"
   85: .TQ "\-r " "size"
   86: Allocate
   87: .I size
   88: space for the return stack instead of using the
   89: default specified in the image (typically 16K).
   90: .TP
   91: .BI "\-\-fp\-stack\-size " "size"
   92: .TQ "\-f " "size"
   93: Allocate
   94: .I size
   95: space for the floating point stack instead of
   96: using the default specified in the image (typically 16K). In this case
   97: the unit specifier
   98: \fCe\fR
   99: refers to floating point numbers.
  100: .TP
  101: .BI "\-\-locals\-stack\-size " "size"
  102: .TQ "\-l " "size"
  103: Allocate
  104: .I size
  105: space for the locals stack instead of using the
  106: default specified in the image (typically 16K).
  107: 
  108: .TP
  109: .BI "\-\-evaluate " "forth"
  110: .TQ "\-e " "forth"
  111: Evaluates the
  112: .I forth
  113: code. This option takes only one argument; if you want to evaluate
  114: more Forth words, you have to quote them or use several \fC-e\fRs.  To
  115: exit after processing the command line (instead of entering
  116: interactive mode) append \fC-e bye\fR to the command line. This is an
  117: image-specific option.
  118: .SH FILES
  119: .nf
  120: .ta \w'\fCkernal.fi\fP 	'u
  121: \&\fCgforth.fi\fP	default Forth image
  122: \&\fCkernel.fi\fP	kernel image
  123: \&\fC*.fi\fP	Forth loadable image
  124: \&\fC*.fs\fP	Forth source (sequential)
  125: \&\fC*.fb\fP	Forth source (block)
  126: \&\fC*.fd\fP	generated with \fCmakedoc.fs\fP
  127: \&\fC*.i\fP	C include files
  128: \&\fC*.ds\fP	documentation source
  129: \&\fC*TAGS\fP	etags files
  130: .fi
  131: .SH SEE ALSO
  132: The GForth manual is available in hypertext (Info, HTML) and printable
  133: (TeX, PS) forms.
  134: 
  135: The ANSI document X3.215-1994 (i.e., the ANS Forth standard).
  136: 
  137: More information on Gforth (e.g., pointers to new versions, to the
  138: manual on the WWW and to papers about Gforth) is available through
  139: \fChttp://www.complang.tuwien.ac.at/projects/forth.html\fR.
  140: .SH AUTHORS
  141: \fBGforth\fR was written by Anton Ertl, Bernd Paysan, Jens Wilke and
  142: others.

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