--- freem/doc/freem.texi 2025/05/05 14:10:34 1.50 +++ freem/doc/freem.texi 2025/05/06 01:38:21 1.53 @@ -100,7 +100,6 @@ This is the official manual for the Free * Accessing FreeM from C Programs:: How to use the mlib interface. * 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. * Implementation Limits:: FreeM limitations. * US-ASCII Character Set:: The US-ASCII character set. @@ -1115,7 +1114,7 @@ See @emph{https://wiki.osdev.org/Target_ * $ZLSD():: Compute Levenshtein distance between two arguments. * $ZM():: Unknown. * $ZNAME():: Unknown. -* $ZNEXT():: Unknown. +* $ZNEXT():: Return glvn of next numeric subscript following given glvn. * $ZORDER():: Unknown. * $ZPIECE():: Unknown. * $ZPREVIOUS():: Unknown. @@ -1313,6 +1312,28 @@ The optional second argument indicates t @cindex intrinsic functions, $NEXT 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() @section $ORDER @@ -1713,6 +1734,8 @@ Returns the Levenshtein distance between @cindex intrinsic functions, $ZM @cindex intrinsic functions, implementation-specific +Purpose unknown. + @node $ZNAME() @section $ZNAME @cindex $ZNAME @@ -1721,13 +1744,38 @@ Returns the Levenshtein distance between Purpose unknown. +This function relies on the value of @code{$VIEW(71)} being @code{0} (this is not the default). + @node $ZNEXT() @section $ZNEXT @cindex $ZNEXT @cindex intrinsic functions, $ZNEXT @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() @section $ZORDER @@ -6442,8 +6490,8 @@ int main(int argc, char **argv, char **e @cindex fmadm 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. -This appendix will document each @code{fmadm} facility as it is implemented, until all of the legacy utilities have been replaced. +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. The @code{fmadm} utility's functions all follow the below, consistent syntax: @@ -6537,43 +6585,6 @@ Supported actions are @code{list} and @c @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{} -@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{} -@end example - @node FreeM VIEW Commands and Functions @appendix FreeM VIEW Commands and Functions