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