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.51 and 1.64

version 1.51, 2025/05/05 14:26:59	version 1.64, 2025/05/20 14:36:06
Line 4	Line 4
@settitle The FreeM Manual	@settitle The FreeM Manual

@copying	@copying
This manual is for FreeM, (version 0.64.0-rc1), which is a free software implementation of the M programming language.	This manual is for FreeM, (version 0.65.1-rc1), which is a free software 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.	Print-optimized versions of this book are typeset in @emph{Computer Modern} by the author using the @emph{GNU Texinfo} tools.

Line 19 Permission is granted to copy, distribut	Line 19 Permission is granted to copy, distribut

@title The FreeM Manual	@title The FreeM Manual
@subtitle @sc{The Official Manual of FreeM}	@subtitle @sc{The Official Manual of FreeM}
@subtitle Version 0.64.0-rc1	@subtitle Version 0.65.1-rc1
@c@vskip 10pt	@c@vskip 10pt
@c@center @image{freem-logo-sm,,,,.png}	@c@center @image{freem-logo-sm,,,,.png}
@author Serena Willis	@author Serena Willis
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 100 This is the official manual for the Free	Line 101 This is the official manual for the Free
* Accessing FreeM from C Programs:: How to use the mlib interface.	* Accessing FreeM from C Programs:: How to use the mlib interface.

* FreeM Administrator:: The fmadm system manager tool.	* 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.	* FreeM VIEW Commands and Functions:: Getting and setting info about FreeM internals.
* Implementation Limits:: FreeM limitations.	* Implementation Limits:: FreeM limitations.
* US-ASCII Character Set:: The US-ASCII character set.	* US-ASCII Character Set:: The US-ASCII character set.
Line 149 Current contributors denoted with a @emp	Line 149 Current contributors denoted with a @emp
@cindex contributors, Gerum, Winfried	@cindex contributors, Gerum, Winfried
@cindex contributors, Kreis, Greg	@cindex contributors, Kreis, Greg
@cindex contributors, Landis, Larry	@cindex contributors, Landis, Larry
	@cindex contributors, McGlothlen, Ken
@cindex contributors, Milligan, Lloyd	@cindex contributors, Milligan, Lloyd
@cindex contributors, Morris, Steve	@cindex contributors, Morris, Steve
@cindex contributors, Murray, John	@cindex contributors, Murray, John
Line 190 Larry Landis (Coordination, Code, Docume	Line 191 Larry Landis (Coordination, Code, Docume
Rick Marshall (Testing, MDC Conformance) @emph{+}	Rick Marshall (Testing, MDC Conformance) @emph{+}

@item	@item
	Ken McGlothlen (Apple Silicon build/test environment, proofreading of documentation) @emph{+}

	@item
Lloyd Milligan (Code, Testing, Documentation)	Lloyd Milligan (Code, Testing, Documentation)

@item	@item
Line 426 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 441 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>}}:	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	@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	Copyright (C) 2014, 2020, 2021 Coherent Logic Development LLC


Line 603 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 630 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 1115 See @emph{https://wiki.osdev.org/Target_	Line 1125 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 1323 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 1723 Purpose unknown.	Line 1755 Purpose unknown.

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 2049 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 2602 In the above @emph{inclusive} form, @cod	Line 2660 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.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 quotation
@end cartouche	@end cartouche

Line 2637 In the above @emph{inclusive} form, @cod	Line 2695 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{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 quotation
@end cartouche	@end cartouche

Line 3392 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.

	If the specified routine does not exist, it will be created.

	Routine names must not be quoted, and must not included a leading caret (@code{^}).

	@emph{Errors}

	@code{ZEDIT} will raise @code{ZNOPGM} in its argumentless form if there is no routine currently loaded.

@node ZGOTO	@node ZGOTO
@section ZGOTO	@section ZGOTO
@cindex ZGOTO	@cindex ZGOTO
Line 3400 Constants must only be locals, and globa	Line 3491 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 3408 In its argumented form, enables @code{BR	Line 3499 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 3448 ZHALT	Line 3539 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 3508 ZMAP[@emph{:postcondition}] GLOBAL @emph	Line 3609 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 3516 Prints the contents of the current routi	Line 3617 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 3542 In its argumentless form, quits from @co	Line 3653 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
Line 3976 The following subscripts are supported:	Line 4105 The following subscripts are supported:

@table @asis	@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	@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.	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})}.	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	@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.	Contains a default expression to be evaluated if a local variable access attempt results in an @code{M6} error.

Line 3991 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.	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	@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{!>}.	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	@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.	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	@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.	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	@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.	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	@end table

Line 5731 Raised when attempts are made to set @co	Line 5871 Raised when attempts are made to set @co
Raised when an @code{ZASSERT} expression's result is not true.	Raised when an @code{ZASSERT} expression's result is not true.

@item @code{ZUSERERR} - @emph{user-defined error}	@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.	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 5741 For example:	Line 5881 For example:
DEFAULT.USER> S ^$JOB($JOB,"USER_ERRORS","UBLACKHOLE")="black hole encountered"	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]	>> Error UBLACKHOLE: black hole encountered in SYSTEM::^%SYSINIT [$STACK = 0]
>> THROW UBLACKHOLE	>> ZTHROW UBLACKHOLE
^	^
@end example	@end example

Line 5926 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:	FreeM allows the following installation methods:
@table @asis	@table @asis
@item Binary Repository	@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.	If available, this is the simplest method of installing FreeM.
@item Binary Packages	@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.	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.	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:	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	@example
Line 5986 $ make	Line 6126 $ make
$ sudo make install	$ sudo make install
@end example	@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	@end table

@subsection Initial Configuration	@subsection Initial Configuration
Line 6444 int main(int argc, char argv, char e	Line 6598 int main(int argc, char argv, char e
@cindex fmadm	@cindex fmadm

The @code{fmadm} utility is the preferred method of managing a FreeM installation, and will eventually replace all of the existing utilities.	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:	The @code{fmadm} utility's functions all follow the below, consistent syntax:

Line 6539 Supported actions are @code{list} and @c	Line 6693 Supported actions are @code{list} and @c
@end table	@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	@node FreeM VIEW Commands and Functions
@appendix FreeM VIEW Commands and Functions	@appendix FreeM VIEW Commands and Functions

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

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