DEBUG EVALUATE: Eliminate lexical corner case, rewrite tests in Autotest.
[pspp] / 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         /MXERRS=max_errs
334         /MXWARNS=max_warnings
335         /PROMPT='prompt'
336         /WORKSPACE=workspace_size
337
338 (program execution)
339         /MEXPAND=@{ON,OFF@}
340         /MITERATE=max_iterations
341         /MNEST=max_nest
342         /MPRINT=@{ON,OFF@}
343         /MXLOOPS=max_loops
344         /SEED=@{RANDOM,seed_value@}
345         /UNDEFINED=@{WARN,NOWARN@}
346
347 (data output)
348         /CC@{A,B,C,D,E@}=@{'npre,pre,suf,nsuf','npre.pre.suf.nsuf'@}
349         /DECIMAL=@{DOT,COMMA@}
350         /FORMAT=fmt_spec
351         /WIB=@{NATIVE,MSBFIRST,LSBFIRST,VAX@}
352         /WRB=@{NATIVE,ISL,ISB,IDL,IDB,VF,VD,VG,ZS,ZL@}
353
354 (output routing)
355         /ERRORS=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
356         /MESSAGES=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
357         /PRINTBACK=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
358         /RESULTS=@{ON,OFF,TERMINAL,LISTING,BOTH,NONE@}
359
360 (output driver options)
361         /HEADERS=@{NO,YES,BLANK@}
362         /LENGTH=@{NONE,length_in_lines@}
363         /MORE=@{ON,OFF@}
364         /WIDTH=@{NARROW,WIDTH,n_characters@}
365
366 (logging)
367         /JOURNAL=@{ON,OFF@} ['file-name']
368
369 (system files)
370         /COMPRESSION=@{ON,OFF@}
371         /SCOMPRESSION=@{ON,OFF@}
372
373 (miscellaneous)
374         /SAFER=ON
375         /LOCALE='string'
376
377
378 (obsolete settings accepted for compatibility, but ignored)
379         /BOXSTRING=@{'xxx','xxxxxxxxxxx'@}
380         /CASE=@{UPPER,UPLOW@}
381         /CPI=cpi_value
382         /HIGHRES=@{ON,OFF@}
383         /HISTOGRAM='c'
384         /LOWRES=@{AUTO,ON,OFF@}
385         /LPI=lpi_value
386         /MENUS=@{STANDARD,EXTENDED@}
387         /MXMEMORY=max_memory
388         /SCRIPTTAB='c'
389         /TB1=@{'xxx','xxxxxxxxxxx'@}
390         /TBFONTS='string'
391         /XSORT=@{YES,NO@}
392 @end display
393
394 @cmd{SET} allows the user to adjust several parameters relating to
395 PSPP's execution.  Since there are many subcommands to this command, its
396 subcommands will be examined in groups.
397
398 On subcommands that take boolean values, ON and YES are synonym, and
399 as are OFF and NO, when used as subcommand values.
400
401 The data input subcommands affect the way that data is read from data
402 files.  The data input subcommands are
403
404 @table @asis
405 @item BLANKS
406 @anchor{SET BLANKS}
407 This is the value assigned to an item data item that is empty or
408 contains only white space.  An argument of SYSMIS or '.' will cause the
409 system-missing value to be assigned to null items.  This is the
410 default.  Any real value may be assigned.
411
412 @item DECIMAL
413 @anchor{SET DECIMAL}
414 This value may be set to DOT or COMMA.
415 Setting it to DOT causes the decimal point character to be
416 @samp{.} and the grouping character to be @samp{,}.
417 Setting it to COMMA
418 causes the decimal point character to be @samp{,} and the grouping
419 character to be @samp{.}.
420 The default value is determined from the system locale.
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 MXERRS
523 The maximum number of errors before PSPP halts processing of the current
524 command file.  The default is 50.
525
526 @item MXWARNS
527 The maximum number of warnings + errors before PSPP halts processing the
528 current command file.  The default is 100.
529
530 @item PROMPT
531 The command prompt.  The default is @samp{PSPP> }.
532 @end table
533
534 Program execution subcommands control the way that PSPP commands
535 execute.  The program execution subcommands are
536
537 @table @asis
538 @item MEXPAND
539 @itemx MITERATE
540 @itemx MNEST
541 @itemx MPRINT
542 Currently not used.
543
544 @item MXLOOPS
545 The maximum number of iterations for an uncontrolled loop (@pxref{LOOP}).
546
547 @item SEED
548 The initial pseudo-random number seed.  Set to a real number or to
549 RANDOM, which will obtain an initial seed from the current time of day.
550
551 @item UNDEFINED
552 Currently not used.
553
554 @item WORKSPACE
555 The maximum amount of memory that PSPP will use to store data being processed.
556 If memory in excess of the workspace size is required, then PSPP will start
557 to use temporary files to store the data.
558 Setting a higher value will, in general, mean procedures will run faster, 
559 but may cause other applications to run slower.
560 On platforms without virtual memory management, setting a very large workspace
561 may cause PSPP to abort.
562 @cindex workspace
563 @cindex memory, amount used to store cases
564 @end table
565
566 Data output subcommands affect the format of output data.  These
567 subcommands are
568
569 @table @asis
570 @item CCA
571 @itemx CCB
572 @itemx CCC
573 @itemx CCD
574 @itemx CCE
575 @anchor{CCx Settings}
576
577 Set up custom currency formats.  @xref{Custom Currency Formats}, for
578 details.
579
580 @item DECIMAL
581 The default DOT setting causes the decimal point character to be
582 @samp{.}.  A setting of COMMA causes the decimal point character to be
583 @samp{,}.
584
585 @item FORMAT
586 Allows the default numeric input/output format to be specified.  The
587 default is F8.2.  @xref{Input and Output Formats}.
588
589 @item WIB
590 @anchor{SET WIB} 
591
592 PSPP extension to set the byte ordering (endianness) used for writing
593 data in IB or PIB format (@pxref{Binary and Hexadecimal Numeric
594 Formats}).  In MSBFIRST ordering, the most-significant byte appears at
595 the left end of a IB or PIB field.  In LSBFIRST ordering, the
596 least-significant byte appears at the left end.  VAX ordering is like
597 MSBFIRST, except that each pair of bytes is in reverse order.  NATIVE,
598 the default, is equivalent to MSBFIRST or LSBFIRST depending on the
599 native format of the machine running PSPP.
600
601 @item WRB
602 @anchor{SET WRB}
603
604 PSPP extension to set the floating-point format used for writing data in
605 RB format (@pxref{Binary and Hexadecimal Numeric Formats}).  The choices
606 are the same as SET RIB.  The default is NATIVE.
607 @end table
608
609 In the PSPP text-based interface, the output routing subcommands
610 affect where output is sent.  The following values are allowed for
611 each of these subcommands:
612
613 @table @asis
614 @item OFF
615 @item NONE
616 Discard this kind of output.
617
618 @item TERMINAL
619 Write this output to the terminal, but not to listing files and other
620 output devices.
621
622 @item LISTING
623 Write this output to listing files and other output devices, but not
624 to the terminal.
625
626 @item ON
627 @itemx BOTH
628 Write this type of output to all output devices.
629 @end table
630
631 These output routing subcommands are:
632
633 @table @asis
634 @item ERRORS
635 Applies to error and warning messages.  The default is BOTH.
636
637 @itemx MESSAGES
638 Applies to notes.  The default is BOTH.
639
640 @itemx PRINTBACK
641 Determines whether the syntax used for input is printed back as part
642 of the output.  The default is NONE.
643
644 @itemx RESULTS
645 Applies to everything not in one of the above categories, such as the
646 results of statistical procedures.  The default is BOTH.
647 @end table
648
649 These subcommands have no effect on output in the PSPP GUI
650 environment.
651
652 Output driver option subcommands affect output drivers' settings.  These
653 subcommands are
654
655 @table @asis
656 @item HEADERS
657 @itemx LENGTH
658 @itemx MORE
659 @itemx PAGER 
660 @itemx WIDTH
661 @end table
662
663 @cindex headers
664 @cindex length
665 @cindex more
666 @cindex pager 
667 @cindex width
668
669
670 Logging subcommands affect logging of commands executed to external
671 files.  These subcommands are
672
673 @table @asis
674 @item JOURNAL
675 @itemx LOG
676 These subcommands, which are synonyms, control the journal.  The
677 default is ON, which causes commands entered interactively to be
678 written to the journal file.  Commands included from syntax files that
679 are included interactively and error messages printed by PSPP are also
680 written to the journal file, prefixed by @samp{>}.  OFF disables use
681 of the journal.
682
683 The journal is named @file{pspp.jnl} by default.  A different name may
684 be specified.
685 @end table
686
687 System file subcommands affect the default format of system files
688 produced by PSPP.  These subcommands are
689
690 @table @asis
691 @item COMPRESSION
692 Not currently used.
693
694 @item SCOMPRESSION
695 Whether system files created by @cmd{SAVE} or @cmd{XSAVE} are
696 compressed by default.  The default is ON.
697 @end table
698
699 Security subcommands affect the operations that commands are allowed to
700 perform.  The security subcommands are
701
702 @table @asis
703 @item SAFER
704 Setting this option disables the following operations:
705
706 @itemize @bullet
707 @item
708 The ERASE command.
709 @item
710 The HOST command.
711 @item
712 The PERMISSIONS command.
713 @item
714 Pipes (file names beginning or ending with @samp{|}).
715 @end itemize
716
717 Be aware that this setting does not guarantee safety (commands can still
718 overwrite files, for instance) but it is an improvement.
719 When set, this setting cannot be reset during the same session, for
720 obvious security reasons.
721
722 @item LOCALE
723 @cindex locale
724 @cindex encoding, characters
725 This item is used to set the default character encoding.
726 The encoding may be specified either as an encoding name or alias
727 (see @url{http://www.iana.org/assignments/character-sets}), or
728 as a locale name.
729 If given as a locale name, only the character encoding of the 
730 locale is relevant.
731
732 System files written by PSPP will use this encoding.
733 System files read by PSPP, for which the encoding is unknown, will be
734 interpreted using this encoding.
735
736 The full list of valid encodings and locale names/alias are operating system
737 dependent.
738 The following are all examples of acceptable syntax on common GNU/Linux
739 systems.
740 @example
741
742 SET LOCALE='iso-8859-1'.
743
744 SET LOCALE='ru_RU.cp1251'.
745
746 SET LOCALE='japanese'.
747
748 @end example
749
750 Contrary to the intuition, this command does not affect any aspect 
751 of the system's locale.
752 @end table
753
754 @node SHOW
755 @comment  node-name,  next,  previous,  up
756 @section SHOW
757 @vindex SHOW
758
759 @display
760 SHOW
761         [ALL]
762         [BLANKS]
763         [CC]
764         [CCA]
765         [CCB]
766         [CCC]
767         [CCD]
768         [CCE]
769         [COPYING]
770         [DECIMALS]
771         [ENDCMD]
772         [FORMAT]
773         [LENGTH]
774         [MXERRS]
775         [MXLOOPS]
776         [MXWARNS]
777         [SCOMPRESSION]
778         [UNDEFINED]
779         [WARRANTY]
780         [WEIGHT]
781         [WIDTH]
782 @end display
783
784 @cmd{SHOW} can be used to display the current state of PSPP's execution
785 parameters.  Parameters that can be changed using @cmd{SET}
786 (@pxref{SET}), can be examined using @cmd{SHOW} using the subcommand
787 with the same name.  @code{SHOW} supports the following additional
788 subcommands:
789
790 @table @code
791 @item ALL
792 Show all settings.
793 @item CC
794 Show all custom currency settings (CCA through CCE).
795 @item WARRANTY
796 Show details of the lack of warranty for PSPP.
797 @item COPYING
798 Display the terms of PSPP's copyright licence (@pxref{License}).
799 @end table
800
801 Specifying @cmd{SHOW} without any subcommands is equivalent to SHOW ALL.
802
803 @node SUBTITLE
804 @section SUBTITLE
805 @vindex SUBTITLE
806
807 @display
808 SUBTITLE 'subtitle_string'.
809   or
810 SUBTITLE subtitle_string.
811 @end display
812
813 @cmd{SUBTITLE} provides a subtitle to a particular PSPP
814 run.  This subtitle appears at the top of each output page below the
815 title, if headers are enabled on the output device.
816
817 Specify a subtitle as a string in quotes.  The alternate syntax that did
818 not require quotes is now obsolete.  If it is used then the subtitle is
819 converted to all uppercase.
820
821 @node TITLE
822 @section TITLE
823 @vindex TITLE
824
825 @display
826 TITLE 'title_string'.
827   or
828 TITLE title_string.
829 @end display
830
831 @cmd{TITLE} provides a title to a particular PSPP run.
832 This title appears at the top of each output page, if headers are enabled
833 on the output device.
834
835 Specify a title as a string in quotes.  The alternate syntax that did
836 not require quotes is now obsolete.  If it is used then the title is
837 converted to all uppercase.