File:  [gforth] / gforth / Attic / gforth.1
Revision 1.7: download - view: text, annotated - select for diffs
Wed Mar 19 18:27:14 1997 UTC (22 years, 6 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

.de TQ
.br
.ns
.IP "\fB\\$1\fI\\$2" 9
..
.TH GForth 1 "October 29, 1995" \" -*- nroff -*-
.SH NAME
gforth, gforth-ditc, gforth-makeimage \- a fast and portable Forth system
.SH SYNOPSIS

\fCgforth\fR [initialization options] [image-specific options]

\fCgforth-ditc\fR [initialization options] [image-specific options]

\fCgforth-makeimage\fR \fIfilename\fR [initialization options] [image-specific options]
.SH DESCRIPTION

\fBGForth\fR is a fast and portable implementation of the Forth
programming language. For details read the manual.
.SH ENVIRONMENT VARIABLES

\fCGFORTHPATH\fR contains the search path for source and image files.

\fCGFORTHD\fR gives the gforth executable to be used in creating the
image (default: \fCgforth-ditc\fR).

.SH EXAMPLES

\fCgforth\fR

starts the system and goes into interactive mode.

\fCgforth file1 file2 \-e bye\fR

loads and interprets the files \fCfile1\fR and \fCfile2\fR, then
exits.

\fCgforth-makeimage asm.fi \-m 1M asm.fs\fR

creates an image \fCasm.fi\fR that has a default dictionary size of
1MB and has the file \fCasm.fs\fR loaded.

\fCgforth-ditc\fR

starts a doubly indirect threaded version of Gforth and goes into
interactive mode.

.SH OPTIONS

.BI "\-\-image\-file " "file"
.TQ "\-i " "file"
Loads the Forth image
.I file
instead of the default \fCgforth.fi\fR.
.TP
.BI "\-\-path " "path"
.TQ "\-p " "path"
Uses
.I path
for searching the image file and Forth source code
files instead of the default in the environment variable
\fCGFORTHPATH\fR
or the path specified at installation time (typically
\fC/usr/local/lib/gforth:.\fR. A path is given as a 
.BR : -separated
list.
.TP
.BI "\-\-dictionary\-size " "size"
.TQ "\-m " "size"
Allocate
.I size
space for the Forth dictionary space instead of
using the default specified in the image (typically 256K). The
.I size
specification consists of an integer and a unit (e.g., \fC4M\fR).
The unit can be one of \fCb\fR (bytes),
\fCe\fR (element size, in this case Cells),
\fCk\fR (kilobytes), and
\fCM\fR (Megabytes). If no unit is specified,
\fCe\fR is used.
.TP
.BI "\-\-data\-stack\-size " "size"
.TQ "\-d " "size"
Allocate
.I size
space for the data stack instead of using the
default specified in the image (typically 16K).
.TP
.BI "\-\-return\-stack\-size " "size"
.TQ "\-r " "size"
Allocate
.I size
space for the return stack instead of using the
default specified in the image (typically 16K).
.TP
.BI "\-\-fp\-stack\-size " "size"
.TQ "\-f " "size"
Allocate
.I size
space for the floating point stack instead of
using the default specified in the image (typically 16K). In this case
the unit specifier
\fCe\fR
refers to floating point numbers.
.TP
.BI "\-\-locals\-stack\-size " "size"
.TQ "\-l " "size"
Allocate
.I size
space for the locals stack instead of using the
default specified in the image (typically 16K).

.TP
.BI "\-\-evaluate " "forth"
.TQ "\-e " "forth"
Evaluates the
.I forth
code. This option takes only one argument; if you want to evaluate
more Forth words, you have to quote them or use several \fC-e\fRs.  To
exit after processing the command line (instead of entering
interactive mode) append \fC-e bye\fR to the command line. This is an
image-specific option of the default image.
.SH FILES
.nf
.ta \w'\fCkernal.fi\fP 	'u
\&\fCgforth.fi\fP	default Forth image
\&\fCkernel.fi\fP	kernel image
\&\fC*.fi\fP	Forth loadable image
\&\fC*.fs\fP	Forth source (sequential)
\&\fC*.fb\fP	Forth source (block)
\&\fC*.fd\fP	generated with \fCmakedoc.fs\fP
\&\fC*.i\fP	C include files
\&\fC*.ds\fP	documentation source
\&\fC*TAGS\fP	etags files
.fi
.SH SEE ALSO
The GForth manual is available in hypertext (Info, HTML) and printable
(TeX, PS) forms.

The ANSI document X3.215-1994 (i.e., the ANS Forth standard).

More information on Gforth (e.g., pointers to new versions, to the
manual on the WWW and to papers about Gforth) is available through
\fChttp://www.complang.tuwien.ac.at/projects/forth.html\fR.
.SH AUTHORS
\fBGforth\fR was written by Anton Ertl, Bernd Paysan, Jens Wilke and
others.

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