docs
[pspp] / doc / utilities.texi
index 1c75baa6026fc2653441bc6de1827f1b0c7ac8e6..8dce637cc89a92b30cc267cedeb47b94d48df48b 100644 (file)
@@ -497,10 +497,6 @@ SET
 
 (syntax execution)
         /LOCALE='@var{locale}'
-        /MEXPAND=@{ON,OFF@}
-        /MITERATE=@var{max_iterations}
-        /MNEST=@var{max_nest}
-        /MPRINT=@{ON,OFF@}
         /MXLOOPS=@var{max_loops}
         /SEED=@{RANDOM,@var{seed_value}@}
         /UNDEFINED=@{WARN,NOWARN@}
@@ -510,6 +506,7 @@ SET
         /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}
+        /MDISPLAY=@{TEXT,TABLES@}
         /SMALL=@var{number}
         /WIB=@{NATIVE,MSBFIRST,LSBFIRST,VAX@}
         /WRB=@{NATIVE,ISL,ISB,IDL,IDB,VF,VD,VG,ZS,ZL@}
@@ -532,28 +529,27 @@ SET
         /JOURNAL=@{ON,OFF@} ['@var{file_name}']
 
 (system files)
-        /COMPRESSION=@{ON,OFF@}
         /SCOMPRESSION=@{ON,OFF@}
 
 (miscellaneous)
         /SAFER=ON
         /LOCALE='@var{string}'
 
-
-(obsolete settings accepted for compatibility, but ignored)
-        /BOXSTRING=@{'@var{xxx}','@var{xxxxxxxxxxx}'@}
-        /CASE=@{UPPER,UPLOW@}
-        /CPI=cpi_value
-        /HIGHRES=@{ON,OFF@}
-        /HISTOGRAM='@var{c}'
-        /LOWRES=@{AUTO,ON,OFF@}
-        /LPI=@var{lpi_value}
-        /MENUS=@{STANDARD,EXTENDED@}
-        /MXMEMORY=@var{max_memory}
-        /SCRIPTTAB='c'
-        /TB1=@{'@var{xxx}','@var{xxxxxxxxxxx}'@}
-        /TBFONTS='@var{string}'
-        /XSORT=@{YES,NO@}
+(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}'
+        /BOX=@{'@var{xxx}','@var{xxxxxxxxxxx}'@}
+        /CACHE=@{ON,OFF@}
+        /CELLSBREAK=@var{number}
+        /COMPRESSION=@{ON,OFF@}
+        /CMPTRANS=@{ON,OFF@}
+        /HEADER=@{NO,YES,BLANK@}
 @end display
 
 @cmd{SET} allows the user to adjust several parameters relating to
@@ -694,17 +690,15 @@ Example locales are @code{en_US.UTF-8} (UTF-8 encoded English as
 spoken in the United States) and @code{ja_JP.EUC-JP} (EUC-JP encoded
 Japanese as spoken in Japan).
 
-@item MEXPAND
-@itemx MITERATE
-@itemx MNEST
-@itemx MPRINT
-Currently not used.
-
 @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.
 
@@ -753,6 +747,15 @@ 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 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
@@ -842,6 +845,7 @@ If the value has no label, then the literal value is used for display.
 If @subcmd{TNUMBERS} is set to @subcmd{BOTH}, then values are displayed with both their label
 (if any) and their literal value in parentheses.
 @item TVARS
+@anchor{SET TVARS}
 The @subcmd{TVARS} option sets the way in which variables are displayed in output tables.
 The valid settings are @subcmd{NAMES}, @subcmd{LABELS} and @subcmd{BOTH}.
 If @subcmd{TVARS} is set to @subcmd{NAMES}, then all variables are displayed using their names.
@@ -887,9 +891,6 @@ System file subcommands affect the default format of system files
 produced by @pspp{}.  These subcommands are
 
 @table @asis
-@item COMPRESSION
-Not currently used.
-
 @item SCOMPRESSION
 Whether system files created by @cmd{SAVE} or @cmd{XSAVE} are
 compressed by default.  The default is @subcmd{ON}.
@@ -948,6 +949,46 @@ 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.
+
+@table @asis
+@item BASETEXTDIRECTION
+@itemx BLOCK
+@itemx BOX
+@itemx CACHE
+@itemx CELLSBREAK
+@itemx COMPRESSION
+@itemx CMPTRANS
+@itemx HEADER
+@end table
+
 @node SHOW
 @section SHOW
 @vindex SHOW
@@ -969,11 +1010,16 @@ SHOW
         [FORMAT]
         [FUZZBITS]
         [LENGTH]
+        [MEXPAND]
+        [MPRINT]
+        [MITERATE]
+        [MNEST]
         [MXERRS]
         [MXLOOPS]
         [MXWARNS]
         [N]
         [SCOMPRESSION]
+        [SYSTEM]
         [TEMPDIR]
         [UNDEFINED]
         [VERSION]
@@ -1000,6 +1046,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}