CTABLES: implement some simple features
[pspp] / doc / utilities.texi
1 @c PSPP - a program for statistical analysis.
2 @c Copyright (C) 2017, 2020 Free Software Foundation, Inc.
3 @c Permission is granted to copy, distribute and/or modify this document
4 @c under the terms of the GNU Free Documentation License, Version 1.3
5 @c or any later version published by the Free Software Foundation;
6 @c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
7 @c A copy of the license is included in the section entitled "GNU
8 @c Free Documentation License".
9 @c
10 @node Utilities
11 @chapter Utilities
12
13 Commands that don't fit any other category are placed here.
14
15 Most of these commands are not affected by commands like @cmd{IF} and
16 @cmd{LOOP}:
17 they take effect only once, unconditionally, at the time that they are
18 encountered in the input.
19
20 @menu
21 * ADD DOCUMENT::                Add documentary text to the active dataset.
22 * CACHE::                       Ignored for compatibility.
23 * CD::                          Change the current directory.
24 * COMMENT::                     Document your syntax file.
25 * DOCUMENT::                    Document the active dataset.
26 * DISPLAY DOCUMENTS::           Display active dataset documents.
27 * DISPLAY FILE LABEL::          Display the active dataset label.
28 * DROP DOCUMENTS::              Remove documents from the active dataset.
29 * ECHO::                        Write a string to the output stream.
30 * ERASE::                       Erase a file.
31 * EXECUTE::                     Execute pending transformations.
32 * FILE LABEL::                  Set the active dataset's label.
33 * FINISH::                      Terminate the @pspp{} session.
34 * HOST::                        Temporarily return to the operating system.
35 * INCLUDE::                     Include a file within the current one.
36 * INSERT::                      Insert a file within the current one.
37 * OUTPUT::                      Modify the appearance of the output.
38 * PERMISSIONS::                 Change permissions on a file.
39 * PRESERVE and RESTORE::        Saving settings and restoring them later.
40 * SET::                         Adjust @pspp{} runtime parameters.
41 * SHOW::                        Display runtime parameters.
42 * SUBTITLE::                    Provide a document subtitle.
43 * TITLE::                       Provide a document title.
44 @end menu
45
46 @node ADD DOCUMENT
47 @section ADD DOCUMENT
48 @vindex  ADD DOCUMENT
49
50 @display
51 ADD DOCUMENT
52     'line one' 'line two' @dots{} 'last line' .
53 @end display
54
55
56 @cmd{ADD DOCUMENT} adds one or more lines of descriptive commentary to
57 the active dataset.  Documents added in this way are saved to system files.
58 They can be viewed using @cmd{SYSFILE INFO} or @cmd{DISPLAY
59 DOCUMENTS}.  They can be removed from the active dataset with @cmd{DROP
60 DOCUMENTS}.
61
62 Each line of documentary text must be enclosed in quotation marks, and
63 may not be more than 80 bytes long. @xref{DOCUMENT}.
64
65 @node CACHE
66 @section CACHE
67 @vindex CACHE
68
69 @display
70 CACHE.
71 @end display
72
73 This command is accepted, for compatibility, but it has no effect.
74
75 @node CD
76 @section CD
77 @vindex CD
78 @cindex directory
79 @cindex changing directory
80
81 @display
82 CD 'new directory' .
83 @end display
84
85 @cmd{CD} changes the current directory.  The new directory becomes
86 that specified by the command.
87
88 @node COMMENT
89 @section COMMENT
90 @vindex COMMENT
91 @vindex *
92
93 @display
94 Comment commands:
95     COMMENT comment text @dots{} .
96     *comment text @dots{} .
97
98 Comments within a line of syntax:
99     FREQUENCIES /VARIABLES=v0 v1 v2.  /* All our categorical variables.
100 @end display
101
102 @cmd{COMMENT} is ignored.  It is used to provide information to
103 the author and other readers of the @pspp{} syntax file.
104
105 @cmd{COMMENT} can extend over any number of lines.  It ends at a dot
106 at the end of a line or a blank line.  The comment may contain any
107 characters.
108
109 PSPP also supports comments within a line of syntax, introduced with
110 @samp{/*}.  These comments end at the first @samp{*/} or at the end of
111 the line, whichever comes first.  A line that contains just this kind
112 of comment is considered blank and ends the current command.
113
114 @node DOCUMENT
115 @section DOCUMENT
116 @vindex DOCUMENT
117
118 @display
119 DOCUMENT @var{documentary_text}.
120 @end display
121
122 @cmd{DOCUMENT} adds one or more lines of descriptive commentary to the
123 active dataset.  Documents added in this way are saved to system files.
124 They can be viewed using @cmd{SYSFILE INFO} or @cmd{DISPLAY
125 DOCUMENTS}.  They can be removed from the active dataset with @cmd{DROP
126 DOCUMENTS}.
127
128 Specify the @var{documentary text} following the @subcmd{DOCUMENT} keyword.
129 It is interpreted literally---any quotes or other punctuation marks
130 are included in the file.
131 You can extend the documentary text over as many lines as necessary,
132 including blank lines to separate paragraphs.
133 Lines are truncated at 80 bytes.  Don't forget to terminate
134 the command with a dot at the end of a line. @xref{ADD DOCUMENT}.
135
136 @node DISPLAY DOCUMENTS
137 @section DISPLAY DOCUMENTS
138 @vindex DISPLAY DOCUMENTS
139
140 @display
141 DISPLAY DOCUMENTS.
142 @end display
143
144 @cmd{DISPLAY DOCUMENTS} displays the documents in the active dataset.  Each
145 document is preceded by a line giving the time and date that it was
146 added.  @xref{DOCUMENT}.
147
148 @node DISPLAY FILE LABEL
149 @section DISPLAY FILE LABEL
150 @vindex DISPLAY FILE LABEL
151
152 @display
153 DISPLAY FILE LABEL.
154 @end display
155
156 @cmd{DISPLAY FILE LABEL} displays the file label contained in the
157 active dataset,
158 if any.  @xref{FILE LABEL}.
159
160 This command is a @pspp{} extension.
161
162 @node DROP DOCUMENTS
163 @section DROP DOCUMENTS
164 @vindex DROP DOCUMENTS
165
166 @display
167 DROP DOCUMENTS.
168 @end display
169
170 @cmd{DROP DOCUMENTS} removes all documents from the active dataset.
171 New documents can be added with @cmd{DOCUMENT} (@pxref{DOCUMENT}).
172
173 @cmd{DROP DOCUMENTS} changes only the active dataset.  It does not modify any
174 system files stored on disk.
175
176 @node ECHO
177 @section ECHO
178 @vindex ECHO
179
180 @display
181 ECHO 'arbitrary text' .
182 @end display
183
184 Use @cmd{ECHO} to write arbitrary text to the output stream. The text should be enclosed in quotation marks following the normal rules for string tokens (@pxref{Tokens}).
185
186 @node ERASE
187 @section ERASE
188 @vindex ERASE
189
190 @display
191 ERASE FILE @var{file_name}.
192 @end display
193
194 @cmd{ERASE FILE} deletes a file from the local file system.
195 @var{file_name} must be quoted.
196 This command cannot be used if the SAFER (@pxref{SET}) setting is active.
197
198
199 @node EXECUTE
200 @section EXECUTE
201 @vindex EXECUTE
202
203 @display
204 EXECUTE.
205 @end display
206
207 @cmd{EXECUTE} causes the active dataset to be read and all pending
208 transformations to be executed.
209
210 @node FILE LABEL
211 @section FILE LABEL
212 @vindex FILE LABEL
213
214 @display
215 FILE LABEL @var{file_label}.
216 @end display
217
218 @cmd{FILE LABEL} provides a title for the active dataset.  This
219 title is saved into system files and portable files that are
220 created during this @pspp{} run.
221
222 @var{file_label} should not be quoted.
223 If quotes are included, they are literally interpreted and become part of the file label.
224
225 @node FINISH
226 @section FINISH
227 @vindex FINISH
228
229 @display
230 FINISH.
231 @end display
232
233 @cmd{FINISH} terminates the current @pspp{} session and returns
234 control to the operating system.
235
236 @node HOST
237 @section HOST
238 @vindex HOST
239
240 In the syntax below, the square brackets must be included in the
241 command syntax and do not indicate that that their contents are
242 optional.
243
244 @display
245 HOST COMMAND=['@var{command}'...]
246      TIMELIMIT=@var{secs}.
247 @end display
248
249 @cmd{HOST} executes one or more commands, each provided as a string in
250 the required @subcmd{COMMAND} subcommand, in the shell of the
251 underlying operating system.  PSPP runs each command in a separate
252 shell process and waits for it to finish before running the next one.
253 If a command fails (with a nonzero exit status, or because it is
254 killed by a signal), then PSPP does not run any remaining commands.
255
256 PSPP provides @file{/dev/null} as the shell's standard input.  If a
257 process needs to read from stdin, redirect from a file or device, or
258 use a pipe.
259
260 PSPP displays the shell's standard output and standard error as PSPP
261 output.  Redirect to a file or @code{/dev/null} or another device if
262 this is not desired.
263
264 The following example runs @code{rsync} to copy a file from a remote
265 server to the local file @file{data.txt}, writing @code{rsync}'s own
266 output to @file{rsync-log.txt}.  PSPP displays the command's error
267 output, if any.  If @code{rsync} needs to prompt the user (@i{e.g.}@: to
268 obtain a password), the command fails.  Only if the @code{rsync}
269 succeeds, PSPP then runs the @code{sha512sum} command.
270
271 @example
272 HOST COMMAND=['rsync remote:data.txt data.txt > rsync-log.txt'
273               'sha512sum -c data.txt.sha512sum].
274 @end example
275
276 By default, PSPP waits as long as necessary for the series of commands
277 to complete.  Use the optional @subcmd{TIMELIMIT} subcommand to limit
278 the execution time to the specified number of seconds.
279
280 PSPP built for mingw does not support all the features of
281 @subcmd{HOST}.
282
283 PSPP rejects this command if the SAFER (@pxref{SET}) setting is
284 active.
285
286 @node INCLUDE
287 @section INCLUDE
288 @vindex INCLUDE
289
290 @display
291         INCLUDE [FILE=]'@var{file_name}' [ENCODING='@var{encoding}'].
292 @end display
293
294 @cmd{INCLUDE} causes the @pspp{} command processor to read an
295 additional command file as if it were included bodily in the current
296 command file.
297 If errors are encountered in the included file, then command
298 processing stops and no more commands are processed.
299 Include files may be nested to any depth, up to the limit of available
300 memory.
301
302 The @cmd{INSERT} command (@pxref{INSERT}) is a more flexible
303 alternative to @cmd{INCLUDE}.  An @cmd{INCLUDE} command acts the same as
304 @cmd{INSERT} with @subcmd{ERROR=STOP CD=NO SYNTAX=BATCH} specified.
305
306 The optional @subcmd{ENCODING} subcommand has the same meaning as with @cmd{INSERT}.
307
308 @node INSERT
309 @section INSERT
310 @vindex INSERT
311
312 @display
313      INSERT [FILE=]'@var{file_name}'
314         [CD=@{NO,YES@}]
315         [ERROR=@{CONTINUE,STOP@}]
316         [SYNTAX=@{BATCH,INTERACTIVE@}]
317         [ENCODING=@{LOCALE, '@var{charset_name}'@}].
318 @end display
319
320 @cmd{INSERT} is similar to @cmd{INCLUDE} (@pxref{INCLUDE})
321 but somewhat more flexible.
322 It causes the command processor to read a file as if it were embedded in the
323 current command file.
324
325 If @subcmd{CD=YES} is specified, then before including the file, the
326 current directory becomes the directory of the included
327 file.
328 The default setting is @samp{CD=NO}.
329 Note that this directory remains current until it is
330 changed explicitly (with the @cmd{CD} command, or a subsequent
331 @cmd{INSERT} command with the @samp{CD=YES} option).
332 It does not revert to its original setting even after the included
333 file is finished processing.
334
335 If @subcmd{ERROR=STOP} is specified, errors encountered in the
336 inserted file causes processing to immediately cease.
337 Otherwise processing continues at the next command.
338 The default setting is @subcmd{ERROR=CONTINUE}.
339
340 If @subcmd{SYNTAX=INTERACTIVE} is specified then the syntax contained in
341 the included file must conform to interactive syntax
342 conventions. @xref{Syntax Variants}.
343 The default setting is @subcmd{SYNTAX=BATCH}.
344
345 @subcmd{ENCODING} optionally specifies the character set used by the included
346 file.  Its argument, which is not case-sensitive, must be in one of
347 the following forms:
348
349 @table @asis
350 @item @subcmd{LOCALE}
351 The encoding used by the system locale, or as overridden by the
352 @cmd{SET} command (@pxref{SET}).  On GNU/Linux and other Unix-like systems,
353 environment variables, @i{e.g.}@: @env{LANG} or @env{LC_ALL}, determine the
354 system locale.
355
356 @item @var{charset_name}
357 One of the character set names listed by @acronym{IANA} at
358 @uref{http://www.iana.org/assignments/character-sets}.  Some examples
359 are @code{ASCII} (United States), @code{ISO-8859-1} (western Europe),
360 @code{EUC-JP} (Japan), and @code{windows-1252} (Windows).  Not all
361 systems support all character sets.
362
363 @item @code{Auto,@var{encoding}}
364 Automatically detects whether a syntax file is encoded in an Unicode
365 encoding such as UTF-8, UTF-16, or UTF-32.  If it is not, then @pspp{}
366 generally assumes that the file is encoded in @var{encoding} (an @acronym{IANA}
367 character set name).  However, if @var{encoding} is UTF-8, and the
368 syntax file is not valid UTF-8, @pspp{} instead assumes that the file
369 is encoded in @code{windows-1252}.
370
371 For best results, @var{encoding} should be an @acronym{ASCII}-compatible
372 encoding (the most common locale encodings are all @acronym{ASCII}-compatible),
373 because encodings that are not @acronym{ASCII} compatible cannot be
374 automatically distinguished from UTF-8.
375
376 @item @code{Auto}
377 @item @code{Auto,Locale}
378 Automatic detection, as above, with the default encoding taken from
379 the system locale or the setting on @subcmd{SET LOCALE}.
380 @end table
381
382 When ENCODING is not specified, the default is taken from the
383 @option{--syntax-encoding} command option, if it was specified, and
384 otherwise it is @code{Auto}.
385
386 @node OUTPUT
387 @section OUTPUT
388 @vindex OUTPUT
389 @cindex precision, of output
390 @cindex decimal places
391
392 @display
393 OUTPUT MODIFY
394        /SELECT TABLES
395        /TABLECELLS SELECT = [ @var{class}... ]
396                    FORMAT = @var{fmt_spec}.
397 @end display
398 @note{In the above synopsis the characters @samp{[} and @samp{]} are literals.
399 They must appear in the syntax to be interpreted.}
400
401 @cmd{OUTPUT} changes the appearance of the tables in which results are
402 printed. In particular, it can be used to set the format and precision
403 to which results are displayed.
404
405 After running this command, the default table appearance parameters
406 will have been modified and  each new output table generated uses
407 the new parameters.
408
409 Following @code{/TABLECELLS SELECT =} a list of cell classes must
410 appear, enclosed in square brackets.  This list determines the classes
411 of values should be selected for modification. Each class can be:
412
413 @table @asis
414 @item RESIDUAL
415 Residual values.  Default: @t{F40.2}.
416
417 @item CORRELATION
418 Correlations.  Default: @t{F40.3}.
419
420 @item PERCENT
421 Percentages.  Default: @t{PCT40.1}.
422
423 @item SIGNIFICANCE
424 Significance of tests (p-values).  Default: @t{F40.3}.
425
426 @item COUNT
427 Counts or sums of weights.  For a weighted data set, the default is
428 the weight variable's print format.  For an unweighted data set, the
429 default is F40.0.
430 @end table
431
432 For most other numeric values that appear in tables, @code{SET FORMAT}
433 may be used to specify the format (@pxref{SET FORMAT}).
434
435 The value of @var{fmt_spec} must be a valid output format (@pxref{Input and Output Formats}).
436 Note that not all possible formats are meaningful for all classes.
437
438 @node PERMISSIONS
439 @section PERMISSIONS
440 @vindex PERMISSIONS
441 @cindex mode
442 @cindex file mode
443 @cindex changing file permissions
444
445 @display
446 PERMISSIONS
447         FILE='@var{file_name}'
448         /PERMISSIONS = @{READONLY,WRITEABLE@}.
449 @end display
450
451 @cmd{PERMISSIONS} changes the permissions of a file.
452 There is one mandatory subcommand which specifies the permissions to
453 which the file should be changed.
454 If you set a file's  permission  to @subcmd{READONLY}, then the file
455 will become unwritable either by you or anyone else on the system.
456 If you set the permission to @subcmd{WRITEABLE}, then the file becomes
457 writeable by you; the permissions afforded to others are unchanged.
458 This command cannot be used if the @subcmd{SAFER} (@pxref{SET})
459 setting is active.
460
461
462 @node PRESERVE and RESTORE
463 @section PRESERVE and RESTORE
464 @vindex PRESERVE
465 @vindex RESTORE
466
467 @display
468 PRESERVE.
469 @dots{}
470 RESTORE.
471 @end display
472
473 @cmd{PRESERVE} saves all of the settings that @cmd{SET} (@pxref{SET})
474 can adjust.  A later @cmd{RESTORE} command restores those settings.
475
476 @cmd{PRESERVE} can be nested up to five levels deep.
477
478 @node SET
479 @section SET
480 @vindex SET
481
482 @display
483 SET
484
485 (data input)
486         /BLANKS=@{SYSMIS,'.',number@}
487         /DECIMAL=@{DOT,COMMA@}
488         /FORMAT=@var{fmt_spec}
489         /EPOCH=@{AUTOMATIC,@var{year}@}
490         /RIB=@{NATIVE,MSBFIRST,LSBFIRST,VAX@}
491         /RRB=@{NATIVE,ISL,ISB,IDL,IDB,VF,VD,VG,ZS,ZL@}
492
493 (interaction)
494         /MXERRS=@var{max_errs}
495         /MXWARNS=@var{max_warnings}
496         /WORKSPACE=@var{workspace_size}
497
498 (syntax execution)
499         /LOCALE='@var{locale}'
500         /MXLOOPS=@var{max_loops}
501         /SEED=@{RANDOM,@var{seed_value}@}
502         /UNDEFINED=@{WARN,NOWARN@}
503         /FUZZBITS=@var{fuzzbits}
504
505 (data output)
506         /CC@{A,B,C,D,E@}=@{'@var{npre},@var{pre},@var{suf},@var{nsuf}','@var{npre}.@var{pre}.@var{suf}.@var{nsuf}'@}
507         /DECIMAL=@{DOT,COMMA@}
508         /FORMAT=@var{fmt_spec}
509         /LEADZERO=@{ON,OFF@}
510         /MDISPLAY=@{TEXT,TABLES@}
511         /SMALL=@var{number}
512         /WIB=@{NATIVE,MSBFIRST,LSBFIRST,VAX@}
513         /WRB=@{NATIVE,ISL,ISB,IDL,IDB,VF,VD,VG,ZS,ZL@}
514
515 (output routing)
516         /ERRORS=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
517         /MESSAGES=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
518         /PRINTBACK=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
519         /RESULTS=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
520
521 (output driver options)
522         /HEADERS=@{NO,YES,BLANK@}
523         /LENGTH=@{NONE,@var{n_lines}@}
524         /WIDTH=@{NARROW,WIDTH,@var{n_characters}@}
525         /TNUMBERS=@{VALUES,LABELS,BOTH@}
526         /TVARS=@{NAMES,LABELS,BOTH@}
527         /TLOOK=@{NONE,@var{file}@}
528
529 (logging)
530         /JOURNAL=@{ON,OFF@} ['@var{file_name}']
531
532 (system files)
533         /SCOMPRESSION=@{ON,OFF@}
534
535 (miscellaneous)
536         /SAFER=ON
537         /LOCALE='@var{string}'
538
539 (macros)
540         /MEXPAND=@{ON,OFF@}
541         /MPRINT=@{ON,OFF@}
542         /MITERATE=@var{number}
543         /MNEST=@var{number}
544
545 (settings not yet implemented, but accepted and ignored)
546         /BASETEXTDIRECTION=@{AUTOMATIC,RIGHTTOLEFT,LEFTTORIGHT@}
547         /BLOCK='@var{c}'
548         /BOX=@{'@var{xxx}','@var{xxxxxxxxxxx}'@}
549         /CACHE=@{ON,OFF@}
550         /CELLSBREAK=@var{number}
551         /COMPRESSION=@{ON,OFF@}
552         /CMPTRANS=@{ON,OFF@}
553         /HEADER=@{NO,YES,BLANK@}
554 @end display
555
556 @cmd{SET} allows the user to adjust several parameters relating to
557 @pspp{}'s execution.  Since there are many subcommands to this command, its
558 subcommands are examined in groups.
559
560 For subcommands that take boolean values, @subcmd{ON} and @subcmd{YES} are synonymous,
561 as are @subcmd{OFF} and @subcmd{NO}, when used as subcommand values.
562
563 The data input subcommands affect the way that data is read from data
564 files.  The data input subcommands are
565
566 @table @asis
567 @item BLANKS
568 @anchor{SET BLANKS}
569 This is the value assigned to an item data item that is empty or
570 contains only white space.  An argument of SYSMIS or '.'  causes the
571 system-missing value to be assigned to null items.  This is the
572 default.  Any real value may be assigned.
573
574 @item DECIMAL
575 @anchor{SET DECIMAL}
576 This value may be set to @subcmd{DOT} or @subcmd{COMMA}.
577 Setting it to @subcmd{DOT} causes the decimal point character to be
578 @samp{.} and the grouping character to be @samp{,}.
579 Setting it to @subcmd{COMMA}
580 causes the decimal point character to be @samp{,} and the grouping
581 character to be @samp{.}.
582 If the setting is @subcmd{COMMA}, then @samp{,} is not treated
583 as a field separator in the @cmd{DATA LIST} command (@pxref{DATA LIST}).
584 The default value is determined from the system locale.
585
586 @item FORMAT
587 @anchor{SET FORMAT}
588 Allows the default numeric input/output format to be specified.  The
589 default is F8.2.  @xref{Input and Output Formats}.
590
591 @item EPOCH
592 @anchor{SET EPOCH}
593 Specifies the range of years used when a 2-digit year is read from a
594 data file or used in a date construction expression (@pxref{Date
595 Construction}).  If a 4-digit year is specified for the epoch, then
596 2-digit years are interpreted starting from that year, known as the
597 epoch.  If @subcmd{AUTOMATIC} (the default) is specified, then the epoch begins
598 69 years before the current date.
599
600 @item RIB
601 @anchor{SET RIB}
602
603 @pspp{} extension to set the byte ordering (endianness) used for reading
604 data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric
605 Formats}).  In @subcmd{MSBFIRST} ordering, the most-significant byte appears at
606 the left end of a IB or PIB field.  In @subcmd{LSBFIRST} ordering, the
607 least-significant byte appears at the left end.  @subcmd{VAX} ordering is like
608 @subcmd{MSBFIRST}, except that each pair of bytes is in reverse order.  @subcmd{NATIVE},
609 the default, is equivalent to @subcmd{MSBFIRST} or @subcmd{LSBFIRST} depending on the
610 native format of the machine running @pspp{}.
611
612 @item RRB
613 @anchor{SET RRB}
614
615 @pspp{} extension to set the floating-point format used for reading data in
616 RB format (@pxref{Binary and Hexadecimal Numeric Formats}).  The
617 possibilities are:
618
619 @table @asis
620 @item NATIVE
621 The native format of the machine running @pspp{}.  Equivalent to either IDL
622 or IDB.
623
624 @item ISL
625 32-bit IEEE 754 single-precision floating point, in little-endian byte
626 order.
627
628 @item ISB
629 32-bit IEEE 754 single-precision floating point, in big-endian byte
630 order.
631
632 @item IDL
633 64-bit IEEE 754 double-precision floating point, in little-endian byte
634 order.
635
636 @item IDB
637 64-bit IEEE 754 double-precision floating point, in big-endian byte
638 order.
639
640 @item VF
641 32-bit VAX F format, in VAX-endian byte order.
642
643 @item VD
644 64-bit VAX D format, in VAX-endian byte order.
645
646 @item VG
647 64-bit VAX G format, in VAX-endian byte order.
648
649 @item ZS
650 32-bit IBM Z architecture short format hexadecimal floating point, in
651 big-endian byte order.
652
653 @item ZL
654 64-bit IBM Z architecture long format hexadecimal floating point, in
655 big-endian byte order.
656
657 Z architecture also supports IEEE 754 floating point.  The ZS and ZL
658 formats are only for use with very old input files.
659 @end table
660 The default is NATIVE.
661 @end table
662
663 Interaction subcommands affect the way that @pspp{} interacts with an
664 online user.  The interaction subcommands are
665
666 @table @asis
667 @item MXERRS
668 The maximum number of errors before @pspp{} halts processing of the current
669 command file.  The default is 50.
670
671 @item MXWARNS
672 The maximum number of warnings + errors before @pspp{} halts processing the
673 current command file.
674 The special value of zero means that all warning situations should be ignored.
675 No warnings are issued, except a single initial warning advising you
676 that warnings will not be given.
677 The default value is 100.
678 @end table
679
680 Syntax execution subcommands control the way that @pspp{} commands
681 execute.  The syntax execution subcommands are
682
683 @table @asis
684 @item LOCALE
685 Overrides the system locale for the purpose of reading and writing
686 syntax and data files.  The argument should be a locale name in the
687 general form @code{@var{language}_@var{country}.@var{encoding}}, where @var{language}
688 and @var{country} are 2-character language and country abbreviations,
689 respectively, and @var{encoding} is an @acronym{IANA} character set name.
690 Example locales are @code{en_US.UTF-8} (UTF-8 encoded English as
691 spoken in the United States) and @code{ja_JP.EUC-JP} (EUC-JP encoded
692 Japanese as spoken in Japan).
693
694 @item MXLOOPS
695 @anchor{SET MXLOOPS}
696
697 The maximum number of iterations for an uncontrolled loop
698 (@pxref{LOOP}), and for any loop in the matrix language (@pxref{Matrix
699 LOOP and BREAK Commands}).  The default @var{max_loops} is 40.
700
701 @item SEED
702 @anchor{SET SEED}
703 The initial pseudo-random number seed.  Set it to a real number or to
704 RANDOM, to obtain an initial seed from the current time of day.
705
706 @item UNDEFINED
707 Currently not used.
708
709 @item FUZZBITS
710 @anchor{SET FUZZBITS}
711 The maximum number of bits of errors in the least-significant places
712 to accept for rounding up a value that is almost halfway between two
713 possibilities for rounding with the RND operator (@pxref{Miscellaneous
714 Mathematics}).  The default @var{fuzzbits} is 6.
715
716 @item WORKSPACE
717 The maximum amount of memory (in kilobytes) that @pspp{} uses to
718 store data being processed.  If memory in excess of the workspace size
719 is required, then @pspp{} starts to use temporary files to store
720 the data.   Setting a higher value means that procedures
721 run faster, but may cause other applications to run slower.
722 On platforms without virtual memory management, setting a very large
723 workspace may cause @pspp{} to abort.
724 @cindex workspace
725 @cindex memory, amount used to store cases
726 @end table
727
728 Data output subcommands affect the format of output data.  These
729 subcommands are
730
731 @table @asis
732 @item CCA
733 @itemx CCB
734 @itemx CCC
735 @itemx CCD
736 @itemx CCE
737 @anchor{CCx Settings}
738
739 Set up custom currency formats.  @xref{Custom Currency Formats}, for
740 details.
741
742 @item DECIMAL
743 The default @subcmd{DOT} setting causes the decimal point character to be
744 @samp{.}.  A setting of @subcmd{COMMA} causes the decimal point character to be
745 @samp{,}.
746
747 @item FORMAT
748 Allows the default numeric input/output format to be specified.  The
749 default is F8.2.  @xref{Input and Output Formats}.
750
751 @item LEADZERO
752 @anchor{SET LEADZERO}
753
754 Controls whether numbers with magnitude less than one are displayed
755 with a zero before the decimal point.  For example, with @code{SET
756 LEADZERO=OFF}, which is the default, one-half is shown as 0.5, and
757 with @code{SET LEADZERO=ON}, it is shown as .5.  This setting affects
758 only the @code{F}, @code{COMMA}, and @code{DOT} formats.
759
760 @item MDISPLAY
761 @anchor{SET MDISPLAY}
762
763 Controls how the @code{PRINT} command within
764 @code{MATRIX}@dots{}@code{END MATRIX} outputs matrices.  With the
765 default @subcmd{TEXT}, @code{PRINT} outputs matrices as text.  Change
766 this setting to @code{TABLES} to instead output matrices as pivot
767 tables.  @xref{Matrix PRINT Command}, for more information.
768
769 @item SMALL
770 This controls how @pspp{} formats small numbers in pivot tables, in
771 cases where @pspp{} does not otherwise have a well-defined format for
772 the numbers.  When such a number has a magnitude less than the value
773 set here, @pspp{} formats the number in scientific notation;
774 otherwise, it formats it in standard notation.  The default is 0.0001.
775 Set a value of 0 to disable scientific notation.
776
777 @item WIB
778 @anchor{SET WIB}
779
780 @pspp{} extension to set the byte ordering (endianness) used for writing
781 data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric
782 Formats}).  In @subcmd{MSBFIRST} ordering, the most-significant byte appears at
783 the left end of a IB or PIB field.  In @subcmd{LSBFIRST} ordering, the
784 least-significant byte appears at the left end.  @subcmd{VAX} ordering is like
785 @subcmd{MSBFIRST}, except that each pair of bytes is in reverse order.  @subcmd{NATIVE},
786 the default, is equivalent to @subcmd{MSBFIRST} or @subcmd{LSBFIRST} depending on the
787 native format of the machine running @pspp{}.
788
789 @item WRB
790 @anchor{SET WRB}
791
792 @pspp{} extension to set the floating-point format used for writing data in
793 RB format (@pxref{Binary and Hexadecimal Numeric Formats}).  The choices
794 are the same as @subcmd{SET RIB}.  The default is @subcmd{NATIVE}.
795 @end table
796
797 In the @pspp{} text-based interface, the output routing subcommands
798 affect where output is sent.  The following values are allowed for
799 each of these subcommands:
800
801 @table @asis
802 @item OFF
803 @item NONE
804 Discard this kind of output.
805
806 @item TERMINAL
807 Write this output to the terminal, but not to listing files and other
808 output devices.
809
810 @item LISTING
811 Write this output to listing files and other output devices, but not
812 to the terminal.
813
814 @item ON
815 @itemx BOTH
816 Write this type of output to all output devices.
817 @end table
818
819 These output routing subcommands are:
820
821 @table @asis
822 @item ERRORS
823 Applies to error and warning messages.  The default is @subcmd{BOTH}.
824
825 @item MESSAGES
826 Applies to notes.  The default is @subcmd{BOTH}.
827
828 @item PRINTBACK
829 Determines whether the syntax used for input is printed back as part
830 of the output.  The default is @subcmd{NONE}.
831
832 @item RESULTS
833 Applies to everything not in one of the above categories, such as the
834 results of statistical procedures.  The default is @subcmd{BOTH}.
835 @end table
836
837 These subcommands have no effect on output in the @pspp{} GUI
838 environment.
839
840 Output driver option subcommands affect output drivers' settings.  These
841 subcommands are
842
843 @table @asis
844 @item HEADERS
845 @itemx LENGTH
846 @itemx WIDTH
847 @itemx TNUMBERS
848 The @subcmd{TNUMBERS} option sets the way in which values are displayed in output tables.
849 The valid settings are @subcmd{VALUES}, @subcmd{LABELS} and @subcmd{BOTH}.
850 If @subcmd{TNUMBERS} is set to @subcmd{VALUES}, then all values are displayed with their literal value
851 (which for a numeric value is a number and for a string value an alphanumeric string).
852 If @subcmd{TNUMBERS} is set to @subcmd{LABELS}, then values are displayed using their assigned labels if any.
853 (@xref{VALUE LABELS}.)
854 If the value has no label, then the literal value is used for display.
855 If @subcmd{TNUMBERS} is set to @subcmd{BOTH}, then values are displayed with both their label
856 (if any) and their literal value in parentheses.
857 @item TVARS
858 @anchor{SET TVARS}
859 The @subcmd{TVARS} option sets the way in which variables are displayed in output tables.
860 The valid settings are @subcmd{NAMES}, @subcmd{LABELS} and @subcmd{BOTH}.
861 If @subcmd{TVARS} is set to @subcmd{NAMES}, then all variables are displayed using their names.
862 If @subcmd{TVARS} is set to @subcmd{LABELS}, then variables are displayed using their label if one
863 has been set.  If no label has been set, then the name is used.
864 (@xref{VARIABLE LABELS}.)
865 If @subcmd{TVARS} is set to @subcmd{BOTH}, then variables are displayed with both their label
866 (if any) and their name in parentheses.
867 @item TLOOK
868 The @subcmd{TLOOK} option sets the style used for subsequent table
869 output.  Specifying @subcmd{NONE} makes @pspp{} use the default
870 built-in style.  Otherwise, specifying @var{file} makes @pspp{} search
871 for an @file{.stt} or @file{.tlo} file in the same way as specifying
872 @option{--table-look=@var{file}} the @pspp{} command line (@pxref{Main
873 Options}).
874 @end table
875
876 @cindex headers
877 @cindex length
878 @cindex pager
879 @cindex width
880 @cindex tnumbers
881
882
883 Logging subcommands affect logging of commands executed to external
884 files.  These subcommands are
885
886 @table @asis
887 @item JOURNAL
888 @itemx LOG
889 These subcommands, which are synonyms, control the journal.  The
890 default is @subcmd{ON}, which causes commands entered interactively to be
891 written to the journal file.  Commands included from syntax files that
892 are included interactively and error messages printed by @pspp{} are also
893 written to the journal file, prefixed by @samp{>}.  @subcmd{OFF} disables use
894 of the journal.
895
896 The journal is named @file{pspp.jnl} by default.  A different name may
897 be specified.
898 @end table
899
900 System file subcommands affect the default format of system files
901 produced by @pspp{}.  These subcommands are
902
903 @table @asis
904 @item SCOMPRESSION
905 Whether system files created by @cmd{SAVE} or @cmd{XSAVE} are
906 compressed by default.  The default is @subcmd{ON}.
907 @end table
908
909 Security subcommands affect the operations that commands are allowed to
910 perform.  The security subcommands are
911
912 @table @asis
913 @item SAFER
914 Setting this option disables the following operations:
915
916 @itemize @bullet
917 @item
918 The @cmd{ERASE} command.
919 @item
920 The @cmd{HOST} command.
921 @item
922 The @cmd{PERMISSIONS} command.
923 @item
924 Pipes (file names beginning or ending with @samp{|}).
925 @end itemize
926
927 Be aware that this setting does not guarantee safety (commands can still
928 overwrite files, for instance) but it is an improvement.
929 When set, this setting cannot be reset during the same session, for
930 obvious security reasons.
931
932 @item LOCALE
933 @cindex locale
934 @cindex encoding, characters
935 This item is used to set the default character encoding.
936 The encoding may be specified either as an encoding name or alias
937 (see @url{http://www.iana.org/assignments/character-sets}), or
938 as a locale name.
939 If given as a locale name, only the character encoding of the
940 locale is relevant.
941
942 System files written by @pspp{} use this encoding.
943 System files read by @pspp{}, for which the encoding is unknown, are
944 interpreted using this encoding.
945
946 The full list of valid encodings and locale names/alias are operating system
947 dependent.
948 The following are all examples of acceptable syntax on common GNU/Linux
949 systems.
950 @example
951 SET LOCALE='iso-8859-1'.
952
953 SET LOCALE='ru_RU.cp1251'.
954
955 SET LOCALE='japanese'.
956 @end example
957
958 Contrary to intuition, this command does not affect any aspect
959 of the system's locale.
960 @end table
961
962 The following subcommands affect the interpretation of macros.
963
964 @table @asis
965 @item MEXPAND
966 @anchor{SET MEXPAND}
967 Controls whether macros are expanded.  The default is ON.
968
969 @item MPRINT
970 @anchor{SET MPRINT}
971 Controls whether the expansion of macros is included in output.  This
972 is separate from whether command syntax in general is included in
973 output.  The default is OFF.
974
975 @item MITERATE
976 @anchor{SET MITERATE}
977 Limits the number of iterations executed in @code{!DO} loops within
978 macros.  This does not affect other language constructs such as
979 @cmd{LOOP}.  This must be set to a positive integer.  The default is
980 1000.
981
982 @item MNEST
983 @anchor{SET MNEST}
984 Limits the number of levels of nested macro expansions.  This must be
985 set to a positive integer.  The default is 50.
986 @end table
987
988 The following subcommands are not yet implemented, but PSPP accepts
989 them and ignores the settings.
990
991 @table @asis
992 @item BASETEXTDIRECTION
993 @itemx BLOCK
994 @itemx BOX
995 @itemx CACHE
996 @itemx CELLSBREAK
997 @itemx COMPRESSION
998 @itemx CMPTRANS
999 @itemx HEADER
1000 @end table
1001
1002 @node SHOW
1003 @section SHOW
1004 @vindex SHOW
1005
1006 @display
1007 SHOW
1008         [ALL]
1009         [BLANKS]
1010         [CC]
1011         [CCA]
1012         [CCB]
1013         [CCC]
1014         [CCD]
1015         [CCE]
1016         [COPYING]
1017         [DECIMALS]
1018         [DIRECTORY]
1019         [ENVIRONMENT]
1020         [FORMAT]
1021         [FUZZBITS]
1022         [LENGTH]
1023         [MEXPAND]
1024         [MPRINT]
1025         [MITERATE]
1026         [MNEST]
1027         [MXERRS]
1028         [MXLOOPS]
1029         [MXWARNS]
1030         [N]
1031         [SCOMPRESSION]
1032         [SYSTEM]
1033         [TEMPDIR]
1034         [UNDEFINED]
1035         [VERSION]
1036         [WARRANTY]
1037         [WEIGHT]
1038         [WIDTH]
1039 @end display
1040
1041 @cmd{SHOW} can be used to display the current state of @pspp{}'s execution
1042 parameters.  Parameters that can be changed using @cmd{SET}
1043 (@pxref{SET}), can be examined using @cmd{SHOW} using the subcommand
1044 with the same name.  @cmd{SHOW} supports the following additional
1045 subcommands:
1046
1047 @table @asis
1048 @item @subcmd{ALL}
1049 Show all settings.
1050 @item @subcmd{CC}
1051 Show all custom currency settings (@subcmd{CCA} through @subcmd{CCE}).
1052 @item @subcmd{DIRECTORY}
1053 Shows the current working directory.
1054 @item @subcmd{ENVIRONMENT}
1055 Shows the operating system details.
1056 @item @subcmd{N}
1057 Reports the number of cases in the active dataset.  The reported number is not
1058 weighted.  If no dataset is defined, then @samp{Unknown} is reported.
1059 @item @subcmd{SYSTEM}
1060 Shows information about how PSPP was built.  This information is
1061 useful in bug reports.  @xref{Bugs}, for details.
1062 @item @subcmd{TEMPDIR}
1063 Shows the path of the directory where temporary files are stored.
1064 @item @subcmd{VERSION}
1065 Shows the version of this installation of @pspp{}.
1066 @item @subcmd{WARRANTY}
1067 Show details of the lack of warranty for @pspp{}.
1068 @item @subcmd{COPYING} / @subcmd{LICENSE}
1069 Display the terms of @pspp{}'s copyright licence (@pxref{License}).
1070 @end table
1071
1072 Specifying @cmd{SHOW} without any subcommands is equivalent to @subcmd{SHOW ALL}.
1073
1074 @node SUBTITLE
1075 @section SUBTITLE
1076 @vindex SUBTITLE
1077
1078 @display
1079 SUBTITLE '@var{subtitle_string}'.
1080   or
1081 SUBTITLE @var{subtitle_string}.
1082 @end display
1083
1084 @cmd{SUBTITLE} provides a subtitle to a particular @pspp{}
1085 run.  This subtitle appears at the top of each output page below the
1086 title, if headers are enabled on the output device.
1087
1088 Specify a subtitle as a string in quotes.  The alternate syntax that did
1089 not require quotes is now obsolete.  If it is used then the subtitle is
1090 converted to all uppercase.
1091
1092 @node TITLE
1093 @section TITLE
1094 @vindex TITLE
1095
1096 @display
1097 TITLE '@var{title_string}'.
1098   or
1099 TITLE @var{title_string}.
1100 @end display
1101
1102 @cmd{TITLE} provides a title to a particular @pspp{} run.
1103 This title appears at the top of each output page, if headers are enabled
1104 on the output device.
1105
1106 Specify a title as a string in quotes.  The alternate syntax that did
1107 not require quotes is now obsolete.  If it is used then the title is
1108 converted to all uppercase.