Diff for /freem/doc/freem.texi between versions 1.47 and 1.52

version 1.47, 2025/05/05 12:55:17 version 1.52, 2025/05/05 15:46:50
Line 1115  See @emph{https://wiki.osdev.org/Target_ Line 1115  See @emph{https://wiki.osdev.org/Target_
 * $ZLSD()::                             Compute Levenshtein distance between two arguments.  * $ZLSD()::                             Compute Levenshtein distance between two arguments.
 * $ZM()::                               Unknown.  * $ZM()::                               Unknown.
 * $ZNAME()::                            Unknown.  * $ZNAME()::                            Unknown.
 * $ZNEXT()::                            Unknown.  * $ZNEXT()::                            Return glvn of next numeric subscript following given glvn.
 * $ZORDER()::                           Unknown.  * $ZORDER()::                           Unknown.
 * $ZPIECE()::                           Unknown.  * $ZPIECE()::                           Unknown.
 * $ZPREVIOUS()::                        Unknown.  * $ZPREVIOUS()::                        Unknown.
Line 1313  The optional second argument indicates t Line 1313  The optional second argument indicates t
 @cindex intrinsic functions, $NEXT  @cindex intrinsic functions, $NEXT
   
 Deprecated. Use @code{$ORDER} instead.  Deprecated. Use @code{$ORDER} instead.
   Returns the next numeric subscript of the specified glvn.
   
   @emph{Syntax}
   
   @example
   $NEXT(@emph{glvn})
   @end example
   
   @emph{Example}
   
   Assume the following array:
   
   @example
   ^foo(1)=""
   ^foo(2)=""
   @end example
   
   And the following code:
   
   @example
    W $ZNEXT(^foo(1)) ; => 2
   @end example 
   
 @node $ORDER()  @node $ORDER()
 @section $ORDER  @section $ORDER
Line 1713  Returns the Levenshtein distance between Line 1735  Returns the Levenshtein distance between
 @cindex intrinsic functions, $ZM  @cindex intrinsic functions, $ZM
 @cindex intrinsic functions, implementation-specific  @cindex intrinsic functions, implementation-specific
   
   Purpose unknown.
   
 @node $ZNAME()  @node $ZNAME()
 @section $ZNAME  @section $ZNAME
 @cindex $ZNAME  @cindex $ZNAME
Line 1721  Returns the Levenshtein distance between Line 1745  Returns the Levenshtein distance between
   
 Purpose unknown.  Purpose unknown.
   
   This function relies on the value of @code{$VIEW(71)} being @code{0} (this is not the default).
   
 @node $ZNEXT()  @node $ZNEXT()
 @section $ZNEXT  @section $ZNEXT
 @cindex $ZNEXT  @cindex $ZNEXT
 @cindex intrinsic functions, $ZNEXT  @cindex intrinsic functions, $ZNEXT
 @cindex intrinsic functions, implementation-specific  @cindex intrinsic functions, implementation-specific
   
 Purpose unknown.  Returns a fully-formed variable reference of the next numeric subscript of the specified glvn.
   
   @emph{Syntax}
   
   @example
   $ZNEXT(@emph{glvn})
   @end example
   
   @emph{Example}
   
   Assume the following array:
   
   @example
   ^foo(1)=""
   ^foo(2)=""
   @end example
   
   And the following code:
   
   @example
    W $ZNEXT(^foo(1)) ; => ^foo(2)
   @end example
   
   This function relies on the value of @code{$VIEW(71)} being @code{1} (this is the default).
   
 @node $ZORDER()  @node $ZORDER()
 @section $ZORDER  @section $ZORDER
Line 2045  Identical to @ref{$TRANSLATE()}, except Line 2094  Identical to @ref{$TRANSLATE()}, except
 * WRITE::                               Write output to current input/output device.  * WRITE::                               Write output to current input/output device.
 * XECUTE::                              Interpret string as M code.  * XECUTE::                              Interpret string as M code.
 * ZASSERT::                             Raise error when a conditional expression evaluates @emph{false}.  * ZASSERT::                             Raise error when a conditional expression evaluates @emph{false}.
 * ZBREAK::                              Unknown.  * 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.
 * ZGO::                                 Unknown.  * ZGOTO::                               @code{GOTO} with @code{BREAK} control.
 * ZHALT::                               Unknown.  * ZHALT::                               Exit FreeM job with return value.
 * ZINSERT::                             Insert code into routine buffer.  * ZINSERT::                             Insert code into routine buffer.
 * ZJOB::                                Invokes a job, ignoring any timeouts.  * ZJOB::                                Invoke job, ignoring any timeouts.
 * ZLOAD::                               Load routine into routine buffer.  * ZLOAD::                               Load routine into routine buffer.
 * ZMAP::                                Map a global name to a non-default namespace.  * ZMAP::                                Map a global name to a non-default namespace.
 * ZNEW::                                Unknown.  * ZNEW::                                Unknown.
 * ZPRINT::                              Print contents of routine buffer.  * ZPRINT::                              Print contents of routine buffer.
 * ZQUIT::                               Quits multiple stack levels at once.  * ZQUIT::                               Quit multiple stack levels at once.
 * ZREMOVE::                             Remove code from routine buffer.  * ZREMOVE::                             Remove code from routine buffer.
 * ZSAVE::                               Save routine buffer to disk.  * ZSAVE::                               Save routine buffer to disk.
 * ZTHROW::                              Programmatically raise an error condition.  * ZTHROW::                              Programmatically raise an error condition.
 * ZTRAP::                               Unknown.  * ZTRAP::                               Raise a FreeM error.
 * ZUNMAP::                              Remove a mapping of a global to a non-default namespace.  * ZUNMAP::                              Remove a mapping of a global to a non-default namespace.
 * ZWATCH::                              Enable or disable watchpoints, or set or clear watchpoints on specified globals, locals, or structured system variables.  * ZWATCH::                              Enable or disable watchpoints, or set or clear watchpoints on specified globals, locals, or structured system variables.
 * ZWITH::                               Set prefix for future variable references.  * ZWITH::                               Set prefix for future variable references.
Line 3365  DEFAULT.USER> ZASSERT:DEBUG 1=0 Line 3414  DEFAULT.USER> ZASSERT:DEBUG 1=0
 @cindex commands, non-standard  @cindex commands, non-standard
 @emph{FreeM Extension}  @emph{FreeM Extension}
   
   Sets or clears the @code{ZBREAK} flag@footnote{NOTE: FreeM team needs to investigate how @code{zbreakon} and @code{zbflag} affect program execution.}, based on the result of evaluating @emph{tvexpr}.
   
   @emph{Syntax}
   
   @example
   ZBREAK @emph{tvexpr}
   @end example
   
 @node ZCONST  @node ZCONST
 @section ZCONST  @section ZCONST
 @cindex ZCONST  @cindex ZCONST
Line 3382  Constants must only be locals, and globa Line 3439  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 ZGO  @node ZGOTO
 @section ZGO  @section ZGOTO
 @cindex ZGO  @cindex ZGOTO
 @cindex commands, ZGO  @cindex commands, ZGOTO
 @cindex commands, implementation-specific  @cindex commands, implementation-specific
 @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}.
   
   @emph{Syntax}
   
   @example
   ZGOTO @emph{entryref}
   @end example
   
   In its argumented form, resumes execution after a @code{BREAK}.
   
   @emph{Syntax}
   
   @example
   ZGOTO
   @end example
   
 @node ZHALT  @node ZHALT
 @section ZHALT  @section ZHALT
 @cindex ZHALT  @cindex ZHALT
