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".
13 Commands that don't fit any other category are placed here.
15 Most of these commands are not affected by commands like @cmd{IF} and
17 they take effect only once, unconditionally, at the time that they are
18 encountered in the input.
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.
52 'line one' 'line two' @dots{} 'last line' .
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
62 Each line of documentary text must be enclosed in quotation marks, and
63 may not be more than 80 bytes long. @xref{DOCUMENT}.
73 This command is accepted, for compatibility, but it has no effect.
79 @cindex changing directory
85 @cmd{CD} changes the current directory. The new directory becomes
86 that specified by the command.
95 COMMENT comment text @dots{} .
96 *comment text @dots{} .
98 Comments within a line of syntax:
99 FREQUENCIES /VARIABLES=v0 v1 v2. /* All our categorical variables.
102 @cmd{COMMENT} is ignored. It is used to provide information to
103 the author and other readers of the @pspp{} syntax file.
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
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.
119 DOCUMENT @var{documentary_text}.
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
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}.
136 @node DISPLAY DOCUMENTS
137 @section DISPLAY DOCUMENTS
138 @vindex DISPLAY DOCUMENTS
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}.
148 @node DISPLAY FILE LABEL
149 @section DISPLAY FILE LABEL
150 @vindex DISPLAY FILE LABEL
156 @cmd{DISPLAY FILE LABEL} displays the file label contained in the
158 if any. @xref{FILE LABEL}.
160 This command is a @pspp{} extension.
163 @section DROP DOCUMENTS
164 @vindex DROP DOCUMENTS
170 @cmd{DROP DOCUMENTS} removes all documents from the active dataset.
171 New documents can be added with @cmd{DOCUMENT} (@pxref{DOCUMENT}).
173 @cmd{DROP DOCUMENTS} changes only the active dataset. It does not modify any
174 system files stored on disk.
181 ECHO 'arbitrary text' .
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}).
191 ERASE FILE @var{file_name}.
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.
207 @cmd{EXECUTE} causes the active dataset to be read and all pending
208 transformations to be executed.
215 FILE LABEL @var{file_label}.
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.
222 @var{file_label} should not be quoted.
223 If quotes are included, they are literally interpreted and become part of the file label.
233 @cmd{FINISH} terminates the current @pspp{} session and returns
234 control to the operating system.
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
245 HOST COMMAND=['@var{command}'...]
246 TIMELIMIT=@var{secs}.
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.
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
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
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.
272 HOST COMMAND=['rsync remote:data.txt data.txt > rsync-log.txt'
273 'sha512sum -c data.txt.sha512sum].
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.
280 PSPP built for mingw does not support all the features of
283 PSPP rejects this command if the SAFER (@pxref{SET}) setting is
291 INCLUDE [FILE=]'@var{file_name}' [ENCODING='@var{encoding}'].
294 @cmd{INCLUDE} causes the @pspp{} command processor to read an
295 additional command file as if it were included bodily in the current
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
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.
306 The optional @subcmd{ENCODING} subcommand has the same meaning as with @cmd{INSERT}.
313 INSERT [FILE=]'@var{file_name}'
315 [ERROR=@{CONTINUE,STOP@}]
316 [SYNTAX=@{BATCH,INTERACTIVE@}]
317 [ENCODING=@{LOCALE, '@var{charset_name}'@}].
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.
325 If @subcmd{CD=YES} is specified, then before including the file, the
326 current directory becomes the directory of the included
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.
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}.
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}.
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
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
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.
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}.
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.
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}.
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}.
389 @cindex precision, of output
390 @cindex decimal places
395 /TABLECELLS SELECT = [ @var{class}... ]
396 FORMAT = @var{fmt_spec}.
398 @note{In the above synopsis the characters @samp{[} and @samp{]} are literals.
399 They must appear in the syntax to be interpreted.}
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.
405 After running this command, the default table appearance parameters
406 will have been modified and each new output table generated uses
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:
415 Residual values. Default: @t{F40.2}.
418 Correlations. Default: @t{F40.3}.
421 Percentages. Default: @t{PCT40.1}.
424 Significance of tests (p-values). Default: @t{F40.3}.
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
432 For most other numeric values that appear in tables, @code{SET FORMAT}
433 may be used to specify the format (@pxref{SET FORMAT}).
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.
443 @cindex changing file permissions
447 FILE='@var{file_name}'
448 /PERMISSIONS = @{READONLY,WRITEABLE@}.
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})
462 @node PRESERVE and RESTORE
463 @section PRESERVE and RESTORE
473 @cmd{PRESERVE} saves all of the settings that @cmd{SET} (@pxref{SET})
474 can adjust. A later @cmd{RESTORE} command restores those settings.
476 @cmd{PRESERVE} can be nested up to five levels deep.
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@}
494 /MXERRS=@var{max_errs}
495 /MXWARNS=@var{max_warnings}
496 /WORKSPACE=@var{workspace_size}
499 /LOCALE='@var{locale}'
500 /MXLOOPS=@var{max_loops}
501 /SEED=@{RANDOM,@var{seed_value}@}
502 /UNDEFINED=@{WARN,NOWARN@}
503 /FUZZBITS=@var{fuzzbits}
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}
510 /WIB=@{NATIVE,MSBFIRST,LSBFIRST,VAX@}
511 /WRB=@{NATIVE,ISL,ISB,IDL,IDB,VF,VD,VG,ZS,ZL@}
514 /ERRORS=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
515 /MESSAGES=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
516 /PRINTBACK=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
517 /RESULTS=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
519 (output driver options)
520 /HEADERS=@{NO,YES,BLANK@}
521 /LENGTH=@{NONE,@var{n_lines}@}
522 /WIDTH=@{NARROW,WIDTH,@var{n_characters}@}
523 /TNUMBERS=@{VALUES,LABELS,BOTH@}
524 /TVARS=@{NAMES,LABELS,BOTH@}
525 /TLOOK=@{NONE,@var{file}@}
528 /JOURNAL=@{ON,OFF@} ['@var{file_name}']
531 /SCOMPRESSION=@{ON,OFF@}
535 /LOCALE='@var{string}'
540 /MITERATE=@var{number}
543 (settings not yet implemented, but accepted and ignored)
544 /BASETEXTDIRECTION=@{AUTOMATIC,RIGHTTOLEFT,LEFTTORIGHT@}
546 /BOX=@{'@var{xxx}','@var{xxxxxxxxxxx}'@}
548 /CELLSBREAK=@var{number}
549 /COMPRESSION=@{ON,OFF@}
551 /HEADER=@{NO,YES,BLANK@}
554 @cmd{SET} allows the user to adjust several parameters relating to
555 @pspp{}'s execution. Since there are many subcommands to this command, its
556 subcommands are examined in groups.
558 For subcommands that take boolean values, @subcmd{ON} and @subcmd{YES} are synonymous,
559 as are @subcmd{OFF} and @subcmd{NO}, when used as subcommand values.
561 The data input subcommands affect the way that data is read from data
562 files. The data input subcommands are
567 This is the value assigned to an item data item that is empty or
568 contains only white space. An argument of SYSMIS or '.' causes the
569 system-missing value to be assigned to null items. This is the
570 default. Any real value may be assigned.
574 This value may be set to @subcmd{DOT} or @subcmd{COMMA}.
575 Setting it to @subcmd{DOT} causes the decimal point character to be
576 @samp{.} and the grouping character to be @samp{,}.
577 Setting it to @subcmd{COMMA}
578 causes the decimal point character to be @samp{,} and the grouping
579 character to be @samp{.}.
580 If the setting is @subcmd{COMMA}, then @samp{,} is not treated
581 as a field separator in the @cmd{DATA LIST} command (@pxref{DATA LIST}).
582 The default value is determined from the system locale.
586 Allows the default numeric input/output format to be specified. The
587 default is F8.2. @xref{Input and Output Formats}.
591 Specifies the range of years used when a 2-digit year is read from a
592 data file or used in a date construction expression (@pxref{Date
593 Construction}). If a 4-digit year is specified for the epoch, then
594 2-digit years are interpreted starting from that year, known as the
595 epoch. If @subcmd{AUTOMATIC} (the default) is specified, then the epoch begins
596 69 years before the current date.
601 @pspp{} extension to set the byte ordering (endianness) used for reading
602 data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric
603 Formats}). In @subcmd{MSBFIRST} ordering, the most-significant byte appears at
604 the left end of a IB or PIB field. In @subcmd{LSBFIRST} ordering, the
605 least-significant byte appears at the left end. @subcmd{VAX} ordering is like
606 @subcmd{MSBFIRST}, except that each pair of bytes is in reverse order. @subcmd{NATIVE},
607 the default, is equivalent to @subcmd{MSBFIRST} or @subcmd{LSBFIRST} depending on the
608 native format of the machine running @pspp{}.
613 @pspp{} extension to set the floating-point format used for reading data in
614 RB format (@pxref{Binary and Hexadecimal Numeric Formats}). The
619 The native format of the machine running @pspp{}. Equivalent to either IDL
623 32-bit IEEE 754 single-precision floating point, in little-endian byte
627 32-bit IEEE 754 single-precision floating point, in big-endian byte
631 64-bit IEEE 754 double-precision floating point, in little-endian byte
635 64-bit IEEE 754 double-precision floating point, in big-endian byte
639 32-bit VAX F format, in VAX-endian byte order.
642 64-bit VAX D format, in VAX-endian byte order.
645 64-bit VAX G format, in VAX-endian byte order.
648 32-bit IBM Z architecture short format hexadecimal floating point, in
649 big-endian byte order.
652 64-bit IBM Z architecture long format hexadecimal floating point, in
653 big-endian byte order.
655 Z architecture also supports IEEE 754 floating point. The ZS and ZL
656 formats are only for use with very old input files.
658 The default is NATIVE.
661 Interaction subcommands affect the way that @pspp{} interacts with an
662 online user. The interaction subcommands are
666 The maximum number of errors before @pspp{} halts processing of the current
667 command file. The default is 50.
670 The maximum number of warnings + errors before @pspp{} halts processing the
671 current command file.
672 The special value of zero means that all warning situations should be ignored.
673 No warnings are issued, except a single initial warning advising you
674 that warnings will not be given.
675 The default value is 100.
678 Syntax execution subcommands control the way that @pspp{} commands
679 execute. The syntax execution subcommands are
683 Overrides the system locale for the purpose of reading and writing
684 syntax and data files. The argument should be a locale name in the
685 general form @code{@var{language}_@var{country}.@var{encoding}}, where @var{language}
686 and @var{country} are 2-character language and country abbreviations,
687 respectively, and @var{encoding} is an @acronym{IANA} character set name.
688 Example locales are @code{en_US.UTF-8} (UTF-8 encoded English as
689 spoken in the United States) and @code{ja_JP.EUC-JP} (EUC-JP encoded
690 Japanese as spoken in Japan).
695 The maximum number of iterations for an uncontrolled loop (@pxref{LOOP}).
696 The default @var{max_loops} is 40.
699 The initial pseudo-random number seed. Set it to a real number or to
700 RANDOM, to obtain an initial seed from the current time of day.
706 @anchor{SET FUZZBITS}
707 The maximum number of bits of errors in the least-significant places
708 to accept for rounding up a value that is almost halfway between two
709 possibilities for rounding with the RND operator (@pxref{Miscellaneous
710 Mathematics}). The default @var{fuzzbits} is 6.
713 The maximum amount of memory (in kilobytes) that @pspp{} uses to
714 store data being processed. If memory in excess of the workspace size
715 is required, then @pspp{} starts to use temporary files to store
716 the data. Setting a higher value means that procedures
717 run faster, but may cause other applications to run slower.
718 On platforms without virtual memory management, setting a very large
719 workspace may cause @pspp{} to abort.
721 @cindex memory, amount used to store cases
724 Data output subcommands affect the format of output data. These
733 @anchor{CCx Settings}
735 Set up custom currency formats. @xref{Custom Currency Formats}, for
739 The default @subcmd{DOT} setting causes the decimal point character to be
740 @samp{.}. A setting of @subcmd{COMMA} causes the decimal point character to be
744 Allows the default numeric input/output format to be specified. The
745 default is F8.2. @xref{Input and Output Formats}.
748 This controls how @pspp{} formats small numbers in pivot tables, in
749 cases where @pspp{} does not otherwise have a well-defined format for
750 the numbers. When such a number has a magnitude less than the value
751 set here, @pspp{} formats the number in scientific notation;
752 otherwise, it formats it in standard notation. The default is 0.0001.
753 Set a value of 0 to disable scientific notation.
758 @pspp{} extension to set the byte ordering (endianness) used for writing
759 data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric
760 Formats}). In @subcmd{MSBFIRST} ordering, the most-significant byte appears at
761 the left end of a IB or PIB field. In @subcmd{LSBFIRST} ordering, the
762 least-significant byte appears at the left end. @subcmd{VAX} ordering is like
763 @subcmd{MSBFIRST}, except that each pair of bytes is in reverse order. @subcmd{NATIVE},
764 the default, is equivalent to @subcmd{MSBFIRST} or @subcmd{LSBFIRST} depending on the
765 native format of the machine running @pspp{}.
770 @pspp{} extension to set the floating-point format used for writing data in
771 RB format (@pxref{Binary and Hexadecimal Numeric Formats}). The choices
772 are the same as @subcmd{SET RIB}. The default is @subcmd{NATIVE}.
775 In the @pspp{} text-based interface, the output routing subcommands
776 affect where output is sent. The following values are allowed for
777 each of these subcommands:
782 Discard this kind of output.
785 Write this output to the terminal, but not to listing files and other
789 Write this output to listing files and other output devices, but not
794 Write this type of output to all output devices.
797 These output routing subcommands are:
801 Applies to error and warning messages. The default is @subcmd{BOTH}.
804 Applies to notes. The default is @subcmd{BOTH}.
807 Determines whether the syntax used for input is printed back as part
808 of the output. The default is @subcmd{NONE}.
811 Applies to everything not in one of the above categories, such as the
812 results of statistical procedures. The default is @subcmd{BOTH}.
815 These subcommands have no effect on output in the @pspp{} GUI
818 Output driver option subcommands affect output drivers' settings. These
826 The @subcmd{TNUMBERS} option sets the way in which values are displayed in output tables.
827 The valid settings are @subcmd{VALUES}, @subcmd{LABELS} and @subcmd{BOTH}.
828 If @subcmd{TNUMBERS} is set to @subcmd{VALUES}, then all values are displayed with their literal value
829 (which for a numeric value is a number and for a string value an alphanumeric string).
830 If @subcmd{TNUMBERS} is set to @subcmd{LABELS}, then values are displayed using their assigned labels if any.
831 (@xref{VALUE LABELS}.)
832 If the value has no label, then the literal value is used for display.
833 If @subcmd{TNUMBERS} is set to @subcmd{BOTH}, then values are displayed with both their label
834 (if any) and their literal value in parentheses.
836 The @subcmd{TVARS} option sets the way in which variables are displayed in output tables.
837 The valid settings are @subcmd{NAMES}, @subcmd{LABELS} and @subcmd{BOTH}.
838 If @subcmd{TVARS} is set to @subcmd{NAMES}, then all variables are displayed using their names.
839 If @subcmd{TVARS} is set to @subcmd{LABELS}, then variables are displayed using their label if one
840 has been set. If no label has been set, then the name is used.
841 (@xref{VARIABLE LABELS}.)
842 If @subcmd{TVARS} is set to @subcmd{BOTH}, then variables are displayed with both their label
843 (if any) and their name in parentheses.
845 The @subcmd{TLOOK} option sets the style used for subsequent table
846 output. Specifying @subcmd{NONE} makes @pspp{} use the default
847 built-in style. Otherwise, specifying @var{file} makes @pspp{} search
848 for an @file{.stt} or @file{.tlo} file in the same way as specifying
849 @option{--table-look=@var{file}} the @pspp{} command line (@pxref{Main
860 Logging subcommands affect logging of commands executed to external
861 files. These subcommands are
866 These subcommands, which are synonyms, control the journal. The
867 default is @subcmd{ON}, which causes commands entered interactively to be
868 written to the journal file. Commands included from syntax files that
869 are included interactively and error messages printed by @pspp{} are also
870 written to the journal file, prefixed by @samp{>}. @subcmd{OFF} disables use
873 The journal is named @file{pspp.jnl} by default. A different name may
877 System file subcommands affect the default format of system files
878 produced by @pspp{}. These subcommands are
882 Whether system files created by @cmd{SAVE} or @cmd{XSAVE} are
883 compressed by default. The default is @subcmd{ON}.
886 Security subcommands affect the operations that commands are allowed to
887 perform. The security subcommands are
891 Setting this option disables the following operations:
895 The @cmd{ERASE} command.
897 The @cmd{HOST} command.
899 The @cmd{PERMISSIONS} command.
901 Pipes (file names beginning or ending with @samp{|}).
904 Be aware that this setting does not guarantee safety (commands can still
905 overwrite files, for instance) but it is an improvement.
906 When set, this setting cannot be reset during the same session, for
907 obvious security reasons.
911 @cindex encoding, characters
912 This item is used to set the default character encoding.
913 The encoding may be specified either as an encoding name or alias
914 (see @url{http://www.iana.org/assignments/character-sets}), or
916 If given as a locale name, only the character encoding of the
919 System files written by @pspp{} use this encoding.
920 System files read by @pspp{}, for which the encoding is unknown, are
921 interpreted using this encoding.
923 The full list of valid encodings and locale names/alias are operating system
925 The following are all examples of acceptable syntax on common GNU/Linux
928 SET LOCALE='iso-8859-1'.
930 SET LOCALE='ru_RU.cp1251'.
932 SET LOCALE='japanese'.
935 Contrary to intuition, this command does not affect any aspect
936 of the system's locale.
939 The following subcommands affect the interpretation of macros.
944 Controls whether macros are expanded. The default is ON.
948 Controls whether the expansion of macros is included in output. This
949 is separate from whether command syntax in general is included in
950 output. The default is OFF.
953 @anchor{SET MITERATE}
954 Limits the number of iterations executed in @code{!DO} loops within
955 macros. This does not affect other language constructs such as
956 @cmd{LOOP}. This must be set to a positive integer. The default is
961 Limits the number of levels of nested macro expansions. This must be
962 set to a positive integer. The default is 50.
965 The following subcommands are not yet implemented, but PSPP accepts
966 them and ignores the settings.
969 @item BASETEXTDIRECTION
1017 @cmd{SHOW} can be used to display the current state of @pspp{}'s execution
1018 parameters. Parameters that can be changed using @cmd{SET}
1019 (@pxref{SET}), can be examined using @cmd{SHOW} using the subcommand
1020 with the same name. @cmd{SHOW} supports the following additional
1027 Show all custom currency settings (@subcmd{CCA} through @subcmd{CCE}).
1028 @item @subcmd{DIRECTORY}
1029 Shows the current working directory.
1030 @item @subcmd{ENVIRONMENT}
1031 Shows the operating system details.
1033 Reports the number of cases in the active dataset. The reported number is not
1034 weighted. If no dataset is defined, then @samp{Unknown} is reported.
1035 @item @subcmd{TEMPDIR}
1036 Shows the path of the directory where temporary files are stored.
1037 @item @subcmd{VERSION}
1038 Shows the version of this installation of @pspp{}.
1039 @item @subcmd{WARRANTY}
1040 Show details of the lack of warranty for @pspp{}.
1041 @item @subcmd{COPYING} / @subcmd{LICENSE}
1042 Display the terms of @pspp{}'s copyright licence (@pxref{License}).
1045 Specifying @cmd{SHOW} without any subcommands is equivalent to @subcmd{SHOW ALL}.
1052 SUBTITLE '@var{subtitle_string}'.
1054 SUBTITLE @var{subtitle_string}.
1057 @cmd{SUBTITLE} provides a subtitle to a particular @pspp{}
1058 run. This subtitle appears at the top of each output page below the
1059 title, if headers are enabled on the output device.
1061 Specify a subtitle as a string in quotes. The alternate syntax that did
1062 not require quotes is now obsolete. If it is used then the subtitle is
1063 converted to all uppercase.
1070 TITLE '@var{title_string}'.
1072 TITLE @var{title_string}.
1075 @cmd{TITLE} provides a title to a particular @pspp{} run.
1076 This title appears at the top of each output page, if headers are enabled
1077 on the output device.
1079 Specify a title as a string in quotes. The alternate syntax that did
1080 not require quotes is now obsolete. If it is used then the title is
1081 converted to all uppercase.