[BACK]Return to gforth.ds CVS log [TXT] [DIR] Up to [gforth] / gforth / doc

Diff for /gforth/doc/gforth.ds between versions 1.120 and 1.121

version 1.120, 2004/01/13 16:00:56 version 1.121, 2004/01/16 21:27:30
Line 217  Forth Words Line 217  Forth Words
 * Files::                         * Files::                       
 * Blocks::                        * Blocks::                      
 * Other I/O::                     * Other I/O::                   
   * OS command line arguments::   
 * Locals::                        * Locals::                      
 * Structures::                    * Structures::                  
 * Object-oriented Forth::         * Object-oriented Forth::       
Line 831  As explained above, the image-specific c Line 832  As explained above, the image-specific c
 default image @file{gforth.fi} consist of a sequence of filenames and  default image @file{gforth.fi} consist of a sequence of filenames and
 @code{-e @var{forth-code}} options that are interpreted in the sequence  @code{-e @var{forth-code}} options that are interpreted in the sequence
 in which they are given. The @code{-e @var{forth-code}} or  in which they are given. The @code{-e @var{forth-code}} or
 @code{--evaluate @var{forth-code}} option evaluates the Forth  @code{--evaluate @var{forth-code}} option evaluates the Forth code. This
 code. This option takes only one argument; if you want to evaluate more  option takes only one argument; if you want to evaluate more Forth
 Forth words, you have to quote them or use @code{-e} several times. To exit  words, you have to quote them or use @code{-e} several times. To exit
 after processing the command line (instead of entering interactive mode)  after processing the command line (instead of entering interactive mode)
 append @code{-e bye} to the command line.  append @code{-e bye} to the command line.  You can also process the
   command-line arguments with a Forth program (@pxref{OS command line
   arguments}).
   
 @cindex versions, invoking other versions of Gforth  @cindex versions, invoking other versions of Gforth
 If you have several versions of Gforth installed, @code{gforth} will  If you have several versions of Gforth installed, @code{gforth} will
Line 4212  the exercises in a .fs file in the distr Line 4215  the exercises in a .fs file in the distr
 * Files::                         * Files::                       
 * Blocks::                        * Blocks::                      
 * Other I/O::                     * Other I/O::                   
   * OS command line arguments::   
 * Locals::                        * Locals::                      
 * Structures::                    * Structures::                  
 * Object-oriented Forth::         * Object-oriented Forth::       
Line 8880  problem yourself, and then return to reg Line 8884  problem yourself, and then return to reg
 doc-broken-pipe-error  doc-broken-pipe-error
   
   
   @node OS command line arguments, Locals, Other I/O, Words
   @section OS command line arguments
   @cindex OS command line arguments
   @cindex command line arguments, OS
   @cindex arguments, OS command line
   
   The usual way to pass arguments to Gforth programs on the command line
   is via the @option{-e} option, e.g.
   
   @example
   gforth -e "123 456" foo.fs -e bye
   @end example
   
   However, you may want to interpret the command-line arguments directly.
   In that case, you can access the (image-specific) command-line arguments
   through the variables @code{argc} and @code{argv}. @code{arg} provides
   convenient access to @code{argv}.
   
   doc-argc
   doc-argv
   doc-arg
   
   If you are using these words from @code{'cold}, the (image-specific)
   arguments start at index 1.  If you are using these words during
   Gforth's argument processing (e.g., while including a file on the
   command line), you can use @code{arg#} to get the current index and for
   skipping arguments.
   
   doc-arg#
   
   Here's an example program using @code{arg#}:
   
   @example
   : echo ( -- )
       argc @ arg# @ 1+ +do
           i arg type space
           1 arg# +!
       loop ;
   
   echo cr bye
   @end example
   
   This can be invoked with
   
   @example
   gforth echo.fs hello world
   @end example
   
 @c -------------------------------------------------------------  @c -------------------------------------------------------------
 @node Locals, Structures, Other I/O, Words  @node Locals, Structures, Other I/O, Words
 @section Locals  @section Locals
Line 14259  You can make a turnkey image by letting Line 14311  You can make a turnkey image by letting
 (your turnkey application) that never returns; instead, it exits Gforth  (your turnkey application) that never returns; instead, it exits Gforth
 via @code{bye} or @code{throw}.  via @code{bye} or @code{throw}.
   
 @cindex command-line arguments, access  You can access the (image-specific) command-line arguments through
 @cindex arguments on the command line, access  @code{argc}, @code{argv} and @code{arg} (@pxref{OS command line
 You can access the (image-specific) command-line arguments through the  arguments}).
 variables @code{argc} and @code{argv}. @code{arg} provides convenient  
 access to @code{argv}.  
   
 If @code{'cold} exits normally, Gforth processes the command-line  If @code{'cold} exits normally, Gforth processes the command-line
 arguments as files to be loaded and strings to be evaluated.  Therefore,  arguments as files to be loaded and strings to be evaluated.  Therefore,
 @code{'cold} should remove the arguments it has used in this case.  @code{'cold} should remove the arguments it has used in this case.
   
   
   
 doc-'cold  doc-'cold
 doc-argc  
 doc-argv  
 doc-arg  
   
   
   
 @c ******************************************************************  @c ******************************************************************
 @node Engine, Cross Compiler, Image Files, Top  @node Engine, Cross Compiler, Image Files, Top
Removed from v.1.120  
changed lines
  Added in v.1.121

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