--- gforth/Attic/gforth.texi 1994/08/19 17:47:21 1.5 +++ gforth/Attic/gforth.texi 1994/09/05 17:36:19 1.7 @@ -157,43 +157,100 @@ deviations of the book. There is, of course, the standard, the definite reference if you want to write ANS Forth programs. It will be available in printed form from -!! somtime in spring or summer 1994. If you are lucky, you can still get -dpANS6 (the draft that was approved as standard) by aftp from -ftp.uu.net:/vendor/minerva/x3j14. - -@cite{Forth: The new model} by Jack Woehr (!! Publisher) is an introductory -book based on a draft version of the standard. It does not cover the -whole standard. It also contains interesting background information -(Jack Woehr was in the ANS Forth Technical Committe). +Global Engineering Documents !! somtime in spring or summer 1994. If you +are lucky, you can still get dpANS6 (the draft that was approved as +standard) by aftp from ftp.uu.net:/vendor/minerva/x3j14. + +@cite{Forth: The new model} by Jack Woehr (!! Publisher) is an +introductory book based on a draft version of the standard. It does not +cover the whole standard. It also contains interesting background +information (Jack Woehr was in the ANS Forth Technical Committe). It is +not appropriate for complete newbies, but programmers experienced in +other languages should find it ok. @node Invocation, Words, Other Books, Top @chapter Invocation -You will usually just say @code{gforth}. More generally, the default GNU -Forth image can be invoked like this +You will usually just say @code{gforth}. In many other cases the default +GNU Forth image will be invoked like this: @example -gforth [--batch] [files] [-e forth-code] +gforth [files] [-e forth-code] @end example -The @code{--batch} option makes @code{gforth} exit after processing the -command line. Also, the startup message is suppressed. @file{files} are -Forth source files that are executed in the order in which they -appear. The @code{-e @samp{forth-code}} or @code{--evaluate -@samp{forth-code}} option evaluates the forth code; it can be freely -mixed with the files. This option takes only one argument; if you want -to evaluate more Forth words, you have to quote them or use several -@code{-e}s. !! option for suppressing default loading. - -You can use the command line option @code{-i @samp{file}} or -@code{--image-file @samp{file}} to specify a different image file. Note -that this option must be the first in the command line. The rest of the -command line is processed by the image file. - -If the @code{--image-file} option is not used, GNU Forth searches for a -file named @file{gforth.fi} in the path specified by the environment -variable @code{GFORTHPATH}; if this does not exist, in -@file{/usr/local/lib/gforth} and in @file{/usr/lib/gforth}. +executing the contents of the files and the Forth code in the order they +are given. + +In general, the command line looks like this: + +@example +gforth [initialization options] [image-specific options] +@end example + +The initialization options must come before the rest of the command +line. They are: + +@table @code +@item --image-file @samp{file} +Loads the Forth image @samp{file} instead of the default +@file{gforth.fi}. + +@item --path @samp{path} +Uses @samp{path} for searching the image file and Forth source code +files instead of the default in the environment variable +@code{GFORTHPATH} or the path specified at installation time (typically +@file{/usr/local/lib/gforth:.}). A path is given as a @code{:}-separated +list. + +@item --dictionary-size @samp{size} +@item -m @samp{size} +Allocate @samp{size} space for the Forth dictionary space instead of +using the default specified in the image (typically 256K). The +@samp{size} specification consists of an integer and a unit (e.g., +@code{4M}). The unit can be one of @code{b} (bytes), @code{e} (element +size, in this case Cells), @code{k} (kilobytes), and @code{M} +(Megabytes). If no unit is specified, @code{e} is used. + +@item --data-stack-size @samp{size} +@item -d @samp{size} +Allocate @samp{size} space for the data stack instead of using the +default specified in the image (typically 16K). + +@item --return-stack-size @samp{size} +@item -r @samp{size} +Allocate @samp{size} space for the return stack instead of using the +default specified in the image (typically 16K). + +@item --fp-stack-size @samp{size} +@item -f @samp{size} +Allocate @samp{size} space for the floating point stack instead of +using the default specified in the image (typically 16K). In this case +the unit specifier @code{e} refers to floating point numbers. + +@item --locals-stack-size @samp{size} +@item -l @samp{size} +Allocate @samp{size} space for the locals stack instead of using the +default specified in the image (typically 16K). + +@end table + +As explained above, the image-specific command-line arguments for the +default image @file{gforth.fi} consist of a sequence of filenames and +@code{-e @samp{forth-code}} options that are interpreted in the seqence +in which they are given. The @code{-e @samp{forth-code}} or +@code{--evaluate @samp{forth-code}} option evaluates the forth +code. This option takes only one argument; if you want to evaluate more +Forth words, you have to quote them or use several @code{-e}s. To exit +after processing the command line (instead of entering interactive mode) +append @code{-e bye} to the command line. + +Not yet implemented: +On startup the system first executes the system initialization file +(unless the option @code{--no-init-file} is given; note that the system +resulting from using this option may not be ANS Forth conformant). Then +the user initialization file @file{.gforth.fs} is executed, unless the +option @code{--no-rc} is given; this file is first searched in @file{.}, +then in @file{~}, then in the path given by the normal path (see below). @node Words, , Invocation, Top @chapter Forth Words @@ -357,11 +414,11 @@ variables. Note that while every sane Fo point stack, this is not strictly required; an ANS Forth system could theoretically keep floating point numbers on the data stack. As an additional difficulty, you don't know how many cells a floating point -numkber takes. It is reportedly possible to write words in a way that +number takes. It is reportedly possible to write words in a way that they work also for a unified stack model, but we do not recommend trying it. Also, a Forth system is allowed to keep the local variables on the return stack. This is reasonable, as local variables usually eliminate -the need to use the return stack explicitely. So, if you want to produce +the need to use the return stack explicitly. So, if you want to produce a standard complying program and if you are using local variables in a word, forget about return stack manipulations in that word (see the standard document for the exact rules). @@ -402,6 +459,8 @@ r@ rdrop 2>r 2r> +2r@ +2rdrop @subsection Locals stack