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.44 and 1.63

version 1.44, 2025/05/05 05:16:34	version 1.63, 2025/05/19 17:57:20
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 271 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}.	Indicates a @emph{list} of the following item, e.g., @emph{L gvn} means @emph{list of global variable names}.
@item @emph{lvn}	@item @emph{lvn}
Refers to the name of an M local variable.	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}	@item @emph{strlit}
Refers to an M string literal.	Refers to an M string literal.
@item @emph{ssvn}	@item @emph{ssvn}
Refers to the name of an M structured system variable.	Refers to the name of an M structured system variable.
@item @emph{tvexpr}	@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	@end table

@node A Note on Standards	@node A Note on Standards
Line 424 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 439 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 601 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 628 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 1113 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 1311 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 1711 Returns the Levenshtein distance between	Line 1745 Returns the Levenshtein distance between
@cindex intrinsic functions, $ZM	@cindex intrinsic functions, $ZM
@cindex intrinsic functions, implementation-specific	@cindex intrinsic functions, implementation-specific

	Purpose unknown.

@node $ZNAME()	@node $ZNAME()
@section $ZNAME	@section $ZNAME
@cindex $ZNAME	@cindex $ZNAME
Line 1719 Returns the Levenshtein distance between	Line 1755 Returns the Levenshtein distance between

Purpose unknown.	Purpose unknown.

	This function relies on the value of @code{$VIEW(71)} being @code{0} (this is not the default).

@node $ZNEXT()	@node $ZNEXT()
@section $ZNEXT	@section $ZNEXT
@cindex $ZNEXT	@cindex $ZNEXT
@cindex intrinsic functions, $ZNEXT	@cindex intrinsic functions, $ZNEXT
@cindex intrinsic functions, implementation-specific	@cindex intrinsic functions, implementation-specific

Purpose unknown.	Returns a fully-formed variable reference of the next numeric subscript of the specified glvn.

	@emph{Syntax}

	@example
	$ZNEXT(@emph{glvn})
	@end example

	@emph{Example}

	Assume the following array:

	@example
	^foo(1)=""
	^foo(2)=""
	@end example

	And the following code:

	@example
	W $ZNEXT(^foo(1)) ; => ^foo(2)
	@end example

	This function relies on the value of @code{$VIEW(71)} being @code{1} (this is the default).

@node $ZORDER()	@node $ZORDER()
@section $ZORDER	@section $ZORDER
Line 2011 Identical to @ref{$TRANSLATE()}, except	Line 2072 Identical to @ref{$TRANSLATE()}, except
* !:: Run an external program or command.	* !:: Run an external program or command.
* !!:: Launch a subshell from FreeM direct mode.	* !!:: Launch a subshell from FreeM direct mode.
* ABLOCK:: Increment the block counter for one or more event classes.	* 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.	* ASTART:: Enable asynchronous event handling for one or more event classes.
* ASTOP:: Disable 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.	* AUNBLOCK:: Decrement the block counter for one or more event classes.
Line 2043 Identical to @ref{$TRANSLATE()}, except	Line 2103 Identical to @ref{$TRANSLATE()}, except
* VIEW:: Modify FreeM internal parameters.	* VIEW:: Modify FreeM internal parameters.
* WRITE:: Write output to current input/output device.	* WRITE:: Write output to current input/output device.
* XECUTE:: Interpret string as M code.	* XECUTE:: Interpret string as M code.
* ZBREAK:: Unknown.	* ZASSERT:: Raise error when a conditional expression evaluates @emph{false}.
	* ZBREAK:: Enable/disable ZBREAK mode.
* ZCONST:: Define a constant that cannot be altered after initial definition.	* ZCONST:: Define a constant that cannot be altered after initial definition.
* ZGO:: Unknown.	* ZEDIT:: Edit a routine using an external editor.
* ZHALT:: Unknown.	* ZGOTO:: @code{GOTO} with @code{BREAK} control.
	* ZHALT:: Exit FreeM job with return value.