Line 3398  Constants must only be locals, and globa Line 3471  Constants must only be locals, and globa
 @cindex commands, non-standard  @cindex commands, non-standard
 @emph{FreeM Extension}  @emph{FreeM Extension}
   
   In its single-argumented form, @code{ZHALT} command is used to exit the FreeM process with a specific return value @emph{intexpr}.
   
   @emph{Syntax}
   
   @example
   ZHALT @emph{intexpr}
   @end example
   
   In its argumentless form, @code{ZHALT} is synonymous with @code{HALT}.
   
   @emph{Syntax}
   
   @example
   ZHALT
   @end example
   
 @node ZINSERT  @node ZINSERT
 @section ZINSERT  @section ZINSERT
 @cindex ZINSERT  @cindex ZINSERT
Line 3539  Raises an error condition as long as the Line 3628  Raises an error condition as long as the
 @cindex commands, non-standard  @cindex commands, non-standard
 @emph{FreeM Extension}  @emph{FreeM Extension}
   
   Synonymous with @ref{ZTHROW}.
   
 @node ZUNMAP  @node ZUNMAP
 @section ZUNMAP  @section ZUNMAP
 @cindex ZUNMAP  @cindex ZUNMAP

Removed from v.1.47  
changed lines
  Added in v.1.52


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