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.49 and 1.61

version 1.49, 2025/05/05 13:15:53	version 1.61, 2025/05/19 12:45:01
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-rc0), 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-rc0
@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-rc0 (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 1713 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 1721 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 2047 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 2059 Identical to @ref{$TRANSLATE()}, except	Line 2119 Identical to @ref{$TRANSLATE()}, except
* 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 2600 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-rc0, but are planned for a future release.
@end quotation	@end quotation
@end cartouche	@end cartouche

Line 2635 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-rc0, but are planned for a future release.
@end quotation	@end quotation
@end cartouche	@end cartouche

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

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

	@emph{Errors}

	@code{ZEDIT} will raise @code{ZNOPGM} if the routine cannot be found, or there is no routine currently loaded in argumentless form.

@node ZGOTO	@node ZGOTO
@section ZGOTO	@section ZGOTO
@cindex ZGOTO	@cindex ZGOTO
Line 3398 Constants must only be locals, and globa	Line 3489 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 3406 In its argumented form, enables @code{BR	Line 3497 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 3446 ZHALT	Line 3537 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 3506 ZMAP[@emph{:postcondition}] GLOBAL @emph	Line 3607 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 3514 Prints the contents of the current routi	Line 3615 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 3540 In its argumentless form, quits from @co	Line 3651 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 3579 Raises an error condition as long as the	Line 3708 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 5922 Raised when an attempt is made to use a	Line 6053 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 5982 $ make	Line 6113 $ 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 6440 int main(int argc, char argv, char e	Line 6585 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 6535 Supported actions are @code{list} and @c	Line 6680 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.49
changed lines
	Added in v.1.61