freem/doc/freem.texi - diff

Return to freem.texi CVS log

Up to [Coherent Logic Development] / freem / doc

Diff for /freem/doc/freem.texi between versions 1.40 and 1.64

-version 1.40, 2025/05/03 04:05:23
+version 1.64, 2025/05/20 14:36:06
  Line 4
  @settitle The FreeM Manual
  @copying
- This manual is for FreeM, (version 0.64.0-rc1), which is a free software@footnote{FreeM subscribes to the software licensing philosophy described in @emph{Free Software, Free Society:
+ This manual is for FreeM, (version 0.65.1-rc1), which is a free software implementation of the M programming language.
- Selected Essays of Richard M. Stallman}.} implementation of the M programming language.
  Print-optimized versions of this book are typeset in @emph{Computer Modern} by the author using the @emph{GNU Texinfo} tools.
- Line 20  Permission is granted to copy, distribut
+ Line 19  Permission is granted to copy, distribut
  @title The FreeM Manual
  @subtitle @sc{The Official Manual of FreeM}
- @subtitle Version 0.64.0-rc1
+ @subtitle Version 0.65.1-rc1
  @c@vskip 10pt
  @c@center @image{freem-logo-sm,,,,.png}
  @author Serena Willis
- Line 50  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 Direct-Mode Environment::   Executing M programs interactively.
  * Debugging::                           The program development cycle of FreeM.
+ * Program Development Cycle::           How to create, edit, test, and run FreeM programs.
  * Directives::                          Per-Routine Language Directives.
  * Intrinsic Special Variables::         Intrinsic Special Variables.
  Line 101  This is the official manual for the Free
  * Accessing FreeM from C Programs::     How to use the mlib interface.
  * FreeM Administrator::                 The fmadm system manager tool.
- * FreeM Legacy Utilities::              FreeM legacy system manager utilities.
  * FreeM VIEW Commands and Functions::   Getting and setting info about FreeM internals.
  * Implementation Limits::               FreeM limitations.
  * US-ASCII Character Set::              The US-ASCII character set.
- Line 150  Current contributors denoted with a @emp
+ Line 149  Current contributors denoted with a @emp
  @cindex contributors, Gerum, Winfried
  @cindex contributors, Kreis, Greg
  @cindex contributors, Landis, Larry
