[BACK]Return to freem.texi CVS log [TXT] [DIR] Up to [Coherent Logic Development] / freem / doc

Diff for /freem/doc/freem.texi between versions 1.57 and 1.61

version 1.57, 2025/05/17 17:00:05 version 1.61, 2025/05/19 12:45:01
Line 49  This is the official manual for the Free Line 49  This is the official manual for the Free
 * The FreeM Environment Daemon::        Managing shared resources in the FreeM environment.  * The FreeM Environment Daemon::        Managing shared resources in the FreeM environment.
 * The FreeM Direct-Mode Environment::   Executing M programs interactively.  * The FreeM Direct-Mode Environment::   Executing M programs interactively.
 * Debugging::                           The program development cycle of FreeM.  * Debugging::                           The program development cycle of FreeM.
   * Program Development Cycle::           How to create, edit, test, and run FreeM programs.
   
 * Directives::                          Per-Routine Language Directives.  * Directives::                          Per-Routine Language Directives.
 * Intrinsic Special Variables::         Intrinsic Special Variables.  * Intrinsic Special Variables::         Intrinsic Special Variables.
Line 429  If the daemon is started with @option{-- Line 430  If the daemon is started with @option{--
   
 The @option{--environment} option will start the daemon for the specified @emph{environment-name}. The default environment, if unspecified, is called @code{DEFAULT}. If using an environment other than @code{DEFAULT}, interpreter processes that wish to also connect to the same environment must also use the @option{--environment} option when starting, and @code{libfreem} clients must also pass the environment name as the first argument to the @code{freem_init()} function. Environments allow you to run multiple, isolated instances of FreeM on the same machine, whose globals and routines are distinct and unique.  The @option{--environment} option will start the daemon for the specified @emph{environment-name}. The default environment, if unspecified, is called @code{DEFAULT}. If using an environment other than @code{DEFAULT}, interpreter processes that wish to also connect to the same environment must also use the @option{--environment} option when starting, and @code{libfreem} clients must also pass the environment name as the first argument to the @code{freem_init()} function. Environments allow you to run multiple, isolated instances of FreeM on the same machine, whose globals and routines are distinct and unique.
   
 The @option{--shmsize} option specifies the size in bytes of the FreeM shared memory segment. The default is 4194304 bytes. Increasing the size of the FreeM shared memory segment will, at the cost of increased memory usage, increase the number of concurrent jobs and lock table entries available to the environment; decreasing the size of the segment will have the expected opposite effect. Note that you must also pass @option{--shmsize} with the same number of bytes to any interpreter process to be used with an environment whose daemon uses a non-default shared memory segment size.  The @option{--shmsize} option specifies the size in bytes of the FreeM shared memory segment. The default is 16,777,216 bytes (16 megabytes). Increasing the size of the FreeM shared memory segment will, at the cost of increased memory usage, increase the number of concurrent jobs and lock table entries available to the environment; decreasing the size of the segment will have the expected opposite effect. Note that you must also pass @option{--shmsize} with the same number of bytes to any interpreter process to be used with an environment whose daemon uses a non-default shared memory segment size.
   
 Attempting to start a FreeM interpreter process without a daemon running with the same environment name will result in an error.  Attempting to start a FreeM interpreter process without a daemon running with the same environment name will result in an error.
   
Line 606  FreeM includes an interactive debugger, Line 607  FreeM includes an interactive debugger,
 If you would like to enter the debugger automatically each time an error is encountered, add the following to your @code{LCLINIT} routine:  If you would like to enter the debugger automatically each time an error is encountered, add the following to your @code{LCLINIT} routine:
   
 @example  @example
 S $ETR="B ""DEBUG"""  S $ETRAP="B ""DEBUG"""
 @end example  @end example
   
 @section Debugging Commands  @section Debugging Commands
Line 633  Halts the process being debugged and ret Line 634  Halts the process being debugged and ret
 With no arguments, toggles watchpoints on and off. With @code{+}, adds @emph{<glvn>} to the watchlist. With @code{-}, removes @emph{<glvn>} from the watchlist. With @code{?}, queries the watch status of @emph{<glvn>}.  With no arguments, toggles watchpoints on and off. With @code{+}, adds @emph{<glvn>} to the watchlist. With @code{-}, removes @emph{<glvn>} from the watchlist. With @code{?}, queries the watch status of @emph{<glvn>}.
 @end table  @end table
   
   @node Program Development Cycle
   @chapter Program Development Cycle
   @cindex program development
   
   This chapter covers the essential activities of program development in the FreeM environment, including viewing, creating, editing, and running routines.
   
 @node Directives  @node Directives
 @chapter Directives  @chapter Directives
 @cindex directives  @cindex directives
Line 2099  Identical to @ref{$TRANSLATE()}, except Line 2106  Identical to @ref{$TRANSLATE()}, except
 * ZASSERT::                             Raise error when a conditional expression evaluates @emph{false}.  * ZASSERT::                             Raise error when a conditional expression evaluates @emph{false}.
 * ZBREAK::                              Enable/disable ZBREAK mode.  * ZBREAK::                              Enable/disable ZBREAK mode.
 * ZCONST::                              Define a constant that cannot be altered after initial definition.  * ZCONST::                              Define a constant that cannot be altered after initial definition.
   * ZEDIT::                               Edit a routine using an external editor.
 * ZGOTO::                               @code{GOTO} with @code{BREAK} control.  * ZGOTO::                               @code{GOTO} with @code{BREAK} control.
 * ZHALT::                               Exit FreeM job with return value.  * ZHALT::                               Exit FreeM job with return value.
 * ZINSERT::                             Insert code into routine buffer.  * ZINSERT::                             Insert code into routine buffer.
Line 3442  Constants must only be locals, and globa Line 3450  Constants must only be locals, and globa
 @code{ZCONST@emph{:postcondition} @emph{mref1}=@emph{initial-value1},...,@emph{mrefN}=@emph{initial-valueN}}  @code{ZCONST@emph{:postcondition} @emph{mref1}=@emph{initial-value1},...,@emph{mrefN}=@emph{initial-valueN}}
 @end example  @end example
   
   @node ZEDIT
   @section ZEDIT
   @cindex ZEDIT
   @cindex commands, ZEDIT
   @cindex commands, non-standard
   @emph{FreeM Extension}
   
   Edits a routine using an external editor. Uses environment variable @code{$EDITOR} if defined; otherwise, uses @code{vi}.
   
   @emph{Syntax}
   
   @example
   ZEDIT@emph{[:postcondition]}
   @end example
   
   In its argumentless form, edits the currently-active routine, provided the optional @emph{postcondition} is @emph{true} or omitted.
   
   @emph{Syntax}
   
   @example
   ZEDIT@emph{[:postcondition]} @emph{<routine-name>}
   @end example
   
   In its single-argument form, edits @emph{<routine-name>}, provided the optional @emph{postcondition} is @emph{true} or omitted.
   
   Routine names must not be quoted, and must not included a leading caret (@code{^}).
   
   @emph{Errors}
   
   @code{ZEDIT} will raise @code{ZNOPGM} if the routine cannot be found, or there is no routine currently loaded in argumentless form.
   
 @node ZGOTO  @node ZGOTO
 @section ZGOTO  @section ZGOTO
 @cindex ZGOTO  @cindex ZGOTO
Line 3450  Constants must only be locals, and globa Line 3489  Constants must only be locals, and globa
 @cindex commands, non-standard  @cindex commands, non-standard
 @emph{FreeM Extension}  @emph{FreeM Extension}
   
 In its argumented form, enables @code{BREAK} mode and branches unconditionally to @emph{entryref}.  In its single-argument form, enables @code{BREAK} mode and branches unconditionally to @emph{entryref}.
   
 @emph{Syntax}  @emph{Syntax}
   
Line 3458  In its argumented form, enables @code{BR Line 3497  In its argumented form, enables @code{BR
 ZGOTO @emph{entryref}  ZGOTO @emph{entryref}
 @end example  @end example
   
 In its argumented form, resumes execution after a @code{BREAK}.  In its argumentless form, resumes execution after a @code{BREAK}.
   
 @emph{Syntax}  @emph{Syntax}
   
Line 3498  ZHALT Line 3537  ZHALT
 @cindex commands, non-standard  @cindex commands, non-standard
 @emph{FreeM Extension}  @emph{FreeM Extension}
   
   Inserts a line of M code into the currently-active routine buffer, provided the optional @emph{postcondition} is @emph{true} or omitted.
   
   @emph{Syntax}
   
   @example
   ZINSERT@emph{:postcondition} @emph{expr V mcode}[:@emph{label}]
   @end example
   
   Above, @emph{expr V mcode} is an expression returning a string giving M code. If @emph{label} is omitted, the code will be inserted at the insertion point, which is typically the end of the routine. Otherwise, the code will be inserted at the line immediately following @emph{label}.
   
 @node ZJOB  @node ZJOB
 @section ZJOB  @section ZJOB
 @cindex ZJOB  @cindex ZJOB
Line 3558  ZMAP[@emph{:postcondition}] GLOBAL @emph Line 3607  ZMAP[@emph{:postcondition}] GLOBAL @emph
 @cindex commands, non-standard  @cindex commands, non-standard
 @emph{FreeM Extension}  @emph{FreeM Extension}
   
 Prints the contents of the current routine buffer, provided the optional @emph{postcondition} is @emph{true} or omitted.  In argumentless form, prints the contents of the current routine buffer, provided the optional @emph{postcondition} is @emph{true} or omitted.
   
 @emph{Syntax}  @emph{Syntax}
   
Line 3566  Prints the contents of the current routi Line 3615  Prints the contents of the current routi
 ZPRINT@emph{:postcondition}  ZPRINT@emph{:postcondition}
 @end example  @end example
   
   In argumented form, prints a subset of the current routine buffer, provided the optional @emph{postcondition} is @emph{true} or omitted.
   
   @emph{Syntax}
   
   @example
   ZPRINT@emph{:postcondition} @emph{start}[:@emph{end}]
   @end example
   
   In the above syntax, @emph{start} and @emph{end} can be a tag in the current routine, or @code{*} to indicate the routine buffer insertion point (typically the end of the routine).
   
 @node ZQUIT  @node ZQUIT
 @section ZQUIT  @section ZQUIT
 @cindex ZQUIT  @cindex ZQUIT
Line 3592  In its argumentless form, quits from @co Line 3651  In its argumentless form, quits from @co
 @cindex commands, non-standard  @cindex commands, non-standard
 @emph{FreeM Extension}  @emph{FreeM Extension}
   
   In argumentless form, removes all M code from the current routine buffer, provided the optional @emph{postcondition} is @emph{true} or omitted.
   
   @emph{Syntax}
   
   @example
   ZREMOVE@emph{:postcondition}
   @end example
   
   In argumented form, removes a subset of the current routine buffer, provided the optional @emph{postcondition} is @emph{true} or omitted.
   
   @emph{Syntax}
   
   @example
   ZREMOVE@emph{:postcondition} @emph{start}[:@emph{end}]
   @end example
   
   In the above syntax, @emph{start} and @emph{end} can be a tag in the current routine, or @code{*} to indicate the routine buffer insertion point (typically the end of the routine).
   
 @node ZSAVE  @node ZSAVE
 @section ZSAVE  @section ZSAVE
 @cindex ZSAVE  @cindex ZSAVE
Removed from v.1.57  
changed lines
  Added in v.1.61

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