--- freem/doc/freem.texi 2025/04/10 17:21:54 1.24 +++ freem/doc/freem.texi 2025/04/18 01:23:05 1.25 @@ -110,7 +110,6 @@ This is the official manual for the Free @node Introduction @unnumbered Introduction - FreeM started its life as @emph{FreeMUMPS}, written for MS-DOS and ported to SCO UNIX by a mysterious individual going by the name of "Shalom ha-Ashkenaz". It was released to MUG Deutschland in 1998. In 1999, Ronald L. Fox ported FreeM to the Red Hat Linux 5 of the GNU/Linux operating system. Thereafter, maintenance was taken over by the Generic Universal M Project, which changed its name first to Public Standard MUMPS and then by popular request to FreeM. When GT.M was open-sourced in late 1999, FreeM and GUMP were essentially abandoned. L.D. Landis, the owner of the original GUMP SourceForge project, and one of FreeM's significant contributors, passed maintenance of FreeM and ownership of its SourceForge project to Serena Willis in 2014. At this point, FreeM would not compile or run on modern Linux systems, so steps were taken to remedy the most pressing issues in the codebase. Limitations on the terminal size (previously hard-coded to 80x25) were lifted, and new @code{$VIEW} functions were added to retrieve the terminal size information. @code{$X} and @code{$Y} intrinsic special variables were updated to support arbitrary terminal sizes, and FreeM was once again able to build and run. @@ -379,7 +378,7 @@ Copyright (C) 2014, 2020, 2021 Coherent USER> @end example -The prompt (@code{DEFAULT.USER>}) the current environment and namespace, @code{DEFAULT} and @code{USER}, respsectively. If any uncommitted direct-mode transactions have been started, the prompt will change to reflect the current value of @code{@ref{$TLEVEL}}: +The prompt (@code{DEFAULT.USER>}) displays the current environment and namespace, @code{DEFAULT} and @code{USER}, respsectively. If any uncommitted direct-mode transactions have been started, the prompt will change to reflect the current value of @code{@ref{$TLEVEL}}: @example TL1:DEFAULT.USER> @@ -1208,11 +1207,19 @@ The optional second argument indicates t @cindex $NEXT @cindex intrinsic functions, $NEXT +Deprecated. Use @code{$ORDER} instead. + @node $ORDER() @section $ORDER @cindex $ORDER @cindex intrinsic functions, $ORDER +Returns the previous subscript or next subscript in a local, global, or a subset of structured system variables. + +The first argument is the subscripted local, global, or SSVN. + +The optional second argument can be @code{1} to retrieve the next subscript, or @code{-1} to return the previous. + @node $PIECE() @section $PIECE @cindex $PIECE @@ -1399,6 +1406,21 @@ Returns a line of code from a routine. @cindex $TRANSLATE @cindex intrinsic functions, $TRANSLATE +Replaces characters in a string. + +The first argument is a string expression representing the text to be changed. + +The second argument is a list of characters to replace. + +The third argument is a list of characters to use as the replacements for the characters in the second argument. + +@emph{Example} + +@example + DEFAULT.USER> W $TRANSLATE("twig","wt","rb") + brig +@end example + @node $TYPE() @section $TYPE @cindex $TYPE @@ -1769,36 +1791,86 @@ $$.EXTRACT(,) @node $$FIND @section $$FIND +Finds the character immediately following the first occurence of a substring within a string. + +The first argument is the substring to be located. + +The second argument is the position within the string at which to begin searching. + +See @ref{$FIND()}. + @node $$FNUMBER @section $$FNUMBER +Formats a number according to a set of formatting codes. + +The argument is a series of formatting codes. See @ref{$FNUMBER()} for details. + @node $$JUSTIFY @section $$JUSTIFY +Right-justifies a string based on a specified fixed length. + +The first argument is the character length of the output. + +The second argument controls the number of fractional digits to be included in the output, and defaults to the number of digits specified in the first argument. + +See @ref{$JUSTIFY()} for details. + @node $$LENGTH @section $$LENGTH +Returns the length of the string. + @node $$PIECECOUNT @section $$PIECECOUNT +Returns the number of items in a list delimited by the character specified in the argument. + @node $$PIECE @section $$PIECE +@emph{Syntax} + +@code{$PIECE(@emph{d}[,@emph{n}[,@emph{end}]])} + +Accesses the @code{n}th through @code{end} @code{d}-delimited pieces of the string. + +The first argument is the delimiter to be used. + +The optional second argument is the first @code{d}-delimited piece to access, and defaults to @code{1}. + +The optional third argument is the final @code{d}-delimited piece to access, and defaults to the value of the third argument (@code{n}). + + @node $$REPLACE @section $$REPLACE +@emph{Syntax} +@code{myString.$$REPLACE(@emph{arg1},@emph{arg2})} + +Replaces all instances of @code{arg2} with @code{arg3} in @code{myString}. + @node $$REVERSE @section $$REVERSE +Returns the reverse of the string. + @node $$TOLOWER @section $$TOLOWER +Returns an all-lowercase version of the string. + @node $$TOUPPER @section $$TOUPPER +Returns an all-uppercase version of the string. + @node $$TRANSLATE @section $$TRANSLATE +Identical to @ref{$TRANSLATE()}, except that the arguments are shifted left by one, and the input string is implicit (the object). + @node Commands @chapter Commands @cindex commands