[BACK]Return to freem.texi CVS log [TXT] [DIR] Up to [Coherent Logic Development] / freem / doc

Diff for /freem/doc/freem.texi between versions 1.49 and 1.53

version 1.49, 2025/05/05 13:15:53 version 1.53, 2025/05/06 01:38:21
Line 100  This is the official manual for the Free Line 100  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 1115  See @emph{https://wiki.osdev.org/Target_ Line 1114  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 1312  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 1734  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 1744  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 2059  Identical to @ref{$TRANSLATE()}, except Line 2107  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 3579  Raises an error condition as long as the Line 3627  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 6440  int main(int argc, char **argv, char **e Line 6490  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 6585  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
   
Removed from v.1.49  
changed lines
  Added in v.1.53

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>