+ @cindex contributors, McGlothlen, Ken
  @cindex contributors, Milligan, Lloyd
  @cindex contributors, Morris, Steve
  @cindex contributors, Murray, John
  Line 191  Larry Landis (Coordination, Code, Docume
  Rick Marshall (Testing, MDC Conformance) @emph{+}
  @item
+ Ken McGlothlen (Apple Silicon build/test environment, proofreading of documentation) @emph{+}
+ @item
  Lloyd Milligan (Code, Testing, Documentation)
  @item
- Line 272  Refers to an M intrinsic special variabl
+ Line 275  Refers to an M intrinsic special variabl
  Indicates a @emph{list} of the following item, e.g., @emph{L gvn} means @emph{list of global variable names}.
  @item @emph{lvn}
  Refers to the name of an M local variable.
+ @item @emph{postcondition}
+ A @emph{tvexpr} immediately following a command verb affecting that command's execution.
  @item @emph{strlit}
  Refers to an M string literal.
  @item @emph{ssvn}
  Refers to the name of an M structured system variable.
  @item @emph{tvexpr}
- Refers to a truth-valued expression.
+ Refers to a truth-valued expression, i.e., an expression interpreted as a truth value.
  @end table
  @node A Note on Standards
- Line 425  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{--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.
- Line 440  Attempting to start a FreeM interpreter
+ Line 445  Attempting to start a FreeM interpreter
  The FreeM direct-mode environment is the mode entered when FreeM is invoked without the use of @option{-r @emph{<entryref>}} or @option{--routine=@emph{<entryref>}}:
  @example
- Coherent Logic Development FreeM version 0.64.0-rc1 (x86_64-pc-linux-gnu)
+ Coherent Logic Development FreeM version 0.65.1-rc1 (x86_64-pc-linux-gnu)
  Copyright (C) 2014, 2020, 2021 Coherent Logic Development LLC
- Line 602  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:
  @example
- S $ETR="B ""DEBUG"""
+ S $ETRAP="B ""DEBUG"""
  @end example
  @section Debugging Commands
- Line 629  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>}.
  @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
  @chapter Directives
  @cindex directives
- Line 699  Please note that FreeM is not entirely s
+ Line 710  Please note that FreeM is not entirely s
  * $SYSTEM::                  MDC system ID of FreeM.
  * $TEST::                    Truth value of last conditional expression or result of certain @code{LOCK} operations.
  * $TLEVEL::                  Current level of transaction nesting.
- * $WITH::                    Current variable prefix set by @code{WITH} command.
+ * $WITH::                    Current variable prefix set by @code{ZWITH} command.
  * $X::                       Current horizontal screen position.
  * $Y::                       Current vertical screen position.
  * $ZA::                      Current position of file on @code{$IO}.
- Line 895  uncommitted transactions exist.
+ Line 906  uncommitted transactions exist.
  @cindex $WITH
  @cindex intrinsic special variables, $WITH
- Returns the variable prefix set by the @code{@ref{WITH}} command.
+ Returns the variable prefix set by the @code{@ref{ZWITH}} command.
  @node $X
  @section $X
- Line 1114  See @emph{https://wiki.osdev.org/Target_
+ Line 1125  See @emph{https://wiki.osdev.org/Target_
  * $ZLSD()::                             Compute Levenshtein distance between two arguments.
  * $ZM()::                               Unknown.
  * $ZNAME()::                            Unknown.
- * $ZNEXT()::                            Unknown.
+ * $ZNEXT()::                            Return glvn of next numeric subscript following given glvn.
  * $ZORDER()::                           Unknown.
  * $ZPIECE()::                           Unknown.
  * $ZPREVIOUS()::                        Unknown.
- Line 1312  The optional second argument indicates t
+ Line 1323  The optional second argument indicates t
  @cindex intrinsic functions, $NEXT
  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()
  @section $ORDER
- Line 1712  Returns the Levenshtein distance between
+ Line 1745  Returns the Levenshtein distance between
  @cindex intrinsic functions, $ZM
  @cindex intrinsic functions, implementation-specific
+ Purpose unknown.
  @node $ZNAME()
  @section $ZNAME
  @cindex $ZNAME
- Line 1720  Returns the Levenshtein distance between
+ Line 1755  Returns the Levenshtein distance between
  Purpose unknown.
+ This function relies on the value of @code{$VIEW(71)} being @code{0} (this is not the default).
  @node $ZNEXT()
  @section $ZNEXT
  @cindex $ZNEXT
  @cindex intrinsic functions, $ZNEXT
  @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()
  @section $ZORDER
- Line 2012  Identical to @ref{$TRANSLATE()}, except
+ Line 2072  Identical to @ref{$TRANSLATE()}, except
  * !::                                   Run an external program or command.
  * !!::                                  Launch a subshell from FreeM direct mode.
  * ABLOCK::                              Increment the block counter for one or more event classes.
- * ASSERT::                              Raise error when a conditional expression evaluates @emph{false}.
  * ASTART::                              Enable asynchronous event handling for one or more event classes.
  * ASTOP::                               Disable asynchronous event handling for one or more event classes.
  * AUNBLOCK::                            Decrement the block counter for one or more event classes.
  * BREAK::                               Interrupt a running routine to allow interactive debugging.
  * CLOSE::                               Close an input/output device.
- * CONST::                               Define a constant that cannot be altered after initial definition.
  * DO::                                  Transfer program control to one or more subroutines or introduces a new execution level.
  * ELSE::                                Execute the remainder of a line if @code{@ref{$TEST}} evaluates @emph{false}.
  * FOR::                                 Repeat execution of a line or block of code.
- Line 2031  Identical to @ref{$TRANSLATE()}, except
+ Line 2089  Identical to @ref{$TRANSLATE()}, except
  * KSUBSCRIPTS::                         Kill only the descendant subscripts of a local, global, global, or structured system variable.
  * KVALUE::                              Kill only the value of a local, global, or structured system variable.
  * LOCK::                                Control advisory locking for concurrency control.
- * MAP::                                 Map a global name to a non-default namespace.
  * MERGE::                               Merge contents of one local, global, or structured system variable into another.
  * NEW::                                 Introduce a new scope for a specified local variable or intrinsic special variable or instantiate an object.
  * OPEN::                                Open a sequential or socket input/output device.
- Line 2040  Identical to @ref{$TRANSLATE()}, except
+ Line 2097  Identical to @ref{$TRANSLATE()}, except
  * SET::                                 Set the value of a local variable, global, intrinsic special variable, or structured system variable.
  * TCOMMIT::                             Commit a transaction.
  * THEN::                                Preserve @code{@ref{$TEST}} until the end of the current line.
- * THROW::                               Programmatically raise an error condition.
  * TROLLBACK::                           Roll back all pending transactions.
  * TSTART::                              Introduce a new transaction processing level.
- * UNMAP::                               Remove a mapping of a global to a non-default namespace.
  * USE::                                 Set the currently-active input/output device.
  * VIEW::                                Modify FreeM internal parameters.
- * WATCH::                               Enable or disable watchpoints, or set or clear watchpoints on specified globals, locals, or structured system variables.
- * WITH::                                Set prefix for future variable references.
  * WRITE::                               Write output to current input/output device.
  * XECUTE::                              Interpret string as M code.
- * ZBREAK::                              Unknown.
+ * ZASSERT::                             Raise error when a conditional expression evaluates @emph{false}.
- * ZGO::                                 Unknown.
+ * ZBREAK::                              Enable/disable ZBREAK mode.
- * ZHALT::                               Unknown.
+ * 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.
+ * ZHALT::                               Exit FreeM job with return value.
  * ZINSERT::                             Insert code into routine buffer.
- * ZJOB::                                Unknown.
+ * ZJOB::                                Invoke job, ignoring any timeouts.
  * ZLOAD::                               Load routine into routine buffer.
+ * ZMAP::                                Map a global name to a non-default namespace.
  * ZNEW::                                Unknown.
  * ZPRINT::                              Print contents of routine buffer.
- * ZQUIT::                               Unknown.
+ * ZQUIT::                               Quit multiple stack levels at once.
  * ZREMOVE::                             Remove code from routine buffer.
  * ZSAVE::                               Save routine buffer to disk.
- * ZTRAP::                               Unknown.
+ * ZTHROW::                              Programmatically raise an error condition.
+ * ZTRAP::                               Raise a FreeM error.
+ * 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.
+ * ZWITH::                               Set prefix for future variable references.
  * ZWRITE::                              Write local variable, global, or structured system variable to @code{@ref{$IO}}.
  @end menu
- Line 2183  In its inclusive form, @code{ABLOCK} inc
+ Line 2244  In its inclusive form, @code{ABLOCK} inc
  In its exclusive form, @code{ABLOCK} increments the block counters for all event classes @emph{except for} those named in the list, provided the optional @emph{postcondition} is either @emph{true} or omitted.
- @node ASSERT
- @section ASSERT
- @cindex ASSERT
- @cindex commands, ASSERT
- @cindex commands, debugging
- @cindex commands, implementation-specific
- @cindex commands, non-standard
- @emph{FreeM Extension}
- Triggers error @code{ASSERT} if the supplied truth-valued expression @emph{tvexpr} is @emph{false} (@emph{1} is @emph{true}, and @emph{0} is @emph{false}), and that the optional @emph{postcondition} evaluates to @emph{true} or is omitted.
- The @code{ASSERT} error is catchable whether using standard-style, FreeM-style, or DSM 2.0-style error processing.
- @emph{Syntax}
- @example
-  ASSERT@emph{:postcondition} @emph{<tvexpr>}
- @end example
- @emph{Example}
- @example
- DEFAULT.USER> SET DEBUG=1
- DEFAULT.USER> ASSERT:DEBUG 1=1
- DEFAULT.USER> ASSERT:DEBUG 1=0
- >> Error ZASSERT:  programmer assertion failed in SYSTEM::^%SYSINIT  [$STACK = 0]
- >> ASSERT:DEBUG 1=0
-                    ^
- @end example
  @node ASTART
  @section ASTART
- Line 2359  In its argumentless form, @code{CLOSE} c
+ Line 2385  In its argumentless form, @code{CLOSE} c
  In its single-argument form, @code{CLOSE} closes the I/O device associated with channel @emph{channel}, provided that @emph{channel} represents a currently-open device, and the optional @emph{postcondition} is @emph{true} or omitted.
- @node CONST
- @section CONST
- @cindex CONST
- @cindex commands, CONST
- @cindex commands, non-standard
- @emph{FreeM Extension}
- Defines a local @emph{constant}, or variable that cannot be altered after its initial definition, provided the optional @emph{postcondition} is @emph{true} or omitted.
- Constants must only be locals, and globals are not supported.
- @emph{Syntax}
- @example
- @code{CONST@emph{:postcondition} @emph{mref1}=@emph{initial-value1},...,@emph{mrefN}=@emph{initial-valueN}}
- @end example
  @node DO
  @section DO
  @cindex DO
- Line 2651  In the above @emph{inclusive} form, @cod
+ Line 2660  In the above @emph{inclusive} form, @cod
  @cartouche
  @quotation
  @emph{Note}
- The below @emph{argumentless} and @emph{exclusive} forms of @code{KSUBSCRIPTS} are not implemented in FreeM, as of version 0.64.0-rc1, 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.65.1-rc1, but are planned for a future release.
  @end quotation
  @end cartouche
- Line 2686  In the above @emph{inclusive} form, @cod
+ Line 2695  In the above @emph{inclusive} form, @cod
  @cartouche
  @quotation
  @emph{Note}
- The below @emph{argumentless} and @emph{exclusive} forms of @code{KVALUE} are not implemented in FreeM, as of version 0.64.0-rc1, but are planned for a future release.
+ The below @emph{argumentless} and @emph{exclusive} forms of @code{KVALUE} are not implemented in FreeM, as of version 0.65.1-rc1, but are planned for a future release.
  @end quotation
  @end cartouche
- Line 2742  If @code{LOCK} succeeds within @emph{tim
+ Line 2751  If @code{LOCK} succeeds within @emph{tim
  LOCK[@emph{:postcondition}] @emph{name}[:@emph{timeout}][,...@emph{name}[:@emph{timeout}]]
  @end example
- @node MAP
- @section MAP
- @cindex MAP
- @cindex commands, MAP
- @cindex commands, implementation-specific
- @cindex commands, non-standard
- Maps global name @code{gvn} to be mapped to the non-default namespace @emph{expr V namespace}, provided the optional @emph{postcondition} evaluates to @emph{true} or is omitted.
- @emph{Syntax}
- @example
- MAP[@emph{:postcondition}] GLOBAL @emph{gvn}=@emph{expr V namespace}
- @end example
  @node MERGE
  @section MERGE
  @cindex MERGE
- Line 3006  Saves the value of @code{$TEST} until th
+ Line 3000  Saves the value of @code{$TEST} until th
  IF 1 THEN  WRITE "HELLO!",!
  @end example
- @node THROW
- @section THROW
- @cindex THROW
- @cindex commands, THROW
- @cindex commands, non-standard
- @emph{FreeM Extension}
- Raises an error condition as long as the optional @emph{postcondition} is @emph{true} or omitted.
- @emph{Syntax}
- @example
- @code{THROW@emph{:postcondition} @emph{expr V error-code}}
- @end example
- @emph{Example}
- @example
- @code{THROW "M102"}
- @end example
  @node TROLLBACK
  @section TROLLBACK
  @cindex TROLLBACK
- Line 3091  If you are using more than one transacti
+ Line 3064  If you are using more than one transacti
  TSTART (FOO,BAR):(SERIAL,TRANSACTIONID="FOO")
  @end example
- @node UNMAP
- @section UNMAP
- @cindex UNMAP
- @cindex commands, UNMAP
- @cindex commands, implementation-specific
- @cindex commands, non-standard
- Removes any mapping connecting @emph{gvn} to a non-default namespace, provided the optional @emph{postcondition} evaluates to @emph{true} or is omitted.
- @emph{Syntax}
- @example
- UNMAP GLOBAL @emph{gvn}
- @end example
  @node USE
  @section USE
- Line 3409  VIEW 133:@emph{tvexpr}
+ Line 3368  VIEW 133:@emph{tvexpr}
  @end table
- @node WATCH
- @section WATCH
- @cindex WATCH
+ @node WRITE
- @cindex commands, WATCH
+ @section WRITE
+ @cindex WRITE
+ @cindex commands, WRITE
+ @node XECUTE
+ @section XECUTE
+ @cindex XECUTE
+ @cindex commands, XECUTE
+ @node ZASSERT
+ @section ZASSERT
+ @cindex ZASSERT
+ @cindex commands, ZASSERT
  @cindex commands, debugging
  @cindex commands, implementation-specific
  @cindex commands, non-standard
  @emph{FreeM Extension}
- Sets a watchpoint on a global, local, or SSVN node.
+ Triggers error @code{ZASSERT} if the supplied truth-valued expression @emph{tvexpr} is @emph{false} (@emph{1} is @emph{true}, and @emph{0} is @emph{false}), and that the optional @emph{postcondition} evaluates to @emph{true} or is omitted.
- @emph{Syntax}
+ The @code{ZASSERT} error is catchable whether using standard-style, FreeM-style, or DSM 2.0-style error processing.
+ @emph{Syntax}
- In its @emph{argumentless} form, @code{WATCH} toggles watchpoints on and off, provided the optional @emph{postcondition} is @emph{true} or omitted.
  @example
- WATCH[@emph{:postcondition}]
+  ZASSERT@emph{:postcondition} @emph{<tvexpr>}
  @end example
- In its @emph{inclusive} form, @code{WATCH} adds, removes, or examines watchpoints, provided the optional @emph{postcondition} is @emph{true} or omitted.
+ @emph{Example}
- A @code{+} adds a new watchpoint to the following variable.
+ @example
+ DEFAULT.USER> SET DEBUG=1
- A @code{-} removes an existing watchpoint for the following variable.
- A @code{?} examines the status of a watchpoint for the following variable.
+ DEFAULT.USER> ZASSERT:DEBUG 1=1
- @example
- WATCH[@emph{:postcondition}] [+|-|?]@emph{var1}...,[+|-|?]@emph{varN}
+ DEFAULT.USER> ZASSERT:DEBUG 1=0
+ >> Error ZASSERT:  programmer assertion failed in SYSTEM::^%SYSINIT  [$STACK = 0]
+ >> ZASSERT:DEBUG 1=0
+                    ^
  @end example
+ @node ZBREAK
+ @section ZBREAK
+ @cindex ZBREAK
+ @cindex commands, ZBREAK
+ @cindex commands, debugging
+ @cindex commands, implementation-specific
+ @cindex commands, non-standard
+ @emph{FreeM Extension}
- The following example demonstrates turning watchpoint processing on and adding a watchpoint for global variable @code{^snw(1)}. It then changes the value of @code{^snw(1)}.
+ 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}.
- @example
+ @emph{Syntax}
- DEFAULT.USER> WATCH
- Watchpoints enabled.
- DEFAULT.USER> WATCH +^SNW(1)
- Added '^SNW("1")' to the watchlist.
- DEFAULT.USER> SET ^SNW(1)="new value"
- >> WATCHPOINT:  ^SNW("1") => 'new value' (changed 1 times)
+ @example
+ ZBREAK @emph{tvexpr}
  @end example
- The following example will remove that watchpoint:
+ @node ZCONST
+ @section ZCONST
+ @cindex ZCONST
+ @cindex commands, ZCONST
+ @cindex commands, non-standard
+ @emph{FreeM Extension}
+ Defines a local @emph{constant}, or variable that cannot be altered after its initial definition, provided the optional @emph{postcondition} is @emph{true} or omitted.
+ Constants must only be locals, and globals are not supported.
+ @emph{Syntax}
  @example
- DEFAULT.USER> WATCH -^SNW(1)
+ @code{ZCONST@emph{:postcondition} @emph{mref1}=@emph{initial-value1},...,@emph{mrefN}=@emph{initial-valueN}}
- Removed '^SNW("1")' from the watchlist.
- DEFAULT.USER> WATCH ?^SNW(1)
- '^SNW("1")' is not being watched.
  @end example
- @node WITH
+ @node ZEDIT
- @section WITH
+ @section ZEDIT
- @cindex WITH
+ @cindex ZEDIT
- @cindex commands, WITH
+ @cindex commands, ZEDIT
  @cindex commands, non-standard
  @emph{FreeM Extension}
- NOTE: This command may be deprecated and removed in future FreeM releases.
+ Edits a routine using an external editor. Uses environment variable @code{$EDITOR} if defined; otherwise, uses @code{vi}.
- Sets a prefix to be applied to all subsequent local variable or constant references.
  @emph{Syntax}
  @example
- @code{WITH@emph{:postcondition} @emph{var-prefix}}
+ ZEDIT@emph{[:postcondition]}
  @end example
- In the above single-argument form, sets the @code{$WITH} prefix to @emph{var-prefix}, provided that the optional @emph{postcondition} is either @emph{true} or omitted.
+ In its argumentless form, edits the currently-active routine, provided the optional @emph{postcondition} is @emph{true} or omitted.
- The @emph{var-prefix} argument may be a string literal or any valid FreeM expression.
+ @emph{Syntax}
  @example
- @code{WITH@emph{:postcondition}}
+ ZEDIT@emph{[:postcondition]} @emph{<routine-name>}
  @end example
- In the above argumentless form, clears the @code{$WITH} prefix, provided the optional @emph{postcondition} is either @emph{true} or omitted. Equivalent to @code{WITH ""}.
+ In its single-argument form, edits @emph{<routine-name>}, provided the optional @emph{postcondition} is @emph{true} or omitted.
+ If the specified routine does not exist, it will be created.
- @node WRITE
+ Routine names must not be quoted, and must not included a leading caret (@code{^}).
- @section WRITE
- @cindex WRITE
- @cindex commands, WRITE
- @node XECUTE
+ @emph{Errors}
- @section XECUTE
- @cindex XECUTE
- @cindex commands, XECUTE
- @node ZBREAK
+ @code{ZEDIT} will raise @code{ZNOPGM} in its argumentless form if there is no routine currently loaded.
- @section ZBREAK
- @cindex ZBREAK
- @cindex commands, ZBREAK
- @cindex commands, debugging
- @cindex commands, implementation-specific
- @cindex commands, non-standard
- @emph{FreeM Extension}
- @node ZGO
+ @node ZGOTO
- @section ZGO
+ @section ZGOTO
- @cindex ZGO
+ @cindex ZGOTO
- @cindex commands, ZGO
+ @cindex commands, ZGOTO
  @cindex commands, implementation-specific
  @cindex commands, non-standard
  @emph{FreeM Extension}
+ In its single-argument form, enables @code{BREAK} mode and branches unconditionally to @emph{entryref}.
+ @emph{Syntax}
+ @example
+ ZGOTO @emph{entryref}
+ @end example
+ In its argumentless form, resumes execution after a @code{BREAK}.
+ @emph{Syntax}
+ @example
+ ZGOTO
+ @end example
  @node ZHALT
  @section ZHALT
  @cindex ZHALT
- Line 3534  In the above argumentless form, clears t
+ Line 3515  In the above argumentless form, clears t
  @cindex commands, non-standard
  @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
  @section ZINSERT
  @cindex ZINSERT
- Line 3542  In the above argumentless form, clears t
+ Line 3539  In the above argumentless form, clears t
  @cindex commands, non-standard
  @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
  @section ZJOB
  @cindex ZJOB
- Line 3570  Loads routine @emph{<routine-name>} into
+ Line 3577  Loads routine @emph{<routine-name>} into
  ZLOAD@emph{:postcondition} @emph{<routine-name>}
  @end example
+ @node ZMAP
+ @section ZMAP
+ @cindex ZMAP
+ @cindex commands, ZMAP
+ @cindex commands, implementation-specific
+ @cindex commands, non-standard
+ Maps global name @code{gvn} to be mapped to the non-default namespace @emph{expr V namespace}, provided the optional @emph{postcondition} evaluates to @emph{true} or is omitted.
+ @emph{Syntax}
+ @example
+ ZMAP[@emph{:postcondition}] GLOBAL @emph{gvn}=@emph{expr V namespace}
+ @end example
  @node ZNEW
  @section ZNEW
  @cindex ZNEW
- Line 3586  ZLOAD@emph{:postcondition} @emph{<routin
+ Line 3609  ZLOAD@emph{:postcondition} @emph{<routin
  @cindex commands, non-standard
  @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}
- Line 3594  Prints the contents of the current routi
+ Line 3617  Prints the contents of the current routi
  ZPRINT@emph{:postcondition}
  @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
  @section ZQUIT
  @cindex ZQUIT
- Line 3620  In its argumentless form, quits from @co
+ Line 3653  In its argumentless form, quits from @co
  @cindex commands, non-standard
  @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
  @section ZSAVE
  @cindex ZSAVE
- Line 3628  In its argumentless form, quits from @co
+ Line 3679  In its argumentless form, quits from @co
  @cindex commands, non-standard
  @emph{FreeM Extension}
+ @node ZTHROW
+ @section ZTHROW
+ @cindex ZTHROW
+ @cindex commands, ZTHROW
+ @cindex commands, non-standard
+ @emph{FreeM Extension}
+ Raises an error condition as long as the optional @emph{postcondition} is @emph{true} or omitted.
+ @emph{Syntax}
+ @example
+ @code{ZTHROW@emph{:postcondition} @emph{expr V error-code}}
+ @end example
+ @emph{Example}
+ @example
+ @code{ZTHROW "M102"}
+ @end example
  @node ZTRAP
  @section ZTRAP
  @cindex ZTRAP
- Line 3637  In its argumentless form, quits from @co
+ Line 3710  In its argumentless form, quits from @co
  @cindex commands, non-standard
  @emph{FreeM Extension}
+ Synonymous with @ref{ZTHROW}.
+ @node ZUNMAP
+ @section ZUNMAP
+ @cindex ZUNMAP
+ @cindex commands, ZUNMAP
+ @cindex commands, implementation-specific
+ @cindex commands, non-standard
+ Removes any mapping connecting @emph{gvn} to a non-default namespace, provided the optional @emph{postcondition} evaluates to @emph{true} or is omitted.
+ @emph{Syntax}
+ @example
+ ZUNMAP GLOBAL @emph{gvn}
+ @end example
+ @node ZWATCH
+ @section ZWATCH
+ @cindex ZWATCH
+ @cindex commands, ZWATCH
+ @cindex commands, debugging
+ @cindex commands, implementation-specific
+ @cindex commands, non-standard
+ @emph{FreeM Extension}
+ Sets a watchpoint on a global, local, or SSVN node.
+ @emph{Syntax}
+ In its @emph{argumentless} form, @code{ZWATCH} toggles watchpoints on and off, provided the optional @emph{postcondition} is @emph{true} or omitted.
+ @example
+ ZWATCH[@emph{:postcondition}]
+ @end example
+ In its @emph{inclusive} form, @code{ZWATCH} adds, removes, or examines watchpoints, provided the optional @emph{postcondition} is @emph{true} or omitted.
+ A @code{+} adds a new watchpoint to the following variable.
+ A @code{-} removes an existing watchpoint for the following variable.
+ A @code{?} examines the status of a watchpoint for the following variable.
+ @example
+ ZWATCH[@emph{:postcondition}] [+|-|?]@emph{var1}...,[+|-|?]@emph{varN}
+ @end example
+ The following example demonstrates turning watchpoint processing on and adding a watchpoint for global variable @code{^snw(1)}. It then changes the value of @code{^snw(1)}.
+ @example
+ DEFAULT.USER> ZWATCH
+ Watchpoints enabled.
+ DEFAULT.USER> ZWATCH +^SNW(1)
+ Added '^SNW("1")' to the watchlist.
+ DEFAULT.USER> SET ^SNW(1)="new value"
+ >> WATCHPOINT:  ^SNW("1") => 'new value' (changed 1 times)
+ @end example
+ The following example will remove that watchpoint:
+ @example
+ DEFAULT.USER> ZWATCH -^SNW(1)
+ Removed '^SNW("1")' from the watchlist.
+ DEFAULT.USER> ZWATCH ?^SNW(1)
+ '^SNW("1")' is not being watched.
+ @end example
+ @node ZWITH
+ @section ZWITH
+ @cindex ZWITH
+ @cindex commands, ZWITH
+ @cindex commands, non-standard
+ @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.
+ @emph{Syntax}
+ @example
+ @code{ZWITH@emph{:postcondition} @emph{var-prefix}}
+ @end example
+ In the above single-argument form, sets the @code{$WITH} prefix to @emph{var-prefix}, provided that the optional @emph{postcondition} is either @emph{true} or omitted.
+ The @emph{var-prefix} argument may be a string literal or any valid FreeM expression.
+ @example
+ @code{ZWITH@emph{:postcondition}}
+ @end example
+ In the above argumentless form, clears the @code{$WITH} prefix, provided the optional @emph{postcondition} is either @emph{true} or omitted. Equivalent to @code{ZWITH ""}.
  @node ZWRITE
  @section ZWRITE
  @cindex ZWRITE
- Line 3919  The following subscripts are supported:
+ Line 4105  The following subscripts are supported:
  @table @asis
+ @item @code{$IO} +R -U -D
+ Returns the current value of @code{$IO} for the job.
+ @item @code{$PDISPLAY} +R -U -D
+ Returns the value of @code{$PDISPLAY} for the job.
+ @item @code{$PRINCIPAL} +R -U -D
+ Returns the value of @code{$PRINCIPAL} for the job.
+ @item @code{$TLEVEL} +R -U -D
+ Returns the current transaction level (value of @code{$TLEVEL} for the job.
+ @item @code{BREAK_HANDLER} +R +U -D
+ Contains M code to be executed when the @code{BREAK} command is run.
+ @item @code{CHARACTER} +R -U -D
+ Returns the character set of the job.
+ @item @code{CWD} +R +U -D
+ Returns or sets the current working directory of the job.
+ @item @code{EVENT} +R +U +D
+ The subtree contained under @code{^$JOB($J,"EVENT")} defines asynchronous event handlers for the current job. Please see @emph{Asynchronous Event Handling} for more information.
+ @item @code{GLOBAL} +R -U -D
+ Returns the global environment of the job.
+ @item @code{GROUP} +R -U -D
+ Returns the GID of the group owning the job.
  @item @code{GVNDEFAULT} +R +U +D
  Contains a default expression to be evaluated if a global variable access attempt results in an @code{M7} error.
  Equivalent to wrapping all global accesses in @code{$GET(@emph{global-name},@emph{string-expr})}.
+ @item @code{GVNQOVAL} +R +U +D
+ Contains the data value (if any) at the subscripted global variable reference from the most recent @code{$ORDER} or @code{$QUERY} operation.
+ This node is useful for code that uses @code{$ORDER} or @code{$QUERY} heavily in loops that retrieve successive data values, as it will prevent an additional data file scan that would result from retrieving the data value in the usual way, thus improving application performance. However, this optimization comes at the cost of compatibility with other M implementations.
+ @item @code{GVN_CASE_SENSITIVE} +R +U -D
+ Returns or sets the case sensitivity of global names. If set to @code{0}, global names are case-insensitive. If set to @code{1}, global names are case-sensitive.
+ @item @code{GVN_NAME_SUB_LENGTH} +R +U -D
+ Returns or sets the maximum number of characters of a global name plus all of its subscripts, from 1-255.
+ @item @code{GVN_SUB_LENGTH} +R +U -D
+ Returns or sets the maximum number of characters of a single global subscript, from 1-255.
+ @item @code{GVN_UNIQUE_CHARS} +R +U -D
+ Returns or sets the number of characters of a global name that make it unique, from 1 to 255.
+ @item @code{IOPATH} +R +U -D
+ Returns or sets the @emph{I/O path} to be used by the @code{OPEN} command.
  @item @code{LVNDEFAULT} +R +U +D
  Contains a default expression to be evaluated if a local variable access attempt results in an @code{M6} error.
- Line 3934  Contains the data value (if any) at the
+ Line 4170  Contains the data value (if any) at the
  This node is useful for code that uses @code{$ORDER} or @code{$QUERY} heavily in loops that retrieve successive data values, as it will prevent an additional symbol table scan that would result from retrieving the data value in the usual way, thus improving application performance. However, this optimization comes at the cost of compatibility with other M implementations.
- @item @code{GVNQOVAL} +R +U +D
+ @item @code{MATH} +R +U -D
- Contains the data value (if any) at the subscripted global variable reference from the most recent @code{$ORDER} or @code{$QUERY} operation.
+ Returns or sets the mode in which decimal comparisons and arithmetic calculations are conducted. Valid values are @code{FIXED}, for fixed-point decimals having up to 20,000 digits of precision, as determined by the @code{$ZPRECISION} intrinsic special variable, and @code{IEEE754}, to use IEEE 754 floating-point decimals. When in @code{IEEE754} mode, floating-point numbers support up to 16 digits of numeric precision.
- This node is useful for code that uses @code{$ORDER} or @code{$QUERY} heavily in loops that retrieve successive data values, as it will prevent an additional data file scan that would result from retrieving the data value in the usual way, thus improving application performance. However, this optimization comes at the cost of compatibility with other M implementations.
+ @code{IEEE754} mode will make mathematical calculations significantly faster, especially when accelerated by a floating-point processor, at the expense of precision and accuracy.
- @item @code{ZCOMMANDS} +R +U -D
+ @code{FIXED} mode is recommended for financial calculations, or where precision and accuracy are valued over performance. @code{FIXED} is the default mode of FreeM operation.
- Contains a space-delimited list of @code{Z}-commands to be treated as intrinsic. Any @code{Z}-command not appearing in this list will be treated as a user-defined command.
- For instance, if command @code{ZFOO} does @emph{not} appear in this list, FreeM will attempt to run @code{^%ZFOO} as a subroutine when the @code{ZFOO} command is encountered in program code.
+ Attempting to @code{SET} this node to values other than @code{FIXED} or @code{IEEE754} will set @code{$ECODE} to @code{M29}.
- If you remove a command from this list, you may provide your own private M implementation of the command in the manner described above.
+ @item @code{NAMESPACE} +R +U -D
+ Returns or sets the name of the job's currently-active namespace.
- If an argument is passed to a @code{Z}-command you implement in M, it is made available to your M code in a variable whose name is specified in @code{^$JOB($JOB,"ZCOMMAND_ARGUMENT_NAME")}, which defaults to @code{%}.
+ @item @code{OPEN} +R -U -D
+ The @code{^$JOB($JOB,"OPEN",<channel>} subscripts list the open I/O channels in the specified job.
  @item @code{PIPE_GLVN} +R +U -D
  Contains an M local or global variable to be used as standard input or standard output for the external shell commands run by @code{!<} and @code{!>}.
- @item @code{ZCOMMAND_ARGUMENT_NAME} +R +U -D
+ @item @code{PRIORITY} +R +U -D
- Returns or sets the variable name in which arguments to user-defined @code{Z}-commands are passed. Defaults to @code{%}.
+ Returns or sets the @emph{nice} value of the FreeM job.
- @item @code{ZFUNCTIONS} +R +U -D
- Contains a space-delimited list of @code{Z} functions to be treated as intrinsic. Any @code{Z} function not appearing in this list will be treated as a user-defined extrinsic function.
- For instance, if function @code{$ZFOO} does @emph{not} appear in this list, FreeM will attempt to return the value of @code{$$^%ZFOO} called as an extrinsic function.
- If you remove a function from this list, you may provide your own private M implementation of the function in the manner described above.
- @item @code{ZSVS} +R +U -D
- Contains a space-delimited list of @code{Z} special variables to be treated as intrinsic. Any @code{Z} special variable  not appearing in this list will be treated as a user-defined extrinsic function taking no arguments.
- For instance, if the special variable @code{$ZFOO} does @emph{not} appear in this list, FreeM will attempt to return the value of @code{$$^%ZFOO} called as an extrinsic function.
+ @item @code{REVSTR} +R +U -D
+ When set to 1, allows @code{$EXTRACT} to accept negative values.
- If you remove a built-in special variable from this list, you may provide your own private M implementation of the special variable in the manner described above.
+ @item @code{ROUTINE} +R -U -D
+ Returns the name of the routine currently being executed by the job.
- @item @code{BREAK_HANDLER} +R +U -D
+ @item @code{ROUTINE_BUFFER_AUTO_ADJUST} +R +U -D
- Contains M code to be executed when the @code{BREAK} command is run.
+ Determines whether or not the size of routine buffers will be automatically adjusted at runtime. If set to @code{0}, routine buffers will be fixed to the byte size specified in @code{ROUTINE_BUFFER_SIZE} and may be manually resized using @code{ROUTINE_BUFFER_SIZE}. If set to @code{1}, routine buffers will grow automatically as necessary.
+ @item @code{ROUTINE_BUFFER_COUNT} +R +U -D
+ Returns or sets the number of routine buffers that FreeM will store in memory concurrently. Raising this value will increase memory usage, but will also increase performance if your applications call many different routines repeatedly.
  @item @code{ROUTINE_BUFFER_SIZE} +R +U -D
  Returns or sets the number of bytes allocated to each routine buffer. If @code{ROUTINE_BUFFER_AUTO_ADJUST} is set to @code{0}, this determines the maximum size of routines that FreeM will execute.
- @item @code{ROUTINE_BUFFER_COUNT} +R +U -D
+ @item @code{SINGLE_USER} +R +U -D
- Returns or sets the number of routine buffers that FreeM will store in memory concurrently. Raising this value will increase memory usage, but will also increase performance if your applications call many different routines repeatedly.
+ 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.
- @item @code{ROUTINE_BUFFER_AUTO_ADJUST} +R +U -D
- Determines whether or not the size of routine buffers will be automatically adjusted at runtime. If set to @code{0}, routine buffers will be fixed to the byte size specified in @code{ROUTINE_BUFFER_SIZE} and may be manually resized using @code{ROUTINE_BUFFER_SIZE}. If set to @code{1}, routine buffers will grow automatically as necessary.
- @item @code{SYMBOL_TABLE_SIZE} +R +U -D
+ 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.
- Returns or sets the number of bytes allocated to each of the two FreeM symbol tables. If @code{SYMBOL_TABLE_AUTO_ADJUST} is @code{1}, this value is treated as a default, initial size. If @code{SYMBOL_TABLE_AUTO_ADJUST} is @code{0}, this value controls the fixed size of the two symbol tables.
  @item @code{SYMBOL_TABLE_AUTO_ADJUST} +R +U -D
  Determines whether or not the size of the two FreeM symbol tables will be automatically adjusted at runtime. If set to @code{0}, the symbol table will be fixed to the byte size specified in @code{SYMBOL_TABLE_SIZE} and may be manually resized by modifying @code{SYMBOL_TABLE_SIZE}. If set to @code{1}, the two symbol tables will grow automatically as necessary.
+ @item @code{SYMBOL_TABLE_SIZE} +R +U -D
+ Returns or sets the number of bytes allocated to each of the two FreeM symbol tables. If @code{SYMBOL_TABLE_AUTO_ADJUST} is @code{1}, this value is treated as a default, initial size. If @code{SYMBOL_TABLE_AUTO_ADJUST} is @code{0}, this value controls the fixed size of the two symbol tables.
- @item @code{USER_DEFINED_ISV_TABLE_SIZE} +R +U -D
+ @item @code{USER} +R -U -D
- Returns or sets the number of bytes allocated to the FreeM user-defined intrinsic special variable table. If @code{USER_DEFINED_ISV_TABLE_AUTO_ADJUST} is @code{1}, this value is treated as a default, initial size. If @code{USER_DEFINED_ISV_TABLE_AUTO_ADJUST} is @code{0}, this value controls the fixed byte size of the user-defined intrinsic special variable table.
+ Returns the UID of the user owning the job.
  @item @code{USER_DEFINED_ISV_TABLE_AUTO_ADJUST} +R +U -D
  Determines whether or not the size of the FreeM user-defined intrinsic special variable table will be automatically adjusted at runtime. If set to @code{0}, the user-defined ISV table will be fixed to the byte size specified in @code{USER_DEFINED_ISV_TABLE_SIZE} and may be manually resized by modifying @code{USER_DEFINED_ISV_TABLE_SIZE}. If set to @code{1}, the user-defined ISV table will grow automatically as necessary.
- @item @code{GVN_UNIQUE_CHARS} +R +U -D
+ @item @code{USER_DEFINED_ISV_TABLE_SIZE} +R +U -D
- Returns or sets the number of characters of a global name that make it unique, from 1 to 255.
+ Returns or sets the number of bytes allocated to the FreeM user-defined intrinsic special variable table. If @code{USER_DEFINED_ISV_TABLE_AUTO_ADJUST} is @code{1}, this value is treated as a default, initial size. If @code{USER_DEFINED_ISV_TABLE_AUTO_ADJUST} is @code{0}, this value controls the fixed byte size of the user-defined intrinsic special variable table.
- @item @code{GVN_CASE_SENSITIVE} +R +U -D
- Returns or sets the case sensitivity of global names. If set to @code{0}, global names are case-insensitive. If set to @code{1}, global names are case-sensitive.
- @item @code{GVN_NAME_SUB_LENGTH} +R +U -D
- Returns or sets the maximum number of characters of a global name plus all of its subscripts, from 1-255.
- @item @code{GVN_SUB_LENGTH} +R +U -D
- Returns or sets the maximum number of characters of a single global subscript, from 1-255.
- @item @code{SINGLE_USER} +R +U -D
- 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 corruption.
- @item @code{CHARACTER} +R -U -D
+ @item @code{USER_ERRORS} +R +U +D
- Returns the character set of the job.
- @item @code{CWD} +R +U -D
+ Custom error messages for @code{ZUSERERR} may be set in @code{^$JOB($JOB,"USER_ERRORS",<user_error_code>)}, where @code{<user_error_code>} represents the custom error code.
- Returns or sets the current working directory of the job.
- @item @code{OPEN} +R -U -D
+ For example:
- The @code{^$JOB($JOB,"OPEN",<channel>} subscripts list the open I/O channels in the specified job.
- @item @code{BERKELEYDB,FLUSH_THRESHOLD} +R +U -D
+ @example
- Returns or sets the number of write operations that will be cached in the BerkeleyDB global handler prior to flushing BerkeleyDB's cache to disk.
+ DEFAULT.USER> S ^$JOB($JOB,"USER_ERRORS","UBLACKHOLE")="black hole encountered"
- @item @code{EVENT} +R +U +D
- The subtree contained under @code{^$JOB($J,"EVENT")} defines asynchronous event handlers for the current job. Please see @emph{Asynchronous Event Handling} for more information.
- @item @code{GLOBAL} +R -U -D
+ DEFAULT.USER> ZTHROW UBLACKHOLE
- Returns the global environment of the job.
- @item @code{IOPATH} +R +U -D
- Returns or sets the @emph{I/O path} to be used by the @code{OPEN} command.
- @item @code{PRIORITY} +R +U -D
+ >> Error UBLACKHOLE:  black hole encountered in SYSTEM::^%SYSINIT  [$STACK = 0]
- Returns or sets the @emph{nice} value of the FreeM job.
+ >> ZTHROW UBLACKHOLE
+                   ^
+ @end example
- @item @code{REVSTR} +R +U -D
+ Note that the error code must begin with @code{U}.
- When set to 1, allows @code{$EXTRACT} to accept negative values.
- @item @code{ROUTINE} +R -U -D
+ @item @code{ZCOMMANDS} +R +U -D
- Returns the name of the routine currently being executed by the job.
+ Contains a space-delimited list of @code{Z}-commands to be treated as intrinsic. Any @code{Z}-command not appearing in this list will be treated as a user-defined command.
- @item @code{SYMTAB} +R +U -D
+ For instance, if command @code{ZFOO} does @emph{not} appear in this list, FreeM will attempt to run @code{^%ZFOO} as a subroutine when the @code{ZFOO} command is encountered in program code.
- Returns or sets the current local variable symbol table in use.
- FreeM supports two unique and independent symbol tables, allowing FreeM programs to maintain two independent sets of identically- or differently-named local variables per process.
+ If you remove a command from this list, you may provide your own private M implementation of the command in the manner described above.
- The default symbol table is @code{0}, and the alternate symbol table is @code{1}, corresponding to the valid values for @code{^$JOB($JOB,"SYMTAB")}.
+ If an argument is passed to a @code{Z}-command you implement in M, it is made available to your M code in a variable whose name is specified in @code{^$JOB($JOB,"ZCOMMAND_ARGUMENT_NAME")}, which defaults to @code{%}.
- Setting this subscript to values other than @code{0} or @code{1} will result in a @code{ZINVEXPR} error.
+ @item @code{ZCOMMAND_ARGUMENT_NAME} +R +U -D
+ Returns or sets the variable name in which arguments to user-defined @code{Z}-commands are passed. Defaults to @code{%}.
- @item @code{$PDISPLAY} +R -U -D
+ @item @code{ZFUNCTIONS} +R +U -D
- Returns the value of @code{$PDISPLAY} for the job.
+ Contains a space-delimited list of @code{Z} functions to be treated as intrinsic. Any @code{Z} function not appearing in this list will be treated as a user-defined extrinsic function.
- @item @code{$PRINCIPAL} +R -U -D
+ For instance, if function @code{$ZFOO} does @emph{not} appear in this list, FreeM will attempt to return the value of @code{$$^%ZFOO} called as an extrinsic function.
- Returns the value of @code{$PRINCIPAL} for the job.
- @item @code{$TLEVEL} +R -U -D
+ If you remove a function from this list, you may provide your own private M implementation of the function in the manner described above.
- Returns the current transaction level (value of @code{$TLEVEL} for the job.
- @item @code{$IO} +R -U -D
+ @item @code{ZSVS} +R +U -D
- Returns the current value of @code{$IO} for the job.
+ Contains a space-delimited list of @code{Z} special variables to be treated as intrinsic. Any @code{Z} special variable  not appearing in this list will be treated as a user-defined extrinsic function taking no arguments.
- @item @code{USER} +R -U -D
+ For instance, if the special variable @code{$ZFOO} does @emph{not} appear in this list, FreeM will attempt to return the value of @code{$$^%ZFOO} called as an extrinsic function.
- Returns the UID of the user owning the job.
- @item @code{GROUP} +R -U -D
+ If you remove a built-in special variable from this list, you may provide your own private M implementation of the special variable in the manner described above.
- Returns the GID of the group owning the job.
- @item @code{NAMESPACE} +R +U -D
- Returns or sets the name of the job's currently-active namespace.
- @item @code{MATH} +R +U -D
- Returns or sets the mode in which decimal comparisons and arithmetic calculations are conducted. Valid values are @code{FIXED}, for fixed-point decimals having up to 20,000 digits of precision, as determined by the @code{$ZPRECISION} intrinsic special variable, and @code{IEEE754}, to use IEEE 754 floating-point decimals. When in @code{IEEE754} mode, floating-point numbers support up to 16 digits of numeric precision.
- @code{IEEE754} mode will make mathematical calculations significantly faster, especially when accelerated by a floating-point processor, at the expense of precision and accuracy.
- @code{FIXED} mode is recommended for financial calculations, or where precision and accuracy are valued over performance. @code{FIXED} is the default mode of FreeM operation.
- Attempting to @code{SET} this node to values other than @code{FIXED} or @code{IEEE754} will set @code{$ECODE} to @code{M29}.
  @end table
- Line 4579  SET MYSTRING="This is a ""string literal
+ Line 4776  SET MYSTRING="This is a ""string literal
  @cindex types, custom
  @cindex classes
- See @ref{Classes}.
+ See @ref{Object-Oriented Programming}.
  @node Globals
  @chapter Globals
- Line 4780  The effect of this is that the operation
+ Line 4977  The effect of this is that the operation
  @cindex variables, local
  @cindex local variables
+ @menu
+ * Local Variables Overview::            The basics of locals.
+ * Creating Local Variables::            Creating locals with SET.
+ * Removing Local Variables::            Removing locals with KILL.
+ @end menu
+ @node Local Variables Overview
  @section Local Variables Overview
  FreeM @emph{local variables} have the same data structure as global variables, but are scoped to a single FreeM process, and stored in memory.
- Line 4928  If you use other M implementations, you
+ Line 5132  If you use other M implementations, you
  @cindex programming, object-oriented
  @menu
- * Classes::                         The basis of object-oriented programming.
+ * Classes::                             The organizing concept of object-oriented programming.
- * Inheritance::                     Basing one class upon another.
+ * Inheritance::                         Making one class derive from another.
- * Methods::                         Attaching code to a class.
+ * Methods::                             Attach code to classes.
- * Public and Private Variables::    Managing class member access.
+ * Public and Private Variables::        Determining accessibility.
- * Instantiating Objects::           Creating instances of classes.
+ * Instantiating Objects::               Creating instances of classes.
- * Determining Object Class::        Getting object information at runtime.
  @end menu
  @node Classes
  @section Classes
- @menu
- * Class Overview::                  Class basics.
- * Constructors::                    Managing object creation.
- * Destructors::                     Cleaning up.
- * Runtime Polymorphism::            Selecting methods at runtime.
- @end menu
- @node Class Overview
  @subsection Class Overview
  A @emph{class} is the primary organizing concept of FreeM support for object-oriented programming, and in FreeM, is simply an M routine with a few special properties:
- Line 4964  DESTROY(THIS) ; This is the destructor
+ Line 5158  DESTROY(THIS) ; This is the destructor
  The above example demonstrates general class syntax.
- @node Constructors
  @subsection Constructors
  A @emph{constructor} is an M entry point that is called when a new instance of a class is created.
- Line 4989  A constructor looks like this:
+ Line 5182  A constructor looks like this:
  In the above example, @emph{<superclass>} represents the name of a class from which this class should inherit. In this case, the @code{FRACTION} class inherits from the @code{OBJECT} class. Note that this is not strictly necessary in this case, as all classes in FreeM automatically inherit from @code{OBJECT}.
- @node Destructors
  @subsection Destructors
  A @code{destructor} is called when you @code{KILL} an instance variable. Its tag must be @code{DESTROY}, and it must take one argument (@code{THIS}).
- Line 5016  Inheritance is achieved by specifying th
+ Line 5208  Inheritance is achieved by specifying th
  CLASS(THIS,INIT):SUPERCLASS
  @end example
- @node Runtime Polymorphism
  @subsection Runtime Polymorphism
  You can achieve runtime polymorphism by subclassing, and defining methods in the subclass that match the names of existing methods in the superclass. Following FreeM inheritance rules, the overridden method in the subclass will be called, and the method in the superclass will not.
- Line 5046  DEFAULT.USER> W MYOBJ.MYMETHOD()
+ Line 5237  DEFAULT.USER> W MYOBJ.MYMETHOD()
  VALUE
  @end example
  @node Public and Private Variables
  @section Public and Private Variables
  FreeM supports private fields with the @code{:PRIVATE} specifier in the @code{SET} command, enforcing classical object-oriented data encapsulation. The @code{:PUBLIC} specifier is provided for completeness, and is the default.
- Line 5080  NEW MYSTR=$#^%STRING("myString")
+ Line 5271  NEW MYSTR=$#^%STRING("myString")
  This will create a local variable called MYSTR of type STRING, and initialize it with the value myString.
- @node Determining Object Class
+ @subsection Determining Object Class
- @section Determining Object Class
  To determine the class of any FreeM local variable, you will use the @code{$$TYPE()} method:
- Line 5678  Raised when you attempt to use multiple
+ Line 5868  Raised when you attempt to use multiple
  Raised when attempts are made to set @code{$ECODE} to an invalid error code value. Obsolete and replaced by standard error code @code{M101}.
  @item @code{ZASSERT} - @emph{programmer assertion failed}
- Raised when an @code{ASSERT} expression's result is not true.
+ Raised when an @code{ZASSERT} expression's result is not true.
  @item @code{ZUSERERR} - @emph{user-defined error}
- Raised when program code calls @code{THROW} with an error code argument for which the first character is @code{U}, or when @code{$ECODE} is set to an error code for which the first character is @code{U}.
+ Raised when program code calls @code{ZTHROW} with an error code argument for which the first character is @code{U}, or when @code{$ECODE} is set to an error code for which the first character is @code{U}.
  Custom error messages for @code{ZUSERERR} may be set in @code{^$JOB($JOB,"USER_ERRORS",<user_error_code>)}, where @code{<user_error_code>} represents the custom error code.
- Line 5691  For example:
+ Line 5881  For example:
  DEFAULT.USER> S ^$JOB($JOB,"USER_ERRORS","UBLACKHOLE")="black hole encountered"
- DEFAULT.USER> THROW UBLACKHOLE
+ DEFAULT.USER> ZTHROW UBLACKHOLE
  >> Error UBLACKHOLE:  black hole encountered in SYSTEM::^%SYSINIT  [$STACK = 0]
- >> THROW UBLACKHOLE
+ >> ZTHROW UBLACKHOLE
                    ^
  @end example
- Line 5876  Raised when an attempt is made to use a
+ Line 6066  Raised when an attempt is made to use a
  FreeM allows the following installation methods:
  @table @asis
  @item Binary Repository
- On recent versions the Ubuntu and Debian distributions of GNU/Linux, we provide package repositories from which FreeM may easily be installed. See the @emph{FreeM Wiki} for more information, and @emph{https://packages.coherent-logic.com} for instructions.
+ For recent versions of the Ubuntu and Debian distributions of GNU/Linux, we provide package repositories from which FreeM may easily be installed. See the @emph{FreeM Wiki} for more information, and @emph{https://packages.coherent-logic.com} for instructions.
  If available, this is the simplest method of installing FreeM.
  @item Binary Packages
  We provide binary packages of FreeM for @emph{dpkg} and @emph{rpm}-based distributions of GNU/Linux, and @emph{pkgadd} packages for Solaris 8-10. If you cannot use repositories, this is the easiest option.
  See @emph{https://freem.coherent-logic.com/binaries.cfm} for downloads and instructions.
- @item Source Archive
+ @item Source Tarball
  If you prefer installing from source, we recommend that you download the latest @emph{.tar.gz} file from @emph{https://freem.coherent-logic.com/downloads.cfm}, and follow these steps:
  @example
- Line 5936  $ make
+ Line 6126  $ make
  $ sudo make install
  @end example
+ @item @code{--enable-newglobals} (EXPERIMENTAL)
+ Enables a new and modernized global handler. This global handler has a number of known bugs, and thus should be used with caution.
+ Note that global files created in the default global handler are incompatible with the new global handler, and vice-versa. You will need to back up and remove all globals in your environments when switching global handlers.
+ @emph{Example}
+ @example
+ $ ./configure --enable-newglobals
+ $ make
+ $ sudo make install
+ @end example
  @end table
  @subsection Initial Configuration
- Line 6394  int main(int argc, char **argv, char **e
+ Line 6598  int main(int argc, char **argv, char **e
  @cindex fmadm
  The @code{fmadm} utility is the preferred method of managing a FreeM installation, and will eventually replace all of the existing utilities.
- Unlike the existing, legacy utilities, @code{fmadm} presents a consistent, simple interface for all FreeM management tasks, and is namespace-aware.
+ In support of FreeM operators, @code{fmadm} presents a consistent, simple interface for all FreeM management tasks, and is namespace-aware.
- This appendix will document each @code{fmadm} facility as it is implemented, until all of the legacy utilities have been replaced.
+ This appendix will document each @code{fmadm} facility as it is implemented.
  The @code{fmadm} utility's functions all follow the below, consistent syntax:
- Line 6489  Supported actions are @code{list} and @c
+ Line 6693  Supported actions are @code{list} and @c
  @end table
- @node FreeM Legacy Utilities
- @appendix FreeM Legacy Utilities
- @cindex utilities, legacy
- @section Global Compactor (gcompact)
- @cindex utilities, legacy, gcompact
- Compacts the specified global in place.
- @emph{Syntax}
- @example
- gcompact @emph{/path/to/global/file}
- @end example
- @section Block Examiner (gfix)
- @cindex utilities, gfix
- The @emph{gfix} interactive utility program permits navigation of the B-tree structure of the specified global a block at a time.
- @emph{Syntax}
- @example
- gfix @emph{</path/to/global/file>}
- @end example
- @section Global Repair Tool (grestore)
- @cindex utilities, legacy, grestore
- This utility will fix problems with the specified global.
- @emph{Syntax}
- @example
- grestore @emph{</path/to/global/file>}
- @end example
  @node FreeM VIEW Commands and Functions
  @appendix FreeM VIEW Commands and Functions

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

Removed from v.1.40
changed lines
	Added in v.1.64