Automatically infer variables' measurement level from format and data.

[pspp] / doc / utilities.texi

diff --git a/doc/utilities.texi b/doc/utilities.texi
index bb248454abfad21b03aff6fddd6826a0f4c56573..4cad836ad11eaac66c8dbfc537c0e24209ad13c5 100644 (file)
--- a/doc/utilities.texi
+++ b/doc/utilities.texi
@@ -501,11 +501,14 @@ SET
         /SEED=@{RANDOM,@var{seed_value}@}
         /UNDEFINED=@{WARN,NOWARN@}
         /FUZZBITS=@var{fuzzbits}
+        /SCALEMIN=@var{count}
 
 (data output)
         /CC@{A,B,C,D,E@}=@{'@var{npre},@var{pre},@var{suf},@var{nsuf}','@var{npre}.@var{pre}.@var{suf}.@var{nsuf}'@}
         /DECIMAL=@{DOT,COMMA@}
         /FORMAT=@var{fmt_spec}
+        /LEADZERO=@{ON,OFF@}
+        /MDISPLAY=@{TEXT,TABLES@}
         /SMALL=@var{number}
         /WIB=@{NATIVE,MSBFIRST,LSBFIRST,VAX@}
         /WRB=@{NATIVE,ISL,ISB,IDL,IDB,VF,VD,VG,ZS,ZL@}
@@ -534,6 +537,12 @@ SET
         /SAFER=ON
         /LOCALE='@var{string}'
 
+(macros)
+        /MEXPAND=@{ON,OFF@}
+        /MPRINT=@{ON,OFF@}
+        /MITERATE=@var{number}
+        /MNEST=@var{number}
+
 (settings not yet implemented, but accepted and ignored)
         /BASETEXTDIRECTION=@{AUTOMATIC,RIGHTTOLEFT,LEFTTORIGHT@}
         /BLOCK='@var{c}'
@@ -543,10 +552,6 @@ SET
         /COMPRESSION=@{ON,OFF@}
         /CMPTRANS=@{ON,OFF@}
         /HEADER=@{NO,YES,BLANK@}
-        /MEXPAND=@{ON,OFF@}
-        /MITERATE=@var{number}
-        /MNEST=@var{number}
-        /MPRINT=@{ON,OFF@}
 @end display
 
 @cmd{SET} allows the user to adjust several parameters relating to
@@ -688,10 +693,14 @@ spoken in the United States) and @code{ja_JP.EUC-JP} (EUC-JP encoded
 Japanese as spoken in Japan).
 
 @item MXLOOPS
-The maximum number of iterations for an uncontrolled loop (@pxref{LOOP}).
-The default @var{max_loops} is 40.
+@anchor{SET MXLOOPS}
+
+The maximum number of iterations for an uncontrolled loop
+(@pxref{LOOP}), and for any loop in the matrix language (@pxref{Matrix
+LOOP and BREAK Commands}).  The default @var{max_loops} is 40.
 
 @item SEED
+@anchor{SET SEED}
 The initial pseudo-random number seed.  Set it to a real number or to
 RANDOM, to obtain an initial seed from the current time of day.
 
@@ -705,6 +714,11 @@ to accept for rounding up a value that is almost halfway between two
 possibilities for rounding with the RND operator (@pxref{Miscellaneous
 Mathematics}).  The default @var{fuzzbits} is 6.
 
+@item SCALEMIN
+@anchor{SET SCALEMIN}
+The minimum number of distinct valid values for @pspp{} to assume that
+a variable has a scale measurement level.  @xref{Measurement Level}.
+
 @item WORKSPACE
 The maximum amount of memory (in kilobytes) that @pspp{} uses to
 store data being processed.  If memory in excess of the workspace size
@@ -740,6 +754,24 @@ The default @subcmd{DOT} setting causes the decimal point character to be
 Allows the default numeric input/output format to be specified.  The
 default is F8.2.  @xref{Input and Output Formats}.
 
+@item LEADZERO
+@anchor{SET LEADZERO}
+
+Controls whether numbers with magnitude less than one are displayed
+with a zero before the decimal point.  For example, with @code{SET
+LEADZERO=OFF}, which is the default, one-half is shown as 0.5, and
+with @code{SET LEADZERO=ON}, it is shown as .5.  This setting affects
+only the @code{F}, @code{COMMA}, and @code{DOT} formats.
+
+@item MDISPLAY
+@anchor{SET MDISPLAY}
+
+Controls how the @code{PRINT} command within
+@code{MATRIX}@dots{}@code{END MATRIX} outputs matrices.  With the
+default @subcmd{TEXT}, @code{PRINT} outputs matrices as text.  Change
+this setting to @code{TABLES} to instead output matrices as pivot
+tables.  @xref{Matrix PRINT Command}, for more information.
+
 @item SMALL
 This controls how @pspp{} formats small numbers in pivot tables, in
 cases where @pspp{} does not otherwise have a well-defined format for
@@ -932,6 +964,32 @@ Contrary to intuition, this command does not affect any aspect
 of the system's locale.
 @end table
 
+The following subcommands affect the interpretation of macros.
+
+@table @asis
+@item MEXPAND
+@anchor{SET MEXPAND}
+Controls whether macros are expanded.  The default is ON.
+
+@item MPRINT
+@anchor{SET MPRINT}
+Controls whether the expansion of macros is included in output.  This
+is separate from whether command syntax in general is included in
+output.  The default is OFF.
+
+@item MITERATE
+@anchor{SET MITERATE}
+Limits the number of iterations executed in @code{!DO} loops within
+macros.  This does not affect other language constructs such as
+@cmd{LOOP}.  This must be set to a positive integer.  The default is
+1000.
+
+@item MNEST
+@anchor{SET MNEST}
+Limits the number of levels of nested macro expansions.  This must be
+set to a positive integer.  The default is 50.
+@end table
+
 The following subcommands are not yet implemented, but PSPP accepts
 them and ignores the settings.
 
@@ -944,10 +1002,6 @@ them and ignores the settings.
 @itemx COMPRESSION
 @itemx CMPTRANS
 @itemx HEADER
-@itemx MEXPAND
-@itemx MITERATE
-@itemx MNEST
-@itemx MPRINT
 @end table
 
 @node SHOW
@@ -971,11 +1025,16 @@ SHOW
         [FORMAT]
         [FUZZBITS]
         [LENGTH]
+        [MEXPAND]
+        [MPRINT]
+        [MITERATE]
+        [MNEST]
         [MXERRS]
         [MXLOOPS]
         [MXWARNS]
         [N]
         [SCOMPRESSION]
+        [SYSTEM]
         [TEMPDIR]
         [UNDEFINED]
         [VERSION]
@@ -1002,6 +1061,9 @@ Shows the operating system details.
 @item @subcmd{N}
 Reports the number of cases in the active dataset.  The reported number is not
 weighted.  If no dataset is defined, then @samp{Unknown} is reported.
+@item @subcmd{SYSTEM}
+Shows information about how PSPP was built.  This information is
+useful in bug reports.  @xref{Bugs}, for details.
 @item @subcmd{TEMPDIR}
 Shows the path of the directory where temporary files are stored.
 @item @subcmd{VERSION}