doc/utilities.texi

   1 @node Utilities
   2 @chapter Utilities
   3
   4 Commands that don't fit any other category are placed here.
   5
   6 Most of these commands are not affected by commands like @cmd{IF} and
   7 @cmd{LOOP}:
   8 they take effect only once, unconditionally, at the time that they are
   9 encountered in the input.
  10
  11 @menu
  12 * ADD DOCUMENT::                Add documentary text to the active file.
  13 * CD::                          Change the current directory.
  14 * COMMENT::                     Document your syntax file.
  15 * DOCUMENT::                    Document the active file.
  16 * DISPLAY DOCUMENTS::           Display active file documents.
  17 * DISPLAY FILE LABEL::          Display the active file label.
  18 * DROP DOCUMENTS::              Remove documents from the active file.
  19 * ECHO::                        Write a string to the output stream.
  20 * ERASE::                       Erase a file.
  21 * EXECUTE::                     Execute pending transformations.
  22 * FILE LABEL::                  Set the active file's label.
  23 * FINISH::                      Terminate the PSPP session.
  24 * HOST::                        Temporarily return to the operating system.
  25 * INCLUDE::                     Include a file within the current one.
  26 * INSERT::                      Insert a file within the current one.
  27 * PERMISSIONS::                 Change permissions on a file.
  28 * SET::                         Adjust PSPP runtime parameters.
  29 * SHOW::                        Display runtime parameters.
  30 * SUBTITLE::                    Provide a document subtitle.
  31 * TITLE::                       Provide a document title.
  32 @end menu
  33
  34 @node ADD DOCUMENT
  35 @comment  node-name,  next,  previous,  up
  36 @section ADD DOCUMENT
  37 @vindex  ADD DOCUMENT
  38
  39 @display
  40 ADD DOCUMENT
  41     'line one' 'line two' @dots{} 'last line' .
  42 @end display
  43
  44
  45 @cmd{ADD DOCUMENT} adds one or more lines of descriptive commentary to
  46 the active file.  Documents added in this way are saved to system files.
  47 They can be viewed using @cmd{SYSFILE INFO} or @cmd{DISPLAY
  48 DOCUMENTS}.  They can be removed from the active file with @cmd{DROP
  49 DOCUMENTS}.
  50
  51 Each line of documentary text must be enclosed in quotation marks, and
  52 may not be more than 80 bytes long. @xref{DOCUMENT}.
  53
  54 @node CD
  55 @section CD
  56 @vindex CD
  57 @cindex directory
  58 @cindex changing directory
  59
  60 @display
  61 CD 'new directory' .
  62 @end display
  63
  64 @cmd{CD} changes the current directory.  The new directory will become that specified by the command.
  65
  66 @node COMMENT
  67 @section COMMENT
  68 @vindex COMMENT
  69 @vindex *
  70
  71 @display
  72 Two possibles syntaxes:
  73         COMMENT comment text @dots{} .
  74         *comment text @dots{} .
  75 @end display
  76
  77 @cmd{COMMENT} is ignored.  It is used to provide information to
  78 the author and other readers of the PSPP syntax file.
  79
  80 @cmd{COMMENT} can extend over any number of lines.  Don't forget to
  81 terminate it with a dot or a blank line.
  82
  83
  84
  85 @node DOCUMENT
  86 @section DOCUMENT
  87 @vindex DOCUMENT
  88
  89 @display
  90 DOCUMENT @var{documentary_text}.
  91 @end display
  92
  93 @cmd{DOCUMENT} adds one or more lines of descriptive commentary to the
  94 active file.  Documents added in this way are saved to system files.
  95 They can be viewed using @cmd{SYSFILE INFO} or @cmd{DISPLAY
  96 DOCUMENTS}.  They can be removed from the active file with @cmd{DROP
  97 DOCUMENTS}.
  98
  99 Specify the @var{documentary text} following the DOCUMENT keyword.
 100 It is interpreted literally --- any quotes or other punctuation marks
 101 will be included in the file.
 102 You can extend the documentary text over as many lines as necessary.
 103 Lines are truncated at 80 bytes.  Don't forget to terminate
 104 the command with a dot or a blank line. @xref{ADD DOCUMENT}.
 105
 106 @node DISPLAY DOCUMENTS
 107 @section DISPLAY DOCUMENTS
 108 @vindex DISPLAY DOCUMENTS
 109
 110 @display
 111 DISPLAY DOCUMENTS.
 112 @end display
 113
 114 @cmd{DISPLAY DOCUMENTS} displays the documents in the active file.  Each
 115 document is preceded by a line giving the time and date that it was
 116 added.  @xref{DOCUMENT}.
 117
 118 @node DISPLAY FILE LABEL
 119 @section DISPLAY FILE LABEL
 120 @vindex DISPLAY FILE LABEL
 121
 122 @display
 123 DISPLAY FILE LABEL.
 124 @end display
 125
 126 @cmd{DISPLAY FILE LABEL} displays the file label contained in the
 127 active file,
 128 if any.  @xref{FILE LABEL}.
 129
 130 This command is a PSPP extension.
 131
 132 @node DROP DOCUMENTS
 133 @section DROP DOCUMENTS
 134 @vindex DROP DOCUMENTS
 135
 136 @display
 137 DROP DOCUMENTS.
 138 @end display
 139
 140 @cmd{DROP DOCUMENTS} removes all documents from the active file.
 141 New documents can be added with @cmd{DOCUMENT} (@pxref{DOCUMENT}).
 142
 143 @cmd{DROP DOCUMENTS} changes only the active file.  It does not modify any
 144 system files stored on disk.
 145
 146 @node ECHO
 147 @section ECHO
 148 @vindex ECHO
 149
 150 @display
 151 ECHO 'arbitrary text' .
 152 @end display
 153
 154 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}).
 155
 156 @node ERASE
 157 @comment  node-name,  next,  previous,  up
 158 @section ERASE
 159 @vindex ERASE
 160
 161 @display
 162 ERASE FILE file_name.
 163 @end display
 164
 165 @cmd{ERASE FILE} deletes a file from the local filesystem.
 166 file_name must be quoted.
 167 This command cannot be used if the SAFER setting is active.
 168
 169
 170 @node EXECUTE
 171 @section EXECUTE
 172 @vindex EXECUTE
 173
 174 @display
 175 EXECUTE.
 176 @end display
 177
 178 @cmd{EXECUTE} causes the active file to be read and all pending
 179 transformations to be executed.
 180
 181 @node FILE LABEL
 182 @section FILE LABEL
 183 @vindex FILE LABEL
 184
 185 @display
 186 FILE LABEL file_label.
 187 @end display
 188
 189 @cmd{FILE LABEL} provides a title for the active file.  This
 190 title will be saved into system files and portable files that are
 191 created during this PSPP run.
 192
 193 file_label need not be quoted.  If quotes are
 194 included, they become part of the file label.
 195
 196 @node FINISH
 197 @section FINISH
 198 @vindex FINISH
 199
 200 @display
 201 FINISH.
 202 @end display
 203
 204 @cmd{FINISH} terminates the current PSPP session and returns
 205 control to the operating system.
 206
 207 @node HOST
 208 @comment  node-name,  next,  previous,  up
 209 @section HOST
 210 @vindex HOST
 211
 212 @display
 213 HOST.
 214 @end display
 215
 216 @cmd{HOST} suspends the current PSPP session and temporarily returns control
 217 to the operating system.
 218 This command cannot be used if the SAFER setting is active.
 219
 220
 221 @node INCLUDE
 222 @section INCLUDE
 223 @vindex INCLUDE
 224
 225 @display
 226         INCLUDE [FILE=]'file-name'.
 227 @end display
 228
 229 @cmd{INCLUDE} causes the PSPP command processor to read an
 230 additional command file as if it were included bodily in the current
 231 command file.
 232 If errors are encountered in the included file, then command processing will
 233 stop and no more commands will be processed.
 234 Include files may be nested to any depth, up to the limit of available
 235 memory.
 236
 237
 238 The @cmd{INSERT} command (@pxref{INSERT}) may be used instead of
 239 @cmd{INCLUDE} if you require more flexible options.
 240 The syntax
 241 @example
 242 INCLUDE FILE=@var{file-name}.
 243 @end example
 244 @noindent
 245 functions identically to
 246 @example
 247 INSERT FILE=@var{file-name} ERROR=STOP CD=NO SYNTAX=BATCH.
 248 @end example
 249
 250
 251 @node INSERT
 252 @section INSERT
 253 @vindex INSERT
 254
 255 @display
 256      INSERT [FILE=]'file-name'
 257         [CD=@{NO,YES@}]
 258         [ERROR=@{CONTINUE,STOP@}]
 259         [SYNTAX=@{BATCH,INTERACTIVE@}].
 260 @end display
 261
 262 @cmd{INSERT} is similar to @cmd{INCLUDE} (@pxref{INCLUDE})
 263 but somewhat more flexible.
 264 It causes the command processor to read a file as if it were embedded in the
 265 current command file.
 266
 267 If @samp{CD=YES} is specified, then before including the file, the
 268 current directory  will be changed to the directory of the included
 269 file.
 270 The default setting is @samp{CD=NO}.
 271 Note that this directory will remain current until it is
 272 changed explicitly (with the @cmd{CD} command, or a subsequent
 273 @cmd{INSERT} command with the @samp{CD=YES} option).
 274 It will not revert to its original setting even after the included
 275 file is finished processing.
 276
 277 If @samp{ERROR=STOP} is specified, errors encountered in the
 278 inserted file will cause processing to immediately cease.
 279 Otherwise processing will continue at the next command.
 280 The default setting is @samp{ERROR=CONTINUE}.
 281
 282 If @samp{SYNTAX=INTERACTIVE} is specified then the syntax contained in
 283 the included file must conform to interactive syntax
 284 conventions. @xref{Syntax Variants}.
 285 The default setting is @samp{SYNTAX=BATCH}.
 286
 287 @node PERMISSIONS
 288 @section PERMISSIONS
 289 @vindex PERMISSIONS
 290 @cindex mode
 291 @cindex file mode
 292 @cindex changing file permissions
 293
 294 @display
 295 PERMISSIONS
 296         FILE='file-name'
 297         /PERMISSIONS = @{READONLY,WRITEABLE@}.
 298 @end display
 299
 300 @cmd{PERMISSIONS} changes the permissions of a file.
 301 There is one mandatory subcommand which specifies the permissions to
 302 which the file should be changed.
 303 If you set a file's  permission  to READONLY, then the file will become
 304 unwritable either by you or anyone else on the system.
 305 If you set the permission to WRITEABLE, then the file will become
 306 writeable by you; the permissions afforded to others will be
 307 unchanged.
 308 This command cannot be used if the SAFER setting is active.
 309
 310
 311 @node SET
 312 @section SET
 313 @vindex SET
 314
 315 @display
 316 SET
 317
 318 (data input)
 319         /BLANKS=@{SYSMIS,'.',number@}
 320         /DECIMAL=@{DOT,COMMA@}
 321         /FORMAT=fmt_spec
 322         /EPOCH=@{AUTOMATIC,year@}
 323         /RIB=@{NATIVE,MSBFIRST,LSBFIRST,VAX@}
 324         /RRB=@{NATIVE,ISL,ISB,IDL,IDB,VF,VD,VG,ZS,ZL@}
 325
 326 (program input)
 327         /ENDCMD='.'
 328         /NULLINE=@{ON,OFF@}
 329
 330 (interaction)
 331         /CPROMPT='cprompt_string'
 332         /DPROMPT='dprompt_string'
 333         /ERRORBREAK=@{OFF,ON@}
 334         /MXERRS=max_errs
 335         /MXWARNS=max_warnings
 336         /PROMPT='prompt'
 337         /WORKSPACE=workspace_size
 338
 339 (program execution)
 340         /MEXPAND=@{ON,OFF@}
 341         /MITERATE=max_iterations
 342         /MNEST=max_nest
 343         /MPRINT=@{ON,OFF@}
 344         /MXLOOPS=max_loops
 345         /SEED=@{RANDOM,seed_value@}
 346         /UNDEFINED=@{WARN,NOWARN@}
 347
 348 (data output)
 349         /CC@{A,B,C,D,E@}=@{'npre,pre,suf,nsuf','npre.pre.suf.nsuf'@}
 350         /DECIMAL=@{DOT,COMMA@}
 351         /FORMAT=fmt_spec
 352         /WIB=@{NATIVE,MSBFIRST,LSBFIRST,VAX@}
 353         /WRB=@{NATIVE,ISL,ISB,IDL,IDB,VF,VD,VG,ZS,ZL@}
 354
 355 (output routing)
 356         /ECHO=@{ON,OFF@}
 357         /ERRORS=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
 358         /INCLUDE=@{ON,OFF@}
 359         /MESSAGES=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
 360         /PRINTBACK=@{ON,OFF@}
 361         /RESULTS=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
 362
 363 (output driver options)
 364         /HEADERS=@{NO,YES,BLANK@}
 365         /LENGTH=@{NONE,length_in_lines@}
 366         /LISTING=@{ON,OFF,'file-name'@}
 367         /MORE=@{ON,OFF@}
 368         /WIDTH=@{NARROW,WIDTH,n_characters@}
 369
 370 (logging)
 371         /JOURNAL=@{ON,OFF@} ['file-name']
 372
 373 (system files)
 374         /COMPRESSION=@{ON,OFF@}
 375         /SCOMPRESSION=@{ON,OFF@}
 376
 377 (security)
 378         /SAFER=ON
 379
 380 (obsolete settings accepted for compatibility, but ignored)
 381         /BOXSTRING=@{'xxx','xxxxxxxxxxx'@}
 382         /CASE=@{UPPER,UPLOW@}
 383         /CPI=cpi_value
 384         /DISK=@{ON,OFF@}
 385         /HIGHRES=@{ON,OFF@}
 386         /HISTOGRAM='c'
 387         /LOWRES=@{AUTO,ON,OFF@}
 388         /LPI=lpi_value
 389         /MENUS=@{STANDARD,EXTENDED@}
 390         /MXMEMORY=max_memory
 391         /SCRIPTTAB='c'
 392         /TB1=@{'xxx','xxxxxxxxxxx'@}
 393         /TBFONTS='string'
 394         /XSORT=@{YES,NO@}
 395 @end display
 396
 397 @cmd{SET} allows the user to adjust several parameters relating to
 398 PSPP's execution.  Since there are many subcommands to this command, its
 399 subcommands will be examined in groups.
 400
 401 On subcommands that take boolean values, ON and YES are synonym, and
 402 as are OFF and NO, when used as subcommand values.
 403
 404 The data input subcommands affect the way that data is read from data
 405 files.  The data input subcommands are
 406
 407 @table @asis
 408 @item BLANKS
 409 @anchor{SET BLANKS}
 410 This is the value assigned to an item data item that is empty or
 411 contains only white space.  An argument of SYSMIS or '.' will cause the
 412 system-missing value to be assigned to null items.  This is the
 413 default.  Any real value may be assigned.
 414
 415 @item DECIMAL
 416 @anchor{SET DECIMAL}
 417 The default DOT setting causes the decimal point character to be
 418 @samp{.} and the grouping character to be @samp{,}.  A setting of COMMA
 419 causes the decimal point character to be @samp{,} and the grouping
 420 character to be @samp{.}.
 421
 422 @item FORMAT
 423 Allows the default numeric input/output format to be specified.  The
 424 default is F8.2.  @xref{Input and Output Formats}.
 425
 426 @item EPOCH
 427 @anchor{SET EPOCH}
 428 Specifies the range of years used when a 2-digit year is read from a
 429 data file or used in a date construction expression (@pxref{Date
 430 Construction}).  If a 4-digit year is specified for the epoch, then
 431 2-digit years are interpreted starting from that year, known as the
 432 epoch.  If AUTOMATIC (the default) is specified, then the epoch begins
 433 69 years before the current date.
 434
 435 @item RIB
 436 @anchor{SET RIB}
 437
 438 PSPP extension to set the byte ordering (endianness) used for reading
 439 data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric
 440 Formats}).  In MSBFIRST ordering, the most-significant byte appears at
 441 the left end of a IB or PIB field.  In LSBFIRST ordering, the
 442 least-significant byte appears at the left end.  VAX ordering is like
 443 MSBFIRST, except that each pair of bytes is in reverse order.  NATIVE,
 444 the default, is equivalent to MSBFIRST or LSBFIRST depending on the
 445 native format of the machine running PSPP.
 446
 447 @item RRB
 448 @anchor{SET RRB}
 449
 450 PSPP extension to set the floating-point format used for reading data in
 451 RB format (@pxref{Binary and Hexadecimal Numeric Formats}).  The
 452 possibilities are:
 453
 454 @table @asis
 455 @item NATIVE
 456 The native format of the machine running PSPP.  Equivalent to either IDL
 457 or IDB.
 458
 459 @item ISL
 460 32-bit IEEE 754 single-precision floating point, in little-endian byte
 461 order.
 462
 463 @item ISB
 464 32-bit IEEE 754 single-precision floating point, in big-endian byte
 465 order.
 466
 467 @item IDL
 468 64-bit IEEE 754 double-precision floating point, in little-endian byte
 469 order.
 470
 471 @item IDB
 472 64-bit IEEE 754 double-precision floating point, in big-endian byte
 473 order.
 474
 475 @item VF
 476 32-bit VAX F format, in VAX-endian byte order.
 477
 478 @item VD
 479 64-bit VAX D format, in VAX-endian byte order.
 480
 481 @item VG
 482 64-bit VAX G format, in VAX-endian byte order.
 483
 484 @item ZS
 485 32-bit IBM Z architecture short format hexadecimal floating point, in
 486 big-endian byte order.
 487
 488 @item ZL
 489 64-bit IBM Z architecture long format hexadecimal floating point, in
 490 big-endian byte order.
 491
 492 Z architecture also supports IEEE 754 floating point.  The ZS and ZL
 493 formats are only for use with very old input files.
 494 @end table
 495 The default is NATIVE.
 496 @end table
 497
 498 Program input subcommands affect the way that programs are parsed when
 499 they are typed interactively or run from a command file.  They are
 500
 501 @table @asis
 502 @item ENDCMD
 503 This is a single character indicating the end of a command.  The default
 504 is @samp{.}.  Don't change this.
 505
 506 @item NULLINE
 507 Whether a blank line is interpreted as ending the current command.  The
 508 default is ON.
 509 @end table
 510
 511 Interaction subcommands affect the way that PSPP interacts with an
 512 online user.  The interaction subcommands are
 513
 514 @table @asis
 515 @item CPROMPT
 516 The command continuation prompt.  The default is @samp{    > }.
 517
 518 @item DPROMPT
 519 Prompt used when expecting data input within @cmd{BEGIN DATA} (@pxref{BEGIN
 520 DATA}).  The default is @samp{data> }.
 521
 522 @item ERRORBREAK
 523 Whether an error causes PSPP to stop processing the current command
 524 file after finishing the current command.  The default is OFF.
 525
 526 @item MXERRS
 527 The maximum number of errors before PSPP halts processing of the current
 528 command file.  The default is 50.
 529
 530 @item MXWARNS
 531 The maximum number of warnings + errors before PSPP halts processing the
 532 current command file.  The default is 100.
 533
 534 @item PROMPT
 535 The command prompt.  The default is @samp{PSPP> }.
 536 @end table
 537
 538 Program execution subcommands control the way that PSPP commands
 539 execute.  The program execution subcommands are
 540
 541 @table @asis
 542 @item MEXPAND
 543 @itemx MITERATE
 544 @itemx MNEST
 545 @itemx MPRINT
 546 Currently not used.
 547
 548 @item MXLOOPS
 549 The maximum number of iterations for an uncontrolled loop (@pxref{LOOP}).
 550
 551 @item SEED
 552 The initial pseudo-random number seed.  Set to a real number or to
 553 RANDOM, which will obtain an initial seed from the current time of day.
 554
 555 @item UNDEFINED
 556 Currently not used.
 557
 558 @item WORKSPACE
 559 The maximum amount of memory that PSPP will use to store data being processed.
 560 If memory in excess of the workspace size is required, then PSPP will start
 561 to use temporary files to store the data.
 562 Setting a higher value will, in general, mean procedures will run faster,
 563 but may cause other applications to run slower.
 564 On platforms without virtual memory management, setting a very large workspace
 565 may cause PSPP to abort.
 566 @cindex workspace
 567 @cindex memory, amount used to store cases
 568 @end table
 569
 570 Data output subcommands affect the format of output data.  These
 571 subcommands are
 572
 573 @table @asis
 574 @item CCA
 575 @itemx CCB
 576 @itemx CCC
 577 @itemx CCD
 578 @itemx CCE
 579 @anchor{CCx Settings}
 580
 581 Set up custom currency formats.  @xref{Custom Currency Formats}, for
 582 details.
 583
 584 @item DECIMAL
 585 The default DOT setting causes the decimal point character to be
 586 @samp{.}.  A setting of COMMA causes the decimal point character to be
 587 @samp{,}.
 588
 589 @item FORMAT
 590 Allows the default numeric input/output format to be specified.  The
 591 default is F8.2.  @xref{Input and Output Formats}.
 592
 593 @item WIB
 594 @anchor{SET WIB}
 595
 596 PSPP extension to set the byte ordering (endianness) used for writing
 597 data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric
 598 Formats}).  In MSBFIRST ordering, the most-significant byte appears at
 599 the left end of a IB or PIB field.  In LSBFIRST ordering, the
 600 least-significant byte appears at the left end.  VAX ordering is like
 601 MSBFIRST, except that each pair of bytes is in reverse order.  NATIVE,
 602 the default, is equivalent to MSBFIRST or LSBFIRST depending on the
 603 native format of the machine running PSPP.
 604
 605 @item WRB
 606 @anchor{SET WRB}
 607
 608 PSPP extension to set the floating-point format used for writing data in
 609 RB format (@pxref{Binary and Hexadecimal Numeric Formats}).  The choices
 610 are the same as SET RIB.  The default is NATIVE.
 611 @end table
 612
 613 Output routing subcommands affect where the output of transformations
 614 and procedures is sent.  These subcommands are
 615
 616 @table @asis
 617 @item ECHO
 618
 619 If turned on, commands are written to the listing file as they are read
 620 from command files.  The default is OFF.
 621
 622 @itemx ERRORS
 623 @itemx INCLUDE
 624 @itemx MESSAGES
 625 @item PRINTBACK
 626 @item RESULTS
 627 Currently not used.
 628 @end table
 629
 630 Output driver option subcommands affect output drivers' settings.  These
 631 subcommands are
 632
 633 @table @asis
 634 @item HEADERS
 635 @itemx LENGTH
 636 @itemx LISTING
 637 @itemx MORE
 638 @itemx PAGER
 639 @itemx WIDTH
 640 @end table
 641
 642 @cindex headers
 643 @cindex length
 644 @cindex listing
 645 @cindex more
 646 @cindex pager
 647 @cindex width
 648
 649
 650 Logging subcommands affect logging of commands executed to external
 651 files.  These subcommands are
 652
 653 @table @asis
 654 @item JOURNAL
 655 @itemx LOG
 656 These subcommands, which are synonyms, control the journal.  The
 657 default is ON, which causes commands entered interactively to be
 658 written to the journal file.  Commands included from syntax files that
 659 are included interactively and error messages printed by PSPP are also
 660 written to the journal file, prefixed by @samp{>}.  OFF disables use
 661 of the journal.
 662
 663 The journal is named @file{pspp.jnl} by default.  A different name may
 664 be specified.
 665 @end table
 666
 667 System file subcommands affect the default format of system files
 668 produced by PSPP.  These subcommands are
 669
 670 @table @asis
 671 @item COMPRESSION
 672 Not currently used.
 673
 674 @item SCOMPRESSION
 675 Whether system files created by @cmd{SAVE} or @cmd{XSAVE} are
 676 compressed by default.  The default is ON.
 677 @end table
 678
 679 Security subcommands affect the operations that commands are allowed to
 680 perform.  The security subcommands are
 681
 682 @table @asis
 683 @item SAFER
 684 Setting this option disables the following operations:
 685
 686 @itemize @bullet
 687 @item
 688 The ERASE command.
 689 @item
 690 The HOST command.
 691 @item
 692 The PERMISSIONS command.
 693 @item
 694 Pipes (file names beginning or ending with @samp{|}).
 695 @end itemize
 696
 697 Be aware that this setting does not guarantee safety (commands can still
 698 overwrite files, for instance) but it is an improvement.
 699 When set, this setting cannot be reset during the same session, for
 700 obvious security reasons.
 701 @end table
 702
 703 @node SHOW
 704 @comment  node-name,  next,  previous,  up
 705 @section SHOW
 706 @vindex SHOW
 707
 708 @display
 709 SHOW
 710         [ALL]
 711         [BLANKS]
 712         [CC]
 713         [CCA]
 714         [CCB]
 715         [CCC]
 716         [CCD]
 717         [CCE]
 718         [COPYING]
 719         [DECIMALS]
 720         [ENDCMD]
 721         [FORMAT]
 722         [LENGTH]
 723         [MXERRS]
 724         [MXLOOPS]
 725         [MXWARNS]
 726         [SCOMPRESSION]
 727         [UNDEFINED]
 728         [WARRANTY]
 729         [WEIGHT]
 730         [WIDTH]
 731 @end display
 732
 733 @cmd{SHOW} can be used to display the current state of PSPP's execution
 734 parameters.  Parameters that can be changed using @cmd{SET}
 735 (@pxref{SET}), can be examined using @cmd{SHOW} using the subcommand
 736 with the same name.  @code{SHOW} supports the following additional
 737 subcommands:
 738
 739 @table @code
 740 @item ALL
 741 Show all settings.
 742 @item CC
 743 Show all custom currency settings (CCA through CCE).
 744 @item WARRANTY
 745 Show details of the lack of warranty for PSPP.
 746 @item COPYING
 747 Display the terms of PSPP's copyright licence (@pxref{License}).
 748 @end table
 749
 750 Specifying @cmd{SHOW} without any subcommands is equivalent to SHOW ALL.
 751
 752 @node SUBTITLE
 753 @section SUBTITLE
 754 @vindex SUBTITLE
 755
 756 @display
 757 SUBTITLE 'subtitle_string'.
 758   or
 759 SUBTITLE subtitle_string.
 760 @end display
 761
 762 @cmd{SUBTITLE} provides a subtitle to a particular PSPP
 763 run.  This subtitle appears at the top of each output page below the
 764 title, if headers are enabled on the output device.
 765
 766 Specify a subtitle as a string in quotes.  The alternate syntax that did
 767 not require quotes is now obsolete.  If it is used then the subtitle is
 768 converted to all uppercase.
 769
 770 @node TITLE
 771 @section TITLE
 772 @vindex TITLE
 773
 774 @display
 775 TITLE 'title_string'.
 776   or
 777 TITLE title_string.
 778 @end display
 779
 780 @cmd{TITLE} provides a title to a particular PSPP run.
 781 This title appears at the top of each output page, if headers are enabled
 782 on the output device.
 783
 784 Specify a title as a string in quotes.  The alternate syntax that did
 785 not require quotes is now obsolete.  If it is used then the title is
 786 converted to all uppercase.
 787 @setfilename ignored