pivot table procedure conceptually works

[pspp] / doc / utilities.texi

diff --git a/doc/utilities.texi b/doc/utilities.texi
index c568acec6c1967f61918cb1a64e30e65855f4069..da5b7b0daae7d3f5ae0e99f053b53e2d8c475af2 100644 (file)
--- a/doc/utilities.texi
+++ b/doc/utilities.texi
@@ -25,6 +25,7 @@ encountered in the input.
 * HOST::                        Temporarily return to the operating system.
 * INCLUDE::                     Include a file within the current one.
 * INSERT::                      Insert a file within the current one.
+* OUTPUT::                      Modify the appearance of the output.
 * PERMISSIONS::                 Change permissions on a file.
 * PRESERVE and RESTORE::        Saving settings and restoring them later.
 * SET::                         Adjust @pspp{} runtime parameters.
@@ -334,6 +335,42 @@ When ENCODING is not specified, the default is taken from the
 @option{--syntax-encoding} command option, if it was specified, and
 otherwise it is @code{Auto}.
 
+@node OUTPUT
+@section OUTPUT
+@vindex OUTPUT
+@cindex precision, of output
+@cindex decimal places
+
+@display
+OUTPUT MODIFY
+       /SELECT TABLES
+       /TABLECELLS SELECT = [ @{SIGNIFICANCE, COUNT@} ]
+                   FORMAT = @var{fmt_spec}.
+@end display
+@note{In the above synopsis the characters @samp{[} and @samp{]} are literals.
+They must appear in the syntax to be interpreted.}
+
+@cmd{OUTPUT} changes the appearance of the tables in which results are printed.
+In particular, it can be used to set the format and precision to which results are displayed.
+
+After running this command, the default table appearance parameters will have been modified and  each 
+new output table generated will use the new parameters.
+
+Following @code{/TABLECELLS SELECT =} a list of cell classes must appear, enclosed in square
+brackets.  This list determines the classes of values should be selected for modification.
+Each class can be:
+
+@table @asis
+@item SIGNIFICANCE
+Significance of tests (p-values).
+
+@item COUNT
+Counts or sums of weights.
+@end table
+
+The value of @var{fmt_spec} must be a valid output format (@pxref{Input and Output Formats}).
+Note that not all possible formats are meaningful for all classes.
+
 @node PERMISSIONS
 @section PERMISSIONS
 @vindex PERMISSIONS
@@ -423,6 +460,7 @@ SET
         /MORE=@{ON,OFF@}
         /WIDTH=@{NARROW,WIDTH,@var{n_characters}@}
         /TNUMBERS=@{VALUES,LABELS,BOTH@}
+        /TVARS=@{NAMES,LABELS,BOTH@}
 
 (logging)
         /JOURNAL=@{ON,OFF@} ['@var{file_name}']
@@ -605,7 +643,7 @@ RANDOM, which will obtain an initial seed from the current time of day.
 Currently not used.
 
 @item WORKSPACE
-The maximum amount of memory that @pspp{} will use to store data being processed.
+The maximum amount of memory (in kilobytes) that @pspp{} will use to store data being processed.
 If memory in excess of the workspace size is required, then @pspp{} will start
 to use temporary files to store the data.
 Setting a higher value will, in general, mean procedures will run faster, 
@@ -719,7 +757,16 @@ If @subcmd{TNUMBERS} is set to @subcmd{LABELS}, then values are displayed using
 (@xref{VALUE LABELS}.)
 If the a value has no label, then it will be displayed using its literal value.
 If @subcmd{TNUMBERS} is set to @subcmd{BOTH}, then values will be displayed with both their label
-(if any) and their literal value in parenthesis.
+(if any) and their literal value in parentheses.
+@item 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.
+If @subcmd{TVARS} is set to @subcmd{LABELS}, then variables are displayed using their label if one
+has been set.  If no label has been set, then the name will be used.
+(@xref{VARIABLE LABELS}.)
+If @subcmd{TVARS} is set to @subcmd{BOTH}, then variables will be displayed with both their label
+(if any) and their name in parentheses.
 @end table
 
 @cindex headers
@@ -851,7 +898,7 @@ parameters.  Parameters that can be changed using @cmd{SET}
 with the same name.  @cmd{SHOW} supports the following additional
 subcommands:
 
-@table @bullet
+@table @asis
 @item @subcmd{ALL}
 Show all settings.
 @item @subcmd{CC}