[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.25 and 1.27

version 1.25, 2025/04/18 01:23:05 version 1.27, 2025/04/18 15:39:23
Line 1494  Always @emph{true} Line 1494  Always @emph{true}
 @cindex intrinsic functions, $ZCALL  @cindex intrinsic functions, $ZCALL
 @cindex intrinsic functions, implementation-specific  @cindex intrinsic functions, implementation-specific
   
   Purpose unknown.
   
 @node $ZCRC()  @node $ZCRC()
 @section $ZCRC  @section $ZCRC
 @cindex $ZCRC  @cindex $ZCRC
Line 1514  Returns a checksum of @code{arg1}. Line 1516  Returns a checksum of @code{arg1}.
 @cindex intrinsic functions, $ZDATA  @cindex intrinsic functions, $ZDATA
 @cindex intrinsic functions, implementation-specific  @cindex intrinsic functions, implementation-specific
   
   Purpose unknown.
   
 @node $ZDATE()  @node $ZDATE()
 @section $ZDATE  @section $ZDATE
 @cindex $ZDATE  @cindex $ZDATE
Line 1538  The optional @emph{<format-string>} foll Line 1542  The optional @emph{<format-string>} foll
 @cindex intrinsic functions, $ZEDIT  @cindex intrinsic functions, $ZEDIT
 @cindex intrinsic functions, implementation-specific  @cindex intrinsic functions, implementation-specific
   
   Purpose unknown.
   
 @node $ZHOROLOG()  @node $ZHOROLOG()
 @section $ZHOROLOG  @section $ZHOROLOG
 @cindex $ZHOROLOG  @cindex $ZHOROLOG
Line 1562  $ZHOROLOG(@emph{<date-value>},@emph{<for Line 1568  $ZHOROLOG(@emph{<date-value>},@emph{<for
 @cindex intrinsic functions, $ZKEY  @cindex intrinsic functions, $ZKEY
 @cindex intrinsic functions, implementation-specific  @cindex intrinsic functions, implementation-specific
   
   Purpose unknown.
   
 @node $ZLENGTH()  @node $ZLENGTH()
 @section $ZLENGTH  @section $ZLENGTH
 @cindex $ZLENGTH  @cindex $ZLENGTH
 @cindex intrinsic functions, $ZLENGTH  @cindex intrinsic functions, $ZLENGTH
 @cindex intrinsic functions, implementation-specific  @cindex intrinsic functions, implementation-specific
   
   Purpose unknown.
   
 @node $ZLSD()  @node $ZLSD()
 @section $ZLSD  @section $ZLSD
 @cindex $ZLSD  @cindex $ZLSD
Line 1596  Returns the Levenshtein distance between Line 1606  Returns the Levenshtein distance between
 @cindex intrinsic functions, $ZNAME  @cindex intrinsic functions, $ZNAME
 @cindex intrinsic functions, implementation-specific  @cindex intrinsic functions, implementation-specific
   
   Purpose unknown.
   
 @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.
   
 @node $ZORDER()  @node $ZORDER()
 @section $ZORDER  @section $ZORDER
 @cindex $ZORDER  @cindex $ZORDER
 @cindex intrinsic functions, $ZORDER  @cindex intrinsic functions, $ZORDER
 @cindex intrinsic functions, implementation-specific  @cindex intrinsic functions, implementation-specific
   
   Purpose unknown.
   
 @node $ZPIECE()  @node $ZPIECE()
 @section $ZPIECE  @section $ZPIECE
 @cindex $ZPIECE  @cindex $ZPIECE
 @cindex intrinsic functions, $ZPIECE  @cindex intrinsic functions, $ZPIECE
 @cindex intrinsic functions, implementation-specific  @cindex intrinsic functions, implementation-specific
   
   Purpose unknown.
   
 @node $ZPREVIOUS()  @node $ZPREVIOUS()
 @section $ZPREVIOUS  @section $ZPREVIOUS
 @cindex $ZPREVIOUS  @cindex $ZPREVIOUS
 @cindex intrinsic functions, $ZPREVIOUS  @cindex intrinsic functions, $ZPREVIOUS
 @cindex intrinsic functions, implementation-specific  @cindex intrinsic functions, implementation-specific
   
   Purpose unknown.
   
 @node $ZREPLACE()  @node $ZREPLACE()
 @section $ZREPLACE  @section $ZREPLACE
 @cindex $ZREPLACE  @cindex $ZREPLACE
Line 1918  Identical to @ref{$TRANSLATE()}, except Line 1938  Identical to @ref{$TRANSLATE()}, except
 * WITH::                                Set prefix for future variable references.  * WITH::                                Set prefix for future variable references.
 * 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.
 * ZALLOCATE::                           Alternative to @code{LOCK}.  
 * ZBREAK::                              Unknown.  * ZBREAK::                              Unknown.
 * ZDEALLOCATE::                         Alternative to @code{LOCK}.  
 * ZGO::                                 Unknown.  * ZGO::                                 Unknown.
 * ZHALT::                               Unknown.  * ZHALT::                               Unknown.
 * ZINSERT::                             Insert code into routine buffer.  * ZINSERT::                             Insert code into routine buffer.
Line 2491  In the above @emph{inclusive} form, @cod Line 2509  In the above @emph{inclusive} form, @cod
 @cartouche  @cartouche
 @quotation  @quotation
 @emph{Note}  @emph{Note}
 The below @emph{argumentless} and @emph{exclusive} forms of @code{KSUBSCRIPTS} are not implemented in FreeM, as of version 0.3.3, but are planned for a future release.  The below @emph{argumentless} and @emph{exclusive} forms of @code{KSUBSCRIPTS} are not implemented in FreeM, as of version 0.64.0-rc0, but are planned for a future release.
 @end quotation  @end quotation
 @end cartouche  @end cartouche
   
Line 2567  LOCK[@emph{:postcondition}] [+|-]@emph{n Line 2585  LOCK[@emph{:postcondition}] [+|-]@emph{n
   
 @emph{Example}  @emph{Example}
   
 This example will increment the lock counter for @code{^JPW} and decrement the lock counter for @code{^MJR}.  This example will increment the lock counter for @code{^SNW} and decrement the lock counter for @code{^MJR}.
   
 @example  @example
 LOCK +^JPW,-^MJR  LOCK +^SNW,-^MJR
 @end example  @end example
   
 In its non-incremental form, @code{LOCK} releases all @code{LOCK}s held by the current process, and then attempts to acquire a lock on each @emph{name}, provided the optional @emph{postcondition} evaluates to @emph{true} or is omitted. If @emph{timeout} is supplied, FreeM will attempt to lock @emph{name} for no more than @emph{timeout} seconds.  In its non-incremental form, @code{LOCK} releases all @code{LOCK}s held by the current process, and then attempts to acquire a lock on each @emph{name}, provided the optional @emph{postcondition} evaluates to @emph{true} or is omitted. If @emph{timeout} is supplied, FreeM will attempt to lock @emph{name} for no more than @emph{timeout} seconds.
Line 2643  NEW@emph{:postcondition} @emph{name}=@em Line 2661  NEW@emph{:postcondition} @emph{name}=@em
   
 In its initializing form, @code{NEW} stacks variable @emph{name} and sets its value to @emph{expr}, provided the optional @emph{postcondition} evaluates to @emph{true} or is omitted. When the current stack frame is exited, the previous value is restored.  In its initializing form, @code{NEW} stacks variable @emph{name} and sets its value to @emph{expr}, provided the optional @emph{postcondition} evaluates to @emph{true} or is omitted. When the current stack frame is exited, the previous value is restored.
   
   @emph{Syntax}
   @example
   NEW@emph{:postcondition} @emph{name}=$%@emph{^CLASS}(@emph{initializer-list})
   @end example
   
   In its object-oriented form, @code{NEW} creates an instance of class @emph{^CLASS} in local variable @emph{name} and calls the constructor of @emph{^CLASS}, passing @emph{initializer-list} as its argument(s).
   
 @node OPEN  @node OPEN
 @section OPEN  @section OPEN
 @cindex OPEN  @cindex OPEN
Line 3006  Closes all global data files open in the Line 3031  Closes all global data files open in the
 VIEW 21  VIEW 21
 @end example  @end example
   
 @item @code{29} - Symbol Table Copy  
 Copies the primary symbol table's contents to the alternate symbol table. Takes no arguments.  
   
 @emph{Syntax}  
 @example  
 VIEW 29  
 @end example  
   
 @item @code{52} - Set G0 Input Translation Table for @code{$IO}  @item @code{52} - Set G0 Input Translation Table for @code{$IO}
   
 @emph{Syntax}  @emph{Syntax}
Line 3162  If @emph{tvexpr} evaluates to @emph{true Line 3179  If @emph{tvexpr} evaluates to @emph{true
 VIEW 83:@emph{tvexpr}  VIEW 83:@emph{tvexpr}
 @end example  @end example
   
 @item @code{87} - Date Type Definition  
 We believe this defines date formats for @code{$ZDATE}, but we have not yet figured out how it works.  
   
 @emph{Syntax}  
 @example  
 ; Syntax unknown  
 @end example  
   
 @item @code{88} - Time Type Definition  
 We believe this defines time formats for @code{$ZTIME}, but we have not yet figured out how it works.  
   
 @emph{Syntax}  
 @example  
 ; Syntax unknown  
 @end example  
   
 @item @code{91} - Set Default Expression for Missing @code{QUIT} Expression  
 Sets the default expression to be printed when a @code{QUIT} is encountered where a @code{QUIT} argument would be expected, but was not provided. We're not entirely sure what this does.  
   
 @emph{Syntax}  
 @example  
 ; Syntax unknown  
 @end example  
   
 @item @code{92} - Set Type Mismatch Error Flag on @code{EUR2DEM}  @item @code{92} - Set Type Mismatch Error Flag on @code{EUR2DEM}
 If @emph{tvexpr} evaluates to @emph{true}, a type mismatch error will be thrown in @code{EUR2DEM} currency conversions in certain situations that we do not yet understand.  If @emph{tvexpr} evaluates to @emph{true}, a type mismatch error will be thrown in @code{EUR2DEM} currency conversions in certain situations that we do not yet understand.
   
Line 3343  DEFAULT.USER> WATCH ?^JPW(1) Line 3336  DEFAULT.USER> WATCH ?^JPW(1)
 @cindex commands, non-standard  @cindex commands, non-standard
 @emph{FreeM Extension}  @emph{FreeM Extension}
   
   NOTE: This command may be deprecated and removed in future FreeM releases.
   
 Sets a prefix to be applied to all subsequent local variable or constant references.  Sets a prefix to be applied to all subsequent local variable or constant references.
   
 @emph{Syntax}  @emph{Syntax}
Line 3372  In the above argumentless form, clears t Line 3367  In the above argumentless form, clears t
 @cindex XECUTE  @cindex XECUTE
 @cindex commands, XECUTE  @cindex commands, XECUTE
   
 @node ZALLOCATE  
 @section ZALLOCATE  
 @cindex ZALLOCATE  
 @cindex commands, ZALLOCATE  
 @cindex commands, implementation-specific  
 @cindex commands, non-standard  
 @emph{FreeM Extension}  
   
 @node ZBREAK  @node ZBREAK
 @section ZBREAK  @section ZBREAK
 @cindex ZBREAK  @cindex ZBREAK
Line 3389  In the above argumentless form, clears t Line 3376  In the above argumentless form, clears t
 @cindex commands, non-standard  @cindex commands, non-standard
 @emph{FreeM Extension}  @emph{FreeM Extension}
   
 @node ZDEALLOCATE  
 @section ZDEALLOCATE  
 @cindex ZDEALLOCATE  
 @cindex commands, ZDEALLOCATE  
 @cindex commands, implementation-specific  
 @cindex commands, non-standard  
 @emph{FreeM Extension}  
   
 @node ZGO  @node ZGO
 @section ZGO  @section ZGO
 @cindex ZGO  @cindex ZGO
Line 3885  Returns or sets the maximum number of ch Line 3864  Returns or sets the maximum number of ch
 Returns or sets the maximum number of characters of a single global subscript, from 1-255.  Returns or sets the maximum number of characters of a single global subscript, from 1-255.
   
 @item @code{SINGLE_USER} +R +U -D  @item @code{SINGLE_USER} +R +U -D
 If set to @code{1}, FreeM will skip all file locking operations on globals, as well as the @code{LOCK} and @code{ZALLOCATE} tables. If set to @code{0}, FreeM will enforce file locking on both.  If set to @code{1}, FreeM will skip all file locking operations on globals. If set to @code{0}, FreeM will enforce file locking on both.
   
 Setting @code{SINGLE_USER} to @code{1} will improve FreeM performance, but you must @emph{ONLY} use this on systems where you are absolutely sure that only one FreeM process will run at any given time, as running multiple instances of FreeM concurrently when any of them are set to @code{SINGLE_USER} mode @emph{will} cause global data and @code{LOCK}/@code{ZALLOCATE} table corruption!  Setting @code{SINGLE_USER} to @code{1} will improve FreeM performance, but you must @emph{ONLY} use this on systems where you are absolutely sure that only one FreeM process will run at any given time, as running multiple instances of FreeM concurrently when any of them are set to @code{SINGLE_USER} mode @emph{will} cause global data corruption.
   
 @item @code{CHARACTER} +R -U -D  @item @code{CHARACTER} +R -U -D
 Returns the character set of the job.  Returns the character set of the job.
Line 5859  The FreeM @code{LOCK} table. Line 5838  The FreeM @code{LOCK} table.
   
 Supported actions are @code{list} and @code{remove}.  Supported actions are @code{list} and @code{remove}.
   
 @item zallocate  
 The FreeM @code{ZALLOCATE} table.  
   
 No actions yet implemented.  
   
 @item journal  @item journal
 FreeM after-image journaling.  FreeM after-image journaling.
   
Removed from v.1.25  
changed lines
  Added in v.1.27

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