Return to gforth.1 CVS log

Up to [gforth] / gforth / doc

Annotation of gforth/doc/gforth.1, revision 1.4

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