* ZINSERT:: Insert code into routine buffer.	* ZINSERT:: Insert code into routine buffer.
* ZJOB:: Invokes a job, ignoring any timeouts.	* ZJOB:: Invoke job, ignoring any timeouts.
* ZLOAD:: Load routine into routine buffer.	* ZLOAD:: Load routine into routine buffer.
* ZMAP:: Map a global name to a non-default namespace.	* ZMAP:: Map a global name to a non-default namespace.
* ZNEW:: Unknown.	* ZNEW:: Unknown.
* ZPRINT:: Print contents of routine buffer.	* ZPRINT:: Print contents of routine buffer.
* ZQUIT:: Quits multiple stack levels at once.	* ZQUIT:: Quit multiple stack levels at once.
* ZREMOVE:: Remove code from routine buffer.	* ZREMOVE:: Remove code from routine buffer.
* ZSAVE:: Save routine buffer to disk.	* ZSAVE:: Save routine buffer to disk.
* ZTHROW:: Programmatically raise an error condition.	* ZTHROW:: Programmatically raise an error condition.
* ZTRAP:: Unknown.	* ZTRAP:: Raise a FreeM error.
* ZUNMAP:: Remove a mapping of a global to a non-default namespace.	* ZUNMAP:: Remove a mapping of a global to a non-default namespace.
* ZWATCH:: Enable or disable watchpoints, or set or clear watchpoints on specified globals, locals, or structured system variables.	* ZWATCH:: Enable or disable watchpoints, or set or clear watchpoints on specified globals, locals, or structured system variables.
* ZWITH:: Set prefix for future variable references.	* ZWITH:: Set prefix for future variable references.
Line 2182 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.	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	@node ASTART
@section ASTART	@section ASTART
Line 2633 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 2668 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 3353 VIEW 133:@emph{tvexpr}	Line 3380 VIEW 133:@emph{tvexpr}
@cindex XECUTE	@cindex XECUTE
@cindex commands, 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}

	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.

	The @code{ZASSERT} error is catchable whether using standard-style, FreeM-style, or DSM 2.0-style error processing.

	@emph{Syntax}

	@example
	ZASSERT@emph{:postcondition} @emph{<tvexpr>}
	@end example

	@emph{Example}

	@example
	DEFAULT.USER> SET DEBUG=1


	DEFAULT.USER> ZASSERT:DEBUG 1=1


	DEFAULT.USER> ZASSERT:DEBUG 1=0


	>> Error ZASSERT: programmer assertion failed in SYSTEM::^%SYSINIT [$STACK = 0]
	>> ZASSERT:DEBUG 1=0
	^
	@end example

@node ZBREAK	@node ZBREAK
@section ZBREAK	@section ZBREAK
@cindex ZBREAK	@cindex ZBREAK
Line 3362 VIEW 133:@emph{tvexpr}	Line 3425 VIEW 133:@emph{tvexpr}
@cindex commands, non-standard	@cindex commands, non-standard
@emph{FreeM Extension}	@emph{FreeM Extension}

	Sets or clears the @code{ZBREAK} flag@footnote{NOTE: FreeM team needs to investigate how @code{zbreakon} and @code{zbflag} affect program execution.}, based on the result of evaluating @emph{tvexpr}.

	@emph{Syntax}

	@example
	ZBREAK @emph{tvexpr}
	@end example

@node ZCONST	@node ZCONST
@section ZCONST	@section ZCONST
@cindex ZCONST	@cindex ZCONST
Line 3379 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 ZGO	@node ZEDIT
@section ZGO	@section ZEDIT
@cindex ZGO	@cindex ZEDIT
@cindex commands, ZGO	@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
	@section ZGOTO
	@cindex ZGOTO
	@cindex commands, ZGOTO
@cindex commands, implementation-specific	@cindex commands, implementation-specific
@cindex commands, non-standard	@cindex commands, non-standard
@emph{FreeM Extension}	@emph{FreeM Extension}

	In its 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	@node ZHALT
@section ZHALT	@section ZHALT
@cindex ZHALT	@cindex ZHALT
Line 3395 Constants must only be locals, and globa	Line 3515 Constants must only be locals, and globa
@cindex commands, non-standard	@cindex commands, non-standard
@emph{FreeM Extension}	@emph{FreeM Extension}

	In its single-argumented form, @code{ZHALT} command is used to exit the FreeM process with a specific return value @emph{intexpr}.

	@emph{Syntax}

	@example
	ZHALT @emph{intexpr}
	@end example

	In its argumentless form, @code{ZHALT} is synonymous with @code{HALT}.

	@emph{Syntax}

	@example
	ZHALT
	@end example

@node ZINSERT	@node ZINSERT
@section ZINSERT	@section ZINSERT
@cindex ZINSERT	@cindex ZINSERT
Line 3403 Constants must only be locals, and globa	Line 3539 Constants must only be locals, and globa
@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 3463 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 3471 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 3497 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 3536 Raises an error condition as long as the	Line 3710 Raises an error condition as long as the
@cindex commands, non-standard	@cindex commands, non-standard
@emph{FreeM Extension}	@emph{FreeM Extension}

	Synonymous with @ref{ZTHROW}.

@node ZUNMAP	@node ZUNMAP
@section ZUNMAP	@section ZUNMAP
@cindex ZUNMAP	@cindex ZUNMAP
Line 4944 If you use other M implementations, you	Line 5120 If you use other M implementations, you
@cindex object-oriented programming	@cindex object-oriented programming
@cindex programming, object-oriented	@cindex programming, object-oriented

	@menu
	* Classes:: The organizing concept of object-oriented programming.
	* Inheritance:: Making one class derive from another.
	* Methods:: Attach code to classes.
	* Public and Private Variables:: Determining accessibility.
	* Instantiating Objects:: Creating instances of classes.
	@end menu

	@node Classes
@section Classes	@section Classes
@subsection Class Overview	@subsection Class Overview

Line 5000 DESTROY(THIS) ;	Line 5184 DESTROY(THIS) ;
Q	Q
@end example	@end example

	@node Inheritance
@section Inheritance	@section Inheritance

Every class you create will automatically inherit the methods and functionality of the @code{OBJECT} class, supplied with FreeM.	Every class you create will automatically inherit the methods and functionality of the @code{OBJECT} class, supplied with FreeM.
Line 5018 You can achieve runtime polymorphism by	Line 5203 You can achieve runtime polymorphism by

Note that the overridden method in the subclass can take a different set or number of arguments than the @emph{formallist} of the superclass method would specify.	Note that the overridden method in the subclass can take a different set or number of arguments than the @emph{formallist} of the superclass method would specify.

	@node Methods
@section Methods	@section Methods
Class methods are defined as tags with @emph{formallist}s in a class routine, and per the typical FreeM object pattern, must take at least one argument, being @code{THIS} (representing a reference to the object instance being accessed).	Class methods are defined as tags with @emph{formallist}s in a class routine, and per the typical FreeM object pattern, must take at least one argument, being @code{THIS} (representing a reference to the object instance being accessed).

Line 5040 DEFAULT.USER> W MYOBJ.MYMETHOD()	Line 5226 DEFAULT.USER> W MYOBJ.MYMETHOD()
VALUE	VALUE
@end example	@end example

	@node Public and Private Variables
@section 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.	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 5062 Either of the following commands will cr	Line 5249 Either of the following commands will cr

Attempting to access private fields from outside of the class will raise error condition @code{ZOBJFLDACCV}.	Attempting to access private fields from outside of the class will raise error condition @code{ZOBJFLDACCV}.

	@node Instantiating Objects
@section Instantiating Objects	@section Instantiating Objects

To instantiate an object (i.e., create an object from a certain class), you will use the @code{NEW} command as follows:	To instantiate an object (i.e., create an object from a certain class), you will use the @code{NEW} command as follows:
Line 5072 NEW MYSTR=$#^%STRING("myString")	Line 5260 NEW MYSTR=$#^%STRING("myString")

This will create a local variable called MYSTR of type STRING, and initialize it with the value myString.	This will create a local variable called MYSTR of type STRING, and initialize it with the value myString.

@section Determining Object Class	@subsection Determining Object Class

To determine the class of any FreeM local variable, you will use the @code{$$TYPE()} method:	To determine the class of any FreeM local variable, you will use the @code{$$TYPE()} method:

Line 5669 Raised when you attempt to use multiple	Line 5857 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}.	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}	@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}	@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{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}.
Line 5867 Raised when an attempt is made to use a	Line 6055 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 5927 $ make	Line 6115 $ 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 6385 int main(int argc, char argv, char e	Line 6587 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 6480 Supported actions are @code{list} and @c	Line 6682 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.44
changed lines
	Added in v.1.63