--- freem/doc/freem.texi 2025/05/16 13:22:58 1.56 +++ freem/doc/freem.texi 2025/05/18 20:40:35 1.59 @@ -49,6 +49,7 @@ This is the official manual for the Free * The FreeM Environment Daemon:: Managing shared resources in the FreeM environment. * The FreeM Direct-Mode Environment:: Executing M programs interactively. * Debugging:: The program development cycle of FreeM. +* Program Development Cycle:: How to create, edit, test, and run FreeM programs. * Directives:: Per-Routine Language Directives. * Intrinsic Special Variables:: Intrinsic Special Variables. @@ -429,7 +430,7 @@ If the daemon is started with @option{-- The @option{--environment} option will start the daemon for the specified @emph{environment-name}. The default environment, if unspecified, is called @code{DEFAULT}. If using an environment other than @code{DEFAULT}, interpreter processes that wish to also connect to the same environment must also use the @option{--environment} option when starting, and @code{libfreem} clients must also pass the environment name as the first argument to the @code{freem_init()} function. Environments allow you to run multiple, isolated instances of FreeM on the same machine, whose globals and routines are distinct and unique. -The @option{--shmsize} option specifies the size in bytes of the FreeM shared memory segment. The default is 4194304 bytes. Increasing the size of the FreeM shared memory segment will, at the cost of increased memory usage, increase the number of concurrent jobs and lock table entries available to the environment; decreasing the size of the segment will have the expected opposite effect. Note that you must also pass @option{--shmsize} with the same number of bytes to any interpreter process to be used with an environment whose daemon uses a non-default shared memory segment size. +The @option{--shmsize} option specifies the size in bytes of the FreeM shared memory segment. The default is 16,777,216 bytes (16 megabytes). Increasing the size of the FreeM shared memory segment will, at the cost of increased memory usage, increase the number of concurrent jobs and lock table entries available to the environment; decreasing the size of the segment will have the expected opposite effect. Note that you must also pass @option{--shmsize} with the same number of bytes to any interpreter process to be used with an environment whose daemon uses a non-default shared memory segment size. Attempting to start a FreeM interpreter process without a daemon running with the same environment name will result in an error. @@ -606,7 +607,7 @@ FreeM includes an interactive debugger, If you would like to enter the debugger automatically each time an error is encountered, add the following to your @code{LCLINIT} routine: @example -S $ETR="B ""DEBUG""" +S $ETRAP="B ""DEBUG""" @end example @section Debugging Commands @@ -633,6 +634,12 @@ Halts the process being debugged and ret With no arguments, toggles watchpoints on and off. With @code{+}, adds @emph{} to the watchlist. With @code{-}, removes @emph{} from the watchlist. With @code{?}, queries the watch status of @emph{}. @end table +@node Program Development Cycle +@chapter Program Development Cycle +@cindex program development + +This chapter covers the essential activities of program development in the FreeM environment, including viewing, creating, editing, and running routines. + @node Directives @chapter Directives @cindex directives @@ -2099,6 +2106,7 @@ Identical to @ref{$TRANSLATE()}, except * 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. +* ZEDIT:: Edit a routine using an external editor. * ZGOTO:: @code{GOTO} with @code{BREAK} control. * ZHALT:: Exit FreeM job with return value. * ZINSERT:: Insert code into routine buffer. @@ -3442,6 +3450,37 @@ Constants must only be locals, and globa @code{ZCONST@emph{:postcondition} @emph{mref1}=@emph{initial-value1},...,@emph{mrefN}=@emph{initial-valueN}} @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{} +@end example + +In its single-argument form, edits @emph{}, 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 @section ZGOTO @cindex ZGOTO @@ -3450,7 +3489,7 @@ Constants must only be locals, and globa @cindex commands, non-standard @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} @@ -3458,7 +3497,7 @@ In its argumented form, enables @code{BR ZGOTO @emph{entryref} @end example -In its argumented form, resumes execution after a @code{BREAK}. +In its argumentless form, resumes execution after a @code{BREAK}. @emph{Syntax} @@ -5976,14 +6015,14 @@ Raised when an attempt is made to use a FreeM allows the following installation methods: @table @asis @item Binary Repository -On recent versions the Ubuntu and Debian distributions of GNU/Linux, we provide package repositories from which FreeM may easily be installed. See the @emph{FreeM Wiki} for more information, and @emph{https://packages.coherent-logic.com} for instructions. +For recent versions of the Ubuntu and Debian distributions of GNU/Linux, we provide package repositories from which FreeM may easily be installed. See the @emph{FreeM Wiki} for more information, and @emph{https://packages.coherent-logic.com} for instructions. If available, this is the simplest method of installing FreeM. @item Binary Packages We provide binary packages of FreeM for @emph{dpkg} and @emph{rpm}-based distributions of GNU/Linux, and @emph{pkgadd} packages for Solaris 8-10. If you cannot use repositories, this is the easiest option. See @emph{https://freem.coherent-logic.com/binaries.cfm} for downloads and instructions. -@item Source Archive +@item Source Tarball If you prefer installing from source, we recommend that you download the latest @emph{.tar.gz} file from @emph{https://freem.coherent-logic.com/downloads.cfm}, and follow these steps: @example @@ -6035,6 +6074,20 @@ $ ./configure --enable-mwapi $ make $ sudo make install @end example + +@item @code{--enable-newglobals} (EXPERIMENTAL) +Enables a new and modernized global handler. This global handler has a number of known bugs, and thus should be used with caution. + +Note that global files created in the default global handler are incompatible with the new global handler, and vice-versa. You will need to back up and remove all globals in your environments when switching global handlers. + + +@emph{Example} + +@example +$ ./configure --enable-newglobals +$ make +$ sudo make install +@end example @